Получение списка банков¶

Примечание: Параметры, отмеченные звездочкой (*), являются обязательными.

Метод позволяет получить список банков, доступных в системе. Полученные коды банков (code) используются в параметре bank_code при создании заявки на выплату.

Получение списка банков¶

Запрос¶

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

Заголовки¶

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

Параметры запроса (query)¶

Name	Type	Format	Description
fiat_currency	string	enum	Код валюты для фильтрации списка банков. Если параметр не передан или равен `all`, возвращаются банки по всем валютам. Доступные значения валют приведены в списке регионов.

Пример запроса с фильтром по валюте¶

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

Параметры ответа¶

Name	Type	Description
banks*	array	Массив банков
banks[].name*	string	Название банка
banks[].code	string	Технический код банка (может быть null)
banks[].fiat_currency*	string	Код валюты банка

Пример ответа¶

200Ошибка 400 и остальные 4xx

{
  "ok": true,
  "banks": [
    {
      "name": "Сбербанк",
      "code": "sber",
      "fiat_currency": "rub"
    },
    {
      "name": "Тинькофф",
      "code": "tinkoff",
      "fiat_currency": "rub"
    }
  ]
}

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