Payment Method Session - List Payment Methods

Retrieve the list of payment methods enabled for the business profile and the saved payment methods for the customer.

---

Request

GET https://sandbox.hyperswitch.io/v2/payment-method-sessions/{id}/list-payment-methods

cURL

cURL

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

Path parameters

• id (string, required) — The unique identifier for the Payment Method Session

Authorization (header)

• api-key (string, required) — Ephemeral keys provide temporary access to singular data, such as access to a single customer object for a short period of time.

---

Response

Status: 200 application/json The payment method session is retrieved successfully.

Example response

Response (200)

{
  "payment_methods_enabled": [
    {
      "card_networks": [
        {
          "eligible_connectors": [
            "stripe",
            "adyen"
          ],
          "card_network": "Visa",
          "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
            }
          }
        }
      ],
      "payment_method_type": "card",
      "payment_method_subtype": "ach",
      "required_fields": [
        {
          "required_field": "<string>",
          "display_name": "<string>",
          "field_type": "user_card_number",
          "value": "<string>"
        }
      ]
    }
  ],
  "customer_payment_methods": [
    {
      "payment_method_token": "7ebf443f-a050-4067-84e5-e6f6d4800aef",
      "customer_id": "12345_cus_01926c58bc6e77c09e809964e72af8c8",
      "payment_method_type": "card",
      "payment_method_subtype": "ach",
      "recurring_enabled": true,
      "created": "2023-01-18T11:04:09.922Z",
      "requires_cvv": true,
      "last_used_at": "2024-02-24T11:04:09.922Z",
      "is_default": 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>"
      },
      "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>"
      }
    }
  ]
}

---

Schema summary

• payment_methods_enabled (array of card or bank objects) — required The list of payment methods that are enabled for the business profile.

• customer_payment_methods (array of objects) — required The list of saved payment methods of the customer.

---

Attributes (details)

payment_methods_enabled (card · object | bank · object)[ ] — show child attributes

This entry lists enabled payment methods for the business profile. Example fields shown in the sample response:

• card_networks: array of objects

  • eligible_connectors: array of strings (e.g., "stripe", "adyen")

  • card_network: string (e.g., "Visa")

  • surcharge_details: object

    • surcharge: object

      • type: string ("fixed" | ...)

      • value: number

    • display_surcharge_amount: number

    • display_tax_on_surcharge_amount: number

    • display_total_surcharge_amount: number

    • tax_on_surcharge:

      • percentage: number

• payment_method_type: string (e.g., "card")

• payment_method_subtype: string (e.g., "ach")

• required_fields: array of objects

  • required_field: string

  • display_name: string

  • field_type: string (e.g., "user_card_number")

  • value: string

customer_payment_methods (object)[ ] — show child attributes

This entry lists saved payment methods for the customer. Example fields shown in the sample response:

• payment_method_token: string

• customer_id: string

• payment_method_type: string

• payment_method_subtype: string

• recurring_enabled: boolean

• created: string (timestamp)

• requires_cvv: boolean

• last_used_at: string (timestamp)

• is_default: boolean

• payment_method_data: object

  • card: object

    • saved_to_locker: boolean

    • issuer_country: string

    • last4_digits: string

    • expiry_month: string

    • expiry_year: string

    • card_holder_name: string

    • card_fingerprint: string

    • nick_name: string

    • card_network: string

    • card_isin: string

    • card_issuer: string

    • card_type: string

• bank: object

  • mask: string

• billing: object

  • address: object

    • city, country, line1, line2, line3, zip, state, first_name, last_name, origin_zip

  • phone: object

    • number: string

    • country_code: string

  • email: string

---

If you need to suggest edits or raise an issue for this endpoint, use the original repository links in the source documentation.