Retrieving the Bank List¶

Note: Parameters marked with an asterisk (*) are required.

This method allows you to retrieve the list of banks available in the system. The retrieved bank codes (code) are used in the bank_code parameter when creating a payout request.

Retrieving the Bank List¶

Request¶

GET example.com/api/merchant/"merchant"/info/banks

Headers¶

Name	Value
Content-Type*	application/json
X-Api-Key*	X-Api-Key

Query Parameters¶

Name	Type	Format	Description
fiat_currency	string	enum	Currency code to filter the bank list. If the parameter is not provided or equals `all`, banks for all currencies are returned. Available currency values are listed in the regions list.

Request Example with Currency Filter¶

GET example.com/api/merchant/"merchant"/info/banks?fiat_currency=rub

Response Parameters¶

Name	Type	Description
banks*	array	Array of banks
banks[].name*	string	Bank name
banks[].code	string	Bank technical code (may be null)
banks[].fiat_currency*	string	Bank currency code

Response Example¶

200Error 400 and other 4xx

{
  "ok": true,
  "banks": [
    {
      "name": "Kaspi",
      "code": "kaspi",
      "fiat_currency": "kzt"
    },
    {
      "name": "Sberbank",
      "code": "sber",
      "fiat_currency": "rub"
    },
    {
      "name": "Tinkoff",
      "code": "tinkoff",
      "fiat_currency": "rub"
    }
  ]
}

{
  "ok": false,
  "error": "message"
}