Sample - Stripe API
POST/v1/customers/{customer}/cards/{id}

Update a customer's card

Updates a card or other payment source stored on a customer. Send only the payment-source fields you want to change, such as billing address, expiration details, cardholder information, or metadata. The response contains the updated payment source, which may be a card, bank account, or other source type.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 14 body fields
customerstringrequired
The unique identifier of the customer that owns the payment source. The value must be no more than 5,000 characters.
idstringrequired
The unique identifier of the card or payment source to update. The value must be no more than 5,000 characters.

Optional form parameters containing the payment-source fields to update.

account_holder_namestringoptional
The name of the person or business that owns the bank account.
account_holder_typestringoptional
The type of entity that holds the account. This can be either `individual` or `company`.
Allowed:companyindividual
address_citystringoptional
City/District/Suburb/Town/Village.
address_countrystringoptional
Billing address country, if provided when creating card.
address_line1stringoptional
Address line 1 (Street address/PO Box/Company name).
address_line2stringoptional
Address line 2 (Apartment/Suite/Unit/Building).
address_statestringoptional
State/County/Province/Region.
address_zipstringoptional
ZIP or postal code.
exp_monthstringoptional
Two digit number representing the card’s expiration month.
exp_yearstringoptional
Four digit number representing the card’s expiration year.
expandarray<string>optional
Specifies which fields in the response should be expanded.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
namestringoptional
Cardholder name.
ownerobjectoptional
The payment source owner's address, name, email, and phone information.

2 status codes
200Returns the updated payment source, which may be a card, bank account, or other supported source object.
accountstringoptional
address_citystringoptional
City/District/Suburb/Town/Village.
address_countrystringoptional
Billing address country, if provided when creating card.
address_line1stringoptional
Address line 1 (Street address/PO Box/Company name).
address_line1_checkstringoptional
If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
address_line2stringoptional
Address line 2 (Apartment/Suite/Unit/Building).
address_statestringoptional
State/County/Province/Region.
address_zipstringoptional
ZIP or postal code.
address_zip_checkstringoptional
If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
allow_redisplaystringoptional
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”.
Allowed:alwayslimitedunspecified
available_payout_methodsarray<string>optional
A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.
brandstringrequired
Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
countrystringoptional
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.
currencystringoptional
Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). 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 when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.
customerstringoptional
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_checkstringoptional
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](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).
default_for_currencybooleanoptional
Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
dynamic_last4stringoptional
(For tokenized numbers only.) The last four digits of the device account number.
exp_monthintegerrequired
Two-digit number representing the card's expiration month.
exp_yearintegerrequired
Four-digit number representing the card's expiration year.
fingerprintstringoptional
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.*
fundingstringrequired
Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
idstringrequired
Unique identifier for the object.
last4stringrequired
The last four digits of the card.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
namestringoptional
Cardholder name.
networksobjectoptional
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:card
regulated_statusstringoptional
Status of a card based on the card issuer.
Allowed:regulatedunregulated
statusstringoptional
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](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.
tokenization_methodstringoptional
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.
defaultError response.
errorobjectrequired

Error handling

customer and id must each be no more than 5,000 characters and must identify the customer and payment source to update. account_holder_type must be company or individual, and metadata must be a key-value object or an empty value when supplied.