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.requirement_collection is application, which includes Custom accounts.

• 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.requirement_collection is application, which includes Custom accounts.

• 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

Expand all

• objectstring

• address_line1_checknullable string

• available_payout_methodsnullable array of enums

• customernullable stringExpandable

• dynamic_last4nullable string

• tokenization_methodnullable string

• walletnullable objectPreview feature

When you create a new debit card, you must specify a connected account to create it on. You can only specify connected accounts where account.controller.requirement_collection is application (includes Custom accounts).

If the account has no default destination card, then the new card will become the default. However, if the owner already has a default then it will not change. To change the default, you should set default_for_currency to true.

Parameters

• external_accountobject | stringRequired

  A token, like the ones returned by Stripe.js or a dictionary containing a user’s card details (with the options shown below). Stripe will automatically validate the card.

  Show child parameters

• metadataobject

  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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

Expand all

• default_for_currencyboolean

If you need to update only some card details, like the billing address or expiration date, you can do so without having to re-enter the full card details. Stripe also works directly with card networks so that your customers can continue using your service without interruption.

Parameters

• default_for_currencyboolean

  When set to true, this becomes the default external account for its currency.

• metadataobject

  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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

More parameters

Expand all

• address_citystring

• address_countrystring

• address_line1string

• address_line2string

• address_statestring

• address_zipstring

• exp_monthstring

• exp_yearstring

• namestring

By default, you can see the 10 most recent external accounts stored on a connected account directly on the object. You can also retrieve details about a specific card stored on the account.

Parameters

No parameters.