GET
/
account
/
payment_methods
curl --request GET \
  --url https://sandbox.hyperswitch.io/account/payment_methods \
  --header 'api-key: <api-key>'
{
  "redirect_url": "https://www.google.com",
  "payment_methods": [
    {
      "payment_experience": null,
      "payment_method": "wallet",
      "payment_method_issuers": [
        "labore magna ipsum",
        "aute"
      ]
    }
  ],
  "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"
}

Authorizations

api-key
string
headerrequired

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.

Path Parameters

account_id
string
required

The unique identifier for the merchant account

accepted_currency
enum<string>[]
required

The three-letter ISO currency code

Available options:
AED,
ALL,
AMD,
ANG,
ARS,
AUD,
AWG,
AZN,
BBD,
BDT,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
GBP,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RUB,
RWF,
SAR,
SCR,
SEK,
SGD,
SLL,
SOS,
SSP,
SVC,
SZL,
THB,
TRY,
TTD,
TWD,
TZS,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
XAF,
XOF,
XPF,
YER,
ZAR

Query Parameters

accepted_country
string[]
required

The two-letter ISO currency code

minimum_amount
integer
required

The minimum amount accepted for processing by the particular payment method.

maximum_amount
integer
required

The maximum amount accepted for processing by the particular payment method.

recurring_payment_enabled
boolean
required

Indicates whether the payment method is eligible for recurring payments

installment_payment_enabled
boolean
required

Indicates whether the payment method is eligible for installment payments

Response

200 - application/json
redirect_url
string | null

Redirect URL of the merchant

payment_methods
object[]
required

Information about the payment method

mandate_payment
object
required
  • Option 1

  • Option 2

merchant_name
string | null
show_surcharge_breakup_screen
boolean
required

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

payment_type
enum<string>

To be used to specify the type of payment. Use 'setup_mandate' in case of zero auth flow.

Available options:
normal,
new_mandate,
setup_mandate,
recurring_mandate