The External Account Card object 

Attributes

• idstring

  Unique identifier for the object.

• accountnullable stringExpandableAvailable conditionally

  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. This property is only available for accounts where controller.is_controller is true.

• address_citynullable string

  City/District/Suburb/Town/Village.

• address_countrynullable string

  Billing address country, if provided when creating card.

• address_line1nullable string

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

• address_line2nullable string

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

• address_statenullable string

  State/County/Province/Region.

• address_zipnullable string

  ZIP or postal code.

• address_zip_checknullable string

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

• brandstring

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

• countrynullable 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.

• currencynullable enumAvailable conditionally

  Three-letter ISO code for currency in lowercase. Must be a supported currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where controller.is_controller is true.

• cvc_checknullable 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_currencynullable booleanAvailable conditionally

  Whether this card is the default external account for its currency. This property is only available for accounts where controller.requirement_collection is application, which includes Custom accounts.

• exp_monthinteger

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

• exp_yearinteger

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

• fingerprintnullable 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.

  As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

• fundingstring

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

• last4string

  The last four digits of the card.

• metadatanullable object

  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.

• namenullable string

  Cardholder name.

• statusnullable string

  For external accounts that are cards, possible values are new and errored. If a payout fails, the status is set to errored and scheduled payouts are stopped until account details are updated.

More attributes

Collapse all

• objectstring

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

• address_line1_checknullable string

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

• allow_redisplaynullable enum

  This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.

  Possible enum values

  always Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

  limited Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

  unspecified This is the default value for payment methods where allow_redisplay wasn’t set.

• available_payout_methodsnullable array of enums

  A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout.

  Possible enum values

  instant

  standard

• customernullable stringExpandable

  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.

• dynamic_last4nullable string

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

• iinnullable string

  Issuer identification number of the card.

• regulated_statusnullable enum

  Status of a card based on the card issuer.

  Possible enum values

  regulated The card falls under a regulated account range.

  unregulated The card does not fall under a regulated account range.

• tokenization_methodnullable 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.

• walletnullable objectPreview feature

  If this Card is part of a card wallet, this contains the details of the card wallet.

  Hide child attributes

  • wallet.apple_paynullable object

    If this is a apple_pay card wallet, this hash contains details about the wallet.

  • wallet.typeenum

    The type of the card wallet, one of apple_pay or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.

    Possible enum values

    apple_pay

    link