exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Card (exoapi_stripe v0.1.4)

description: You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.

Related guide: Card Payments with Sources.

:account :: ExOAPI.Stripe.Schemas.Account | :string

The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.

:address_city :: :string

City/District/Suburb/Town/Village.

:address_country :: :string

Billing address country, if provided when creating card.

:address_line1 :: :string

Address line 1 (Street address/PO Box/Company name).

:address_line1_check :: :string

If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.

:address_line2 :: :string

Address line 2 (Apartment/Suite/Unit/Building).

:address_state :: :string

State/County/Province/Region.

:address_zip :: :string

ZIP or postal code.

:address_zip_check :: :string

If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.

::available_payout_methods :: :string

:brand :: :string

Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.

:country :: :string

Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.

:currency :: :string

Three-letter ISO code for currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.

:customer :: ExOAPI.Stripe.Schemas.DeletedCustomer | ExOAPI.Stripe.Schemas.Customer | :string

The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.

:cvc_check :: :string

If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

:default_for_currency :: :boolean

Whether this card is the default external account for its currency.

:dynamic_last4 :: :string

(For tokenized numbers only.) The last four digits of the device account number.

:exp_month :: :integer

Two-digit number representing the card's expiration month.

:exp_year :: :integer

Four-digit number representing the card's expiration year.

:fingerprint :: :string

Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.

:funding :: :string

Card funding type. Can be credit, debit, prepaid, or unknown.

:id :: :string

Unique identifier for the object.

:last4 :: :string

The last four digits of the card.

:metadata :: :map

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

:name :: :string

Cardholder name.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:recipient :: ExOAPI.Stripe.Schemas.Recipient | :string

The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

:status :: :string

For external accounts, possible values are new and errored. If a transfer fails, the status is set to errored and transfers are stopped until account details are updated.

:tokenization_method :: :string

If the card number is tokenized, this is the method that was used. Can be android_pay (includes Google Pay), apple_pay, masterpass, visa_checkout, or null.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Card{
  account: ExOAPI.EctoTypes.AnyOf.t() | nil,
  address_city: String.t() | nil,
  address_country: String.t() | nil,
  address_line1: String.t() | nil,
  address_line1_check: String.t() | nil,
  address_line2: String.t() | nil,
  address_state: String.t() | nil,
  address_zip: String.t() | nil,
  address_zip_check: String.t() | nil,
  available_payout_methods: [String.t()] | nil,
  brand: String.t() | nil,
  country: String.t() | nil,
  currency: String.t() | nil,
  customer: ExOAPI.EctoTypes.AnyOf.t() | nil,
  cvc_check: String.t() | nil,
  default_for_currency: boolean() | nil,
  dynamic_last4: String.t() | nil,
  exp_month: integer() | nil,
  exp_year: integer() | nil,
  fingerprint: String.t() | nil,
  funding: String.t() | nil,
  id: String.t() | nil,
  last4: String.t() | nil,
  metadata: map() | nil,
  name: String.t() | nil,
  object: :card | nil,
  recipient: ExOAPI.EctoTypes.AnyOf.t() | nil,
  status: String.t() | nil,
  tokenization_method: String.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()