List customer saved payment methods for a Payment

Lists all the applicable payment methods for a particular payment tied to the client_secret.

Authorizations

api-key

string

header

required

Publishable keys are a type of keys that can be public and have limited scope of usage.

Path Parameters

client-secret

string

required

A secret known only to your client and the authorization server. Used for client side authentication

customer_id

string

required

The unique identifier for the customer account

accepted_currency

enum<string>[]

required

The three-letter ISO currency code

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWL

Query Parameters

accepted_country

string[]

required

The two-letter ISO currency code

minimum_amount

integer

required

The minimum amount accepted for processing by the particular payment method.

maximum_amount

integer

required

The maximum amount accepted for processing by the particular payment method.

recurring_payment_enabled

boolean

required

Indicates whether the payment method is eligible for recurring payments

installment_payment_enabled

boolean

required

Indicates whether the payment method is eligible for installment payments

Response

200 - application/json

customer_payment_methods

object[]

required

List of payment methods for customer

Show child attributes

customer_payment_methods.customer_id

string

required

The unique identifier of the customer.

Required string length: 1 - 64

customer_payment_methods.default_payment_method_set

boolean

required

Indicates if the payment method has been set to default or not

customer_payment_methods.installment_payment_enabled

boolean

required

Indicates whether the payment method is eligible for installment payments

customer_payment_methods.payment_method

enum<string>

required

Indicates the type of payment method. Eg: 'card', 'wallet', etc.

Available options:

card,

card_redirect,

pay_later,

wallet,

bank_redirect,

bank_transfer,

crypto,

bank_debit,

reward,

real_time_payment,

upi,

voucher,

gift_card,

open_banking,

mobile_payment

customer_payment_methods.payment_method_id

string

required

The unique identifier of the customer.

customer_payment_methods.payment_token

string

required

Token for payment method in temporary card locker which gets refreshed often

customer_payment_methods.recurring_enabled

boolean

required

Indicates whether the payment method is eligible for recurring payments

customer_payment_methods.requires_cvv

boolean

required

Whether this payment method requires CVV to be collected

customer_payment_methods.bank

object

Show child attributes

customer_payment_methods.bank.mask

string

required

customer_payment_methods.bank_transfer

object

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

customer_payment_methods.bank_transfer.bank_account_number

string

required

Bank account number is an unique identifier assigned by a bank to a customer.

customer_payment_methods.bank_transfer.bank_routing_number

string

required

[9 digits] Routing number - used in USA for identifying a specific bank.

customer_payment_methods.bank_transfer.bank_city

string | null

Bank city

customer_payment_methods.bank_transfer.bank_country_code

enum<string>

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

US

customer_payment_methods.bank_transfer.bank_name

string | null

Bank name

customer_payment_methods.billing

object

Show child attributes

customer_payment_methods.billing.address

object

Address details

Show child attributes

customer_payment_methods.billing.address.city

string | null

The address city

Maximum length: 50

customer_payment_methods.billing.address.country

enum<string>

Available options:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

US

customer_payment_methods.billing.address.first_name

string | null

The first name for the address

Maximum length: 255

customer_payment_methods.billing.address.last_name

string | null

The last name for the address

Maximum length: 255

customer_payment_methods.billing.address.line1

string | null

The first line of the address

Maximum length: 200

customer_payment_methods.billing.address.line2

string | null

The second line of the address

Maximum length: 50

customer_payment_methods.billing.address.line3

string | null

The third line of the address

Maximum length: 50

customer_payment_methods.billing.address.state

string | null

The address state

customer_payment_methods.billing.address.zip

string | null

The zip/postal code for the address

Maximum length: 50

customer_payment_methods.billing.email

string | null

customer_payment_methods.billing.phone

object

Show child attributes

customer_payment_methods.billing.phone.country_code

string | null

The country code attached to the number

customer_payment_methods.billing.phone.number

string | null

The contact number

customer_payment_methods.card

object

Show child attributes

customer_payment_methods.card.saved_to_locker

boolean

required

customer_payment_methods.card.card_fingerprint

string | null

customer_payment_methods.card.card_holder_name

string | null

customer_payment_methods.card.card_isin

string | null

customer_payment_methods.card.card_issuer

string | null

customer_payment_methods.card.card_network

enum<string>

Indicates the card network.

Available options:

Visa,

Mastercard,

AmericanExpress,

JCB,

DinersClub,

Discover,

CartesBancaires,

UnionPay,

Interac,

RuPay,

Maestro

customer_payment_methods.card.card_token

string | null

customer_payment_methods.card.card_type

string | null

customer_payment_methods.card.expiry_month

string | null

customer_payment_methods.card.expiry_year

string | null

customer_payment_methods.card.issuer_country

string | null

customer_payment_methods.card.last4_digits

string | null

customer_payment_methods.card.nick_name

string | null

customer_payment_methods.card.scheme

string | null

customer_payment_methods.created

string | null

A timestamp (ISO 8601 code) that determines when the payment method was created

customer_payment_methods.last_used_at

string | null

A timestamp (ISO 8601 code) that determines when the payment method was last used

customer_payment_methods.metadata

object | null

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

customer_payment_methods.payment_experience

enum<string>[] | null

Type of payment experience enabled with the connector

Available options:

redirect_to_url,

invoke_sdk_client,

display_qr_code,

one_click,

link_wallet,

invoke_payment_app,

display_wait_screen,

collect_otp

customer_payment_methods.payment_method_issuer

string | null

The name of the bank/ provider issuing the payment method to the end user

customer_payment_methods.payment_method_issuer_code

enum<string>

Available options:

jp_hdfc,

jp_icici,

jp_googlepay,

jp_applepay,

jp_phonepay,

jp_wechat,

jp_sofort,

jp_giropay,

jp_sepa,

jp_bacs

customer_payment_methods.payment_method_type

enum<string>

Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

Available options:

ach,

affirm,

afterpay_clearpay,

alfamart,

ali_pay,

ali_pay_hk,

alma,

apple_pay,

atome,

bacs,

bancontact_card,

becs,

benefit,

bizum,

blik,

boleto,

bca_bank_transfer,

bni_va,

bri_va,

card_redirect,

cimb_va,

classic,

credit,

crypto_currency,

cashapp,

dana,

danamon_va,

debit,

duit_now,

efecty,

eps,

fps,

evoucher,

giropay,

givex,

google_pay,

go_pay,

gcash,

ideal,

interac,

indomaret,

klarna,

kakao_pay,

local_bank_redirect,

mandiri_va,

knet,

mb_way,

mobile_pay,

momo,

momo_atm,

multibanco,

online_banking_thailand,

online_banking_czech_republic,

online_banking_finland,

online_banking_fpx,

online_banking_poland,

online_banking_slovakia,

oxxo,

pago_efectivo,

permata_bank_transfer,

open_banking_uk,

pay_bright,

paypal,

paze,

pix,

pay_safe_card,

przelewy24,

prompt_pay,

pse,

red_compra,

red_pagos,

samsung_pay,

sepa,

sofort,

swish,

touch_n_go,

trustly,

twint,

upi_collect,

upi_intent,

vipps,

viet_qr,

venmo,

walley,

we_chat_pay,

seven_eleven,

lawson,

mini_stop,

family_mart,

seicomart,

pay_easy,

local_bank_transfer,

mifinity,

open_banking_pis,

direct_carrier_billing

customer_payment_methods.surcharge_details

object

Show child attributes

customer_payment_methods.surcharge_details.display_surcharge_amount

number

required

surcharge amount for this payment

customer_payment_methods.surcharge_details.display_tax_on_surcharge_amount

number

required

tax on surcharge amount for this payment

customer_payment_methods.surcharge_details.display_total_surcharge_amount

number

required

sum of display_surcharge_amount and display_tax_on_surcharge_amount

customer_payment_methods.surcharge_details.surcharge

object

required

• Option 1
• Option 2

Show child attributes

customer_payment_methods.surcharge_details.surcharge.type

enum<string>

required

Available options:

fixed

customer_payment_methods.surcharge_details.surcharge.value

integer

required

This Unit struct represents MinorUnit in which core amount works

customer_payment_methods.surcharge_details.tax_on_surcharge

object

Show child attributes

customer_payment_methods.surcharge_details.tax_on_surcharge.percentage

number

required

is_guest_customer

boolean | null

Returns whether a customer id is not tied to a payment intent (only when the request is made against a client secret)