Банки
Раздел для получения справочника доступных банков.
Используйте этот раздел перед созданием сделки. Он возвращает список банков и их uuid, которые нужны в запросах к разделу сделок.
Список банков
Возвращает список всех активных (enabled) банков.
| Параметр | Значение |
|---|---|
| Метод | GET |
| Путь | /api/banks/list |
| Роль | любой валидный токен |
Параметры запроса
Параметры не требуются.
bash
curl --request GET \
--url "https://arbitpay.online/api/banks/list" \
--header "Authorization: Bearer <API_KEY>"Ответ
json
{
"status": "success",
"code": "SUCCESS",
"data": [
{
"uuid": "a6ccb483-ffab-439f-ae08-34c87e6e6738",
"name": "Кредит Днепр",
"annotation": "..."
},
{
"uuid": "2b059da1-5a61-4f45-9474-596bd9285dd6",
"name": "Аккорд Банк",
"annotation": "..."
}
],
"message": "Banks list retrieved successfully."
}Поля объекта банка
| Поле | Тип | Описание |
|---|---|---|
uuid | string | Идентификатор банка (используется в deals) |
name | string | Название банка |
annotation | string | Краткое описание / примечание |
uuid из этого списка используется как bank_uuid при создании сделки.
Возможные ошибки
code | Условие |
|---|---|
INVALID_METHOD | Метод запроса не GET |