Skip to main content
GET
/
v1
/
customers
/
{id}
/
saved-payment-methods
Payment Method - List Customer Saved Payment Methods
curl --request GET \
  --url https://sandbox.hyperswitch.io/v1/customers/{id}/saved-payment-methods \
  --header 'Authorization: <api-key>' \
  --header 'X-Profile-Id: <x-profile-id>'
{
  "customer_payment_methods": [
    {
      "id": "12345_pm_01926c58bc6e77c09e809964e72af8c8",
      "customer_id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
      "payment_method_type": "card",
      "payment_method_subtype": "ach",
      "created": "2023-01-18T11:04:09.922Z",
      "requires_cvv": true,
      "is_default": true,
      "psp_tokenization_enabled": true,
      "recurring_enabled": true,
      "payment_method_data": {
        "card": {
          "saved_to_locker": true,
          "issuer_country": "AF",
          "last4_digits": "4242",
          "expiry_month": "10",
          "expiry_year": "25",
          "card_holder_name": "John Doe",
          "card_fingerprint": "fingerprint_12345",
          "nick_name": "Card",
          "card_network": "Visa",
          "card_isin": "4567890",
          "card_issuer": "Issuer Bank",
          "card_type": "Credit"
        }
      },
      "bank": {
        "mask": "<string>"
      },
      "last_used_at": "2024-02-24T11:04:09.922Z",
      "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",
          "origin_zip": "08807"
        },
        "phone": {
          "number": "9123456789",
          "country_code": "+1"
        },
        "email": "<string>"
      },
      "network_tokenization": {
        "payment_method_data": {
          "last4_digits": "4242",
          "issuer_country": "AF",
          "network_token_expiry_month": "05",
          "network_token_expiry_year": "27",
          "nick_name": "Card",
          "card_holder_name": "John Doe",
          "card_isin": "16712672",
          "card_issuer": "Bank of America",
          "card_network": "Visa",
          "card_type": "Credit",
          "saved_to_locker": true,
          "par": "522134KAVJ1JPZ8L77N0Z2LRYZS7J"
        }
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://api-reference.hyperswitch.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Format: api-key=<api_key>

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.

Headers

​
X-Profile-Id
string
required

Profile ID associated to the payment method

Path Parameters

​
id
string
required

The unique identifier for the customer

Response

Payment Methods Retrieved

​
customer_payment_methods
object[]
required

List of payment methods for customer