Retrieve a card

Changed on

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.

get/v1/customers/{customer}/cards/{id}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/customers/{customer}/cards/{id}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

customerstring required
idstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

address_citystring nullable

City/District/Suburb/Town/Village.

address_countrystring nullable

Billing address country, if provided when creating card.

address_line1string nullable

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

address_line1_checkstring nullable

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

address_line2string nullable

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

address_statestring nullable

State/County/Province/Region.

address_zipstring nullable

ZIP or postal code.

address_zip_checkstring nullable

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

allow_redisplay'always' | 'limited' | 'unspecified' nullable

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

available_payout_methodsstring[] nullable

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

brandstring required

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

countrystring nullable

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.

currencystring currency nullable

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 when returned as an External Account where controller.is_controller is true.

cvc_checkstring nullable

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_currencyboolean nullable

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.

dynamic_last4string nullable

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

exp_monthinteger required

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

exp_yearinteger required

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

fingerprintstring nullable

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 required

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

idstring required

Unique identifier for the object.

last4string required

The last four digits of the card.

metadataobject nullable

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.

namestring nullable

Cardholder name.

object'card' required

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

regulated_status'regulated' | 'unregulated' nullable

Status of a card based on the card issuer.

statusstring nullable

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.

tokenization_methodstring nullable

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.

Changes

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.