List payment methods for a Merchant

Lists the applicable payment methods for a particular Merchant ID. Use the client secret and publishable key authorization to list all relevant payment methods of the merchant for the payment corresponding to the client secret.

GET /account/payment_methods

List payment methods for a Merchant

cURL

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

200

{
  "currency": "AED",
  "payment_methods": [
    {
      "payment_method": "card",
      "payment_method_types": [
        {
          "payment_method_type": "ach",
          "payment_experience": [
            {
              "eligible_connectors": [
                "stripe",
                "adyen"
              ],
              "payment_experience_type": "redirect_to_url"
            }
          ],
          "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
                }
              }
            }
          ],
          "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
            },
            "display_surcharge_amount": 123,
            "display_tax_on_surcharge_amount": 123,
            "display_total_surcharge_amount": 123,
            "tax_on_surcharge": {
              "percentage": 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": {}
    }
  },
  "show_surcharge_breakup_screen": true,
  "request_external_three_ds_authentication": true,
  "is_tax_calculation_enabled": true,
  "sdk_next_action": {
    "next_action": "post_session_tokens"
  },
  "is_guest_customer": true,
  "redirect_url": "https://www.google.com",
  "merchant_name": "<string>",
  "payment_type": "normal",
  "collect_shipping_details_from_wallets": true,
  "collect_billing_details_from_wallets": 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

Available options: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, US

accepted_currencies · enum<string>[] | null

The three-letter ISO currency code

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

Available options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL

amount · integer<int64> | 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<int64> | null

Indicates the limit of last used payment methods

card_networks · enum<string>[] | null

Indicates whether the payment method is eligible for card netwotks

Indicates the card network.

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

Response

200

application/json

Payment Methods retrieved

currency · enum<string> · required

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

Available options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL

payment_methods · object[] · required

Information about the payment method

Show child attributes

mandate_payment · object · required

Option 1

Option 2

Show child attributes

show_surcharge_breakup_screen · boolean · required

flag to indicate if surcharge and tax breakup screen should be shown or not

request_external_three_ds_authentication · boolean · required

flag to indicate whether to perform external 3ds authentication

Example:

true

is_tax_calculation_enabled · boolean · required

flag that indicates whether to calculate tax on the order amount

sdk_next_action · object · required

Show child attributes

is_guest_customer · boolean · required

indicates whether this is a guest customer flow

redirect_url · string | null

Redirect URL of the merchant

Example:

"https://www.google.com"

merchant_name · string | null

payment_type · enum<string>

The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.

Available options: normal, new_mandate, setup_mandate, recurring_mandate

collect_shipping_details_from_wallets · boolean | null

flag that indicates whether to collect shipping details from wallets or from the customer

collect_billing_details_from_wallets · boolean | null

flag that indicates whether to collect billing details from wallets or from the customer