GET
/
customers
/
payment_methods
curl --request GET \
  --url https://sandbox.hyperswitch.io/customers/payment_methods \
  --header 'api-key: <api-key>'
{
  "customer_payment_methods": [
    {
      "payment_token": "7ebf443f-a050-4067-84e5-e6f6d4800aef",
      "payment_method_id": "pm_iouuy468iyuowqs",
      "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
      "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>",
        "card_network": "Visa",
        "card_isin": "<string>",
        "card_issuer": "<string>",
        "card_type": "<string>",
        "saved_to_locker": true
      },
      "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
      },
      "requires_cvv": true,
      "last_used_at": "2024-02-24T11:04:09.922Z",
      "default_payment_method_set": true,
      "billing": {
        "address": {
          "city": "New York",
          "country": "AF",
          "line1": "123, King Street",
          "line2": "Powelson Avenue",
          "line3": "Bridgewater",
          "zip": "08807",
          "state": "New York",
          "first_name": "John",
          "last_name": "Doe"
        },
        "phone": {
          "number": "9123456789",
          "country_code": "+1"
        },
        "email": "<string>"
      }
    }
  ],
  "is_guest_customer": true
}

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

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

Payment Methods retrieved for customer tied to its respective client-secret passed in the param

The response is of type object.