Перейти к содержанию

Список банков СБП

Возвращает общий справочник банков СБП. Используйте значения bank_id и bank_bic при проверке возможности выплаты и создании выплаты через СБП.

URL

GET https://api.pay.kvell.group/v1/collections/banks
GET https://api.pay.stage.kvell.group/v1/collections/banks

Запрос

Заголовки

Название Тип Обязательно Описание
X-Api-Key string Да Идентификатор магазина.

Подпись X-Signature для этого метода не требуется.

Пример

curl --request GET \
  --url 'https://api.pay.stage.kvell.group/v1/collections/banks' \
  --header 'X-Api-Key: 00000000-0000-4000-8000-000000000000'

Ответ

Выберите HTTP-код, чтобы посмотреть пример, параметры ответа и рекомендуемые действия.

Пример ответа 200 (OK)
[
  {
    "bank_id": "100000000014",
    "bank_bic": "044525151",
    "name": "Банк Русский Стандарт"
  },
  {
    "bank_id": "100000000202",
    "bank_bic": "044525845",
    "name": "Норвик Банк"
  },
  {
    "bank_id": "100000000051",
    "bank_bic": null,
    "name": "Далена Банк"
  }
]

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

Параметр Тип Описание
bank_id string Идентификатор банка в СБП.
bank_bic string | null БИК банка. Возвращается null, если БИК отсутствует в справочнике.
name string Наименование банка.
Пример ответа 403 (Forbidden)
{
  "errors": [
    {
      "code": 20037,
      "message": "Доступ запрещен"
    }
  ]
}

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

Параметр Тип Описание
errors array Список ошибок. Коды и рекомендации приведены в разделе «Ошибки HTTP-ответов».
errors[].code integer Код ошибки.
errors[].message string Описание причины запрета доступа.
Пример ответа 404 (Not Found)
{
  "errors": [
    {
      "code": 20006,
      "message": "Магазин не найден"
    }
  ]
}

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

Параметр Тип Описание
errors array Список ошибок. Коды и рекомендации приведены в разделе «Ошибки HTTP-ответов».
errors[].code integer Код ошибки.
errors[].message string Описание ресурса, который не найден.
Пример ответа 422 (Unprocessable Entity)
{
  "errors": [
    {
      "code": 20098,
      "message": "x-api-key: Field required"
    }
  ]
}

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

Параметр Тип Описание
errors array Список ошибок валидации. Коды и рекомендации приведены в разделе «Ошибки HTTP-ответов».
errors[].code integer Код ошибки.
errors[].message string Поле и причина ошибки валидации.
Пример ответа 5XX (Internal Server Error)
{
  "errors": [
    {
      "code": 20000,
      "message": "Неизвестная ошибка"
    }
  ]
}

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

Параметр Тип Описание
errors array Список ошибок. Коды и рекомендации приведены в разделе «Ошибки HTTP-ответов».
errors[].code integer Код технической ошибки.
errors[].message string Описание технической ошибки.

Что делать дальше

  1. Безопасно повторите тот же GET-запрос с тем же X-Api-Key.
  2. При повторяющейся ошибке обратитесь в поддержку KVELL и передайте URL, время запроса, HTTP-код, code и message.