Attributes

• idstring

  Unique identifier for the object.

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

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

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

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

More attributes

Expand all

• objectstring

• accountnullable stringExpandableAvailable conditionally

• address_line1_checknullable string

• available_payout_methodsnullable array of enums

• currencynullable enumAvailable conditionally

• dynamic_last4nullable string

• tokenization_methodnullable string

• walletnullable objectPreview feature

When you create a new credit card, you must specify a customer or recipient on which to create it.

If the card’s owner has no default 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 update the customer to have a new default_source.

Parameters

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

Updates a specified card for a given customer.

Parameters

• address_citystring

  City/District/Suburb/Town/Village.

• address_countrystring

  Billing address country, if provided when creating card.

• address_line1string

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

• address_line2string

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

• address_statestring

  State/County/Province/Region.

• address_zipstring

  ZIP or postal code.

• exp_monthstring

  Two digit number representing the card’s expiration month.

• exp_yearstring

  Four digit number representing the card’s expiration year.

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

• namestring

  Cardholder name.

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

Parameters

No parameters.