get/v1/customers/{customer}/cards

List all cards

You can see a list of the cards belonging to a customer. Note that the 10 most recent sources are always available on the Customer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.

Path parameters

Name	Description
customer*

Query parameters

Name	Description
ending_before	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
expand	Specifies which fields in the response should be expanded.
limit	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.

Request body

object (no properties in spec)

Response

Field Type Description

data*

array<card>

array item fields

Field Type Description

account string | account

address_city

string

City/District/Suburb/Town/Village.

address_country

string

Billing address country, if provided when creating card.

address_line1

string

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

address_line1_check

string

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

address_line2

string

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

address_state

string

State/County/Province/Region.

address_zip

string

ZIP or postal code.

address_zip_check

string

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

allow_redisplay

string

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_methods

array<string>

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

brand*

string

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

country

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.

currency

string (currency)

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.

customer

string | customer | deleted_customer

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_check

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_currency

boolean

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_last4

string

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

exp_month*

integer

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

exp_year*

integer

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

fingerprint

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

funding*

string

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

id*

string

Unique identifier for the object.

iin

string

Issuer identification number of the card.

last4*

string

The last four digits of the card.

metadata

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.

name

string

Cardholder name.

networks

token_card_networks

1 nested field

Field	Type	Description
preferred	string	The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.

object*

string

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

regulated_status

string

Status of a card based on the card issuer.

has_more*

boolean

True if this list has another page of items after this one that can be fetched.

object*

string

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

url*

string

The URL where this list can be accessed.