Skip to main content
GET
/
v1
/
payment-method-sessions
/
{id}
/
list-payment-methods
Payment Method Session - List Payment Methods
curl --request GET \
  --url https://sandbox.hyperswitch.io/v1/payment-method-sessions/{id}/list-payment-methods \
  --header 'Authorization: <api-key>' \
  --header 'X-Profile-Id: <x-profile-id>'
{
  "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>"
      }
    }
  ]
}

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: publishable-key=<publishable-key>,client-secret=<client-secret>

Publishable keys are a type of keys that can be public and have limited scope of usage. Client Secret provide temporary access to singular data, such as access to a single customer object for a short period of time. This authentication scheme is used by the SDK.

Headers

​
X-Profile-Id
string
required

Profile ID associated to the payment method session

Path Parameters

​
id
string
required

The unique identifier for the Payment Method Session

Response

The payment method session is retrieved successfully

​
payment_methods_enabled
(card · object | bank · object)[]
required

The list of payment methods that are enabled for the business profile

​
customer_payment_methods
object[]
required

The list of saved payment methods of the customer