GET
/
customers
/
{customer_id}
/
payment_methods
curl --request GET \
  --url https://sandbox.hyperswitch.io/customers/{customer_id}/payment_methods \
  --header 'api-key: <api-key>'
{
  "customer_payment_methods": [
    {
      "payment_token": "7ebf443f-a050-4067-84e5-e6f6d4800aef",
      "customer_id": "cus_meowerunwiuwiwqw",
      "payment_method": "card",
      "payment_method_type": "ach",
      "payment_method_issuer": "Citibank",
      "payment_method_issuer_code": "jp_hdfc",
      "recurring_enabled": true,
      "installment_payment_enabled": true,
      "payment_experience": [
        "redirect_to_url"
      ],
      "card": {
        "scheme": "<string>",
        "issuer_country": "<string>",
        "last4_digits": "<string>",
        "expiry_month": "<string>",
        "expiry_year": "<string>",
        "card_token": "<string>",
        "card_holder_name": "<string>",
        "card_fingerprint": "<string>",
        "nick_name": "<string>"
      },
      "metadata": {},
      "created": "2023-01-18T11:04:09.922Z",
      "bank_transfer": {
        "bank_name": "Deutsche Bank",
        "bank_country_code": "AF",
        "bank_city": "California",
        "bank_account_number": "000123456",
        "bank_routing_number": "110000000"
      },
      "bank": {
        "mask": "<string>"
      },
      "surcharge_details": {
        "surcharge": {
          "type": "fixed",
          "value": 123
        },
        "tax_on_surcharge": {
          "percentage": 123
        },
        "display_surcharge_amount": 123,
        "display_tax_on_surcharge_amount": 123,
        "display_total_surcharge_amount": 123,
        "display_final_amount": 123
      },
      "requires_cvv": true
    }
  ]
}

Authorizations

api-key
string
headerrequired

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Path Parameters

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,
ALL,
AMD,
ANG,
ARS,
AUD,
AWG,
AZN,
BBD,
BDT,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
GBP,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RUB,
RWF,
SAR,
SCR,
SEK,
SGD,
SLL,
SOS,
SSP,
SVC,
SZL,
THB,
TRY,
TTD,
TWD,
TZS,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
XAF,
XOF,
XPF,
YER,
ZAR

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