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
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_
was provided, results of the check:zip pass
,fail
,unavailable
, orunchecked
. - brandstring
Card brand. Can be
American Express
,Diners Club
,Discover
,Eftpos Australia
,Girocard
,JCB
,MasterCard
,UnionPay
,Visa
, orUnknown
. - 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
, orunchecked
. 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
, orunknown
. - last4string
The last four digits of the card.
- metadatanullable 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.
- namenullable string
Cardholder name.
More attributes
- objectstring
- accountnullable stringExpandableAvailable conditionally
- address_
line1_ checknullable string - available_
payout_ methodsnullable array of enums - currencynullable enumAvailable conditionally
- dynamic_
last4nullable string - tokenization_
methodnullable string - walletnullable MapPreview feature
{ "id": "card_1MvoiELkdIwHu7ixOeFGbN9D", "object": "card", "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "customer": "cus_NhD8HD2bY8dP3V", "cvc_check": null, "dynamic_last4": null, "exp_month": 4, "exp_year": 2024, "fingerprint": "mToisGZ01V71BCos", "funding": "credit", "last4": "4242", "metadata": {}, "name": null, "tokenization_method": null, "wallet": null}
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_
.
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.
- metadataMap
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
.
Returns
Returns the Card
object.
{ "id": "card_1NGTaT2eZvKYlo2CZWSctn5n", "object": "card", "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "customer": "cus_9s6XGDTHzA66Po", "cvc_check": "pass", "dynamic_last4": null, "exp_month": 8, "exp_year": 2024, "fingerprint": "Xt5EWLLDS7FJjR1c", "funding": "credit", "last4": "4242", "metadata": {}, "name": null, "redaction": null, "tokenization_method": null, "wallet": null}
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.
- metadataMap
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.
Returns
{ "id": "card_1NBLeN2eZvKYlo2CIq1o7Pzs", "object": "card", "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "cvc_check": "pass", "dynamic_last4": null, "exp_month": 8, "exp_year": 2024, "fingerprint": "Xt5EWLLDS7FJjR1c", "funding": "credit", "last4": "4242", "metadata": {}, "name": "Jenny Rosen", "redaction": null, "tokenization_method": null, "wallet": null, "account": "acct_1032D82eZvKYlo2C"}
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.
Returns
Returns the Card
object.
{ "id": "card_1MvoiELkdIwHu7ixOeFGbN9D", "object": "card", "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "customer": "cus_NhD8HD2bY8dP3V", "cvc_check": null, "dynamic_last4": null, "exp_month": 4, "exp_year": 2024, "fingerprint": "mToisGZ01V71BCos", "funding": "credit", "last4": "4242", "metadata": {}, "name": null, "tokenization_method": null, "wallet": null}