List customer saved payment methods for a Payment

GET /customers/payment_methods

Description: Retrieve saved payment methods for a customer tied to the client secret (when provided).

cURL
curl --request GET \
  --url https://sandbox.hyperswitch.io/customers/payment_methods \
  --header 'api-key: <api-key>'

Response (200 application/json)

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

Example response
{
  "customer_payment_methods": [
    {
      "payment_token": "7ebf443f-a050-4067-84e5-e6f6d4800aef",
      "payment_method_id": "pm_iouuy468iyuowqs",
      "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
      "payment_method": "card",
      "requires_cvv": true,
      "default_payment_method_set": true,
      "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": {
        "saved_to_locker": true,
        "scheme": "<string>",
        "issuer_country": "<string>",
        "issuer_country_code": "<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>"
      },
      "metadata": {},
      "created": "2023-01-18T11:04:09.922Z",
      "bank_transfer": {
        "bank_account_number": "000123456",
        "bank_routing_number": "110000000",
        "bank_name": "Deutsche Bank",
        "bank_country_code": "AF",
        "bank_city": "California"
      },
      "bank": {
        "mask": "<string>"
      },
      "surcharge_details": {
        "surcharge": {
          "type": "fixed",
          "value": 123
        },
        "display_surcharge_amount": 123,
        "display_tax_on_surcharge_amount": 123,
        "display_total_surcharge_amount": 123,
        "tax_on_surcharge": {
          "percentage": 123
        }
      },
      "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>"
      }
    }
  ],
  "is_guest_customer": true
}

Authorizations

  • api-key (string, header, required) Note: Publishable keys are a type of keys that can be public and have limited scope of usage.

Query Parameters

  • client_secret — string | null This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK.

  • accepted_countries — enum[] | null The two-letter ISO country code.

  • accepted_currencies — enum[] | null The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount.

  • amount — integer | null The amount accepted for processing by the particular payment method.

  • recurring_enabled — boolean | null Indicates whether the payment method is eligible for recurring payments.

  • installment_payment_enabled — boolean | null Indicates whether the payment method is eligible for installment payments.

  • limit — integer | null Indicates the limit of last used payment methods.

  • card_networks — enum[] | null Indicates the eligible card networks.

    Available options: Visa, Mastercard, AmericanExpress, JCB, DinersClub, Discover, CartesBancaires, UnionPay, Interac, RuPay, Maestro, Star, Pulse, Accel, Nyce

Response schema (high-level)

  • customer_payment_methods — object[] (required) List of payment methods for customer (see example response for child attributes).

  • 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).

If you want, I can convert the Query Parameters and Response schema sections into a table for easier scanning.

PreviousSubscription - UpdateNextPayments - Session token