get/v1/customers/{customer}/payment_methods

List a Customer's PaymentMethods

Returns a list of PaymentMethods for a given Customer

Path parameters

Name	Description
customer*

Query parameters

Name	Description
allow_redisplay	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.
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.
type	An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.

Request body

object (no properties in spec)

Response

Field Type Description

data*

array<payment_method>

array item fields

Field Type Description

acss_debit

payment_method_acss_debit

5 nested fields

Field	Type	Description
bank_name	string	Name of the bank associated with the bank account.
fingerprint	string	Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
institution_number	string	Institution number of the bank account.
last4	string	Last four digits of the bank account number.
transit_number	string	Transit number of the bank account.

affirm payment_method_affirm

afterpay_clearpay payment_method_afterpay_clearpay

alipay payment_flows_private_payment_methods_alipay

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

alma payment_method_alma

amazon_pay payment_method_amazon_pay

au_becs_debit

payment_method_au_becs_debit

3 nested fields

Field	Type	Description
bsb_number	string	Six-digit number identifying bank and branch associated with this bank account.
fingerprint	string	Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
last4	string	Last four digits of the bank account number.

bacs_debit

payment_method_bacs_debit

3 nested fields

Field	Type	Description
fingerprint	string	Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
last4	string	Last four digits of the bank account number.
sort_code	string	Sort code of the bank account. (e.g., `10-20-30`)

bancontact payment_method_bancontact

billie payment_method_billie

billing_details*

billing_details

5 nested fields

Field	Type	Description
address	address	Billing address.
email	string	Email address.
name	string	Full name.
phone	string	Billing phone number (including extension).
tax_id	string	Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.

bizum

payment_method_bizum

1 nested field

Field	Type	Description
buyer_id	string	A unique identifier for the buyer as determined by the local payment processor.

blik

payment_method_blik

1 nested field

Field	Type	Description
buyer_id	string	A unique and immutable identifier assigned by BLIK to every buyer.

boleto

payment_method_boleto

1 nested field

Field	Type	Description
tax_id*	string	Uniquely identifies the customer tax id (CNPJ or CPF)

card

payment_method_card

14 nested fields

Field	Type	Description
brand*	string	Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
checks	payment_method_card_checks	Checks on Card address and CVC if provided.
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.
display_brand	string	The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future.
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`.
generated_from	payment_method_card_generated_card	Details of the original PaymentMethod that created this object.
last4*	string	The last four digits of the card.
networks	networks	Contains information about card networks that can be used to process the payment.
regulated_status	string	Status of a card based on the card issuer.
three_d_secure_usage	three_d_secure_usage	Contains details on how this Card may be used for 3D Secure authentication.
wallet	payment_method_card_wallet	If this Card is part of a card wallet, this contains the details of the card wallet.

card_present

payment_method_card_present

16 nested fields

Field	Type	Description
brand	string	Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
brand_product	string	The product code that identifies the specific program or product associated with a card.
cardholder_name	string	The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
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.
description	string	A high-level description of the type of cards issued in this range.
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`.
issuer	string	The name of the card's issuing bank.
last4	string	The last four digits of the card.
networks	payment_method_card_present_networks	Contains information about card networks that can be used to process the payment.
offline	payment_method_details_card_present_offline	Details about payment methods collected offline.
preferred_locales	array<string>	The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip.
read_method	string	How card details were read in this transaction.
wallet	payment_flows_private_payment_methods_card_present_common_wallet

cashapp

payment_method_cashapp

2 nested fields

Field	Type	Description
buyer_id	string	A unique and immutable identifier assigned by Cash App to every buyer.
cashtag	string	A public identifier for buyers using Cash App.

created*

integer (unix-time)

Time at which the object was created. Measured in seconds since the Unix epoch.

crypto payment_method_crypto

custom

payment_method_custom

3 nested fields

Field	Type	Description
display_name	string	Display name of the Dashboard-only CustomPaymentMethodType.
logo	custom_logo	Contains information about the Dashboard-only CustomPaymentMethodType logo.
type*	string	ID of the Dashboard-only CustomPaymentMethodType. Not expandable.

customer

string | customer

The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.

customer_account string

customer_balance payment_method_customer_balance

eps

payment_method_eps

1 nested field

Field	Type	Description
bank	string	The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.

fpx

payment_method_fpx

1 nested field

Field	Type	Description
bank*	string	The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.

giropay payment_method_giropay

grabpay payment_method_grabpay

id*

string

Unique identifier for the object.

ideal

payment_method_ideal

2 nested fields

Field	Type	Description
bank	string	The customer's bank, if provided. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
bic	string	The Bank Identifier Code of the customer's bank, if the bank was provided.

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.