GET
/
account
/
payment_methods
List payment methods for a Merchant
curl --request GET \
  --url https://sandbox.hyperswitch.io/account/payment_methods \
  --header 'api-key: <api-key>'
{
  "redirect_url": "https://www.google.com",
  "currency": "AED",
  "payment_methods": [
    {
      "payment_method": "card",
      "payment_method_types": [
        {
          "payment_method_type": "ach",
          "payment_experience": [
            {
              "payment_experience_type": "redirect_to_url",
              "eligible_connectors": [
                "stripe",
                "adyen"
              ]
            }
          ],
          "card_networks": [
            {
              "card_network": "Visa",
              "surcharge_details": {
                "surcharge": {
                  "type": "fixed",
                  "value": 123
                },
                "tax_on_surcharge": {
                  "percentage": 123
                },
                "display_surcharge_amount": 123,
                "display_tax_on_surcharge_amount": 123,
                "display_total_surcharge_amount": 123
              },
              "eligible_connectors": [
                "stripe",
                "adyen"
              ]
            }
          ],
          "bank_names": [
            {
              "bank_name": [
                "american_express"
              ],
              "eligible_connectors": [
                "<string>"
              ]
            }
          ],
          "bank_debits": {
            "eligible_connectors": [
              "<string>"
            ]
          },
          "bank_transfers": {
            "eligible_connectors": [
              "stripe",
              "adyen"
            ]
          },
          "required_fields": {},
          "surcharge_details": {
            "surcharge": {
              "type": "fixed",
              "value": 123
            },
            "tax_on_surcharge": {
              "percentage": 123
            },
            "display_surcharge_amount": 123,
            "display_tax_on_surcharge_amount": 123,
            "display_total_surcharge_amount": 123
          },
          "pm_auth_connector": "<string>"
        }
      ]
    }
  ],
  "mandate_payment": {
    "single_use": {
      "amount": 6540,
      "currency": "AED",
      "start_date": "2022-09-10T00:00:00Z",
      "end_date": "2023-09-10T23:59:59Z",
      "metadata": {}
    }
  },
  "merchant_name": "<string>",
  "show_surcharge_breakup_screen": true,
  "payment_type": "normal",
  "request_external_three_ds_authentication": true,
  "collect_shipping_details_from_wallets": true,
  "collect_billing_details_from_wallets": true,
  "is_tax_calculation_enabled": true
}

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.

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<string>[] | null

The two-letter ISO currency code

​
accepted_currencies
enum<string>[] | null

The three-letter ISO currency code

​
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<string>[] | null

Indicates whether the payment method is eligible for card netwotks

Response

200
application/json

Payment Methods retrieved

The response is of type object.