v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB

Payment Methods

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

Query parameters

client_secretstring nullable

This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK

accepted_countriesCountryAlpha2[] nullable

The two-letter ISO currency code

accepted_currenciesCurrency[] nullable

The three-letter ISO currency code

amountinteger nullable

The amount accepted for processing by the particular payment method.

recurring_enabledboolean nullable

Indicates whether the payment method is eligible for recurring payments

installment_payment_enabledboolean nullable

Indicates whether the payment method is eligible for installment payments

limitinteger nullable

Indicates the limit of last used payment methods

card_networksCardNetwork[] nullable

Indicates whether the payment method is eligible for card netwotks

Response

Payment Methods retrieved

redirect_urlstring nullable

Redirect URL of the merchant

currency'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' required

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

merchant_namestring nullable

show_surcharge_breakup_screenboolean required

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

payment_type'normal' | 'new_mandate' | 'setup_mandate' | 'recurring_mandate' | 'installment'

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

request_external_three_ds_authenticationboolean required

flag to indicate whether to perform external 3ds authentication

collect_shipping_details_from_walletsboolean nullable

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

collect_billing_details_from_walletsboolean nullable

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

is_tax_calculation_enabledboolean required

flag that indicates whether to calculate tax on the order amount

is_guest_customerboolean required

indicates whether this is a guest customer flow