Payment Method - List Customer Saved Payment Methods

Retrieve the list of saved payment methods for a customer.

curl example

cURL

curl --request GET \
  --url https://sandbox.hyperswitch.io/v2/customers/{id}/saved-payment-methods \
  --header 'api-key: <api-key>'

Request

GET /v2/customers/{id}/saved-payment-methods

Authorizations

• api-key (string, header) — required 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

Name	Type	Required	Description
id	string	required	The unique identifier for the customer

Response

200 — application/json — Payment Methods Retrieved

Response body example:

200 JSON

{
  "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
        }
      }
    }
  ]
}

Schema (summary)

• customer_payment_methods (object[]) — required List of payment methods for the customer.

Links

• Documentation: https://api-reference.hyperswitch.io/introduction

• Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

• Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

• Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v2/payment-methods/payment-method--list-customer-saved-payment-methods.mdx

• Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v2/payment-methods/payment-method--list-customer-saved-payment-methods

(Original API examples and links preserved.)