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

Проверка возможности выплаты

Метод отправки запроса о возможности совершить выплату по данным реквизитам получателя.

URL

Метод: POST

  • Production: https://api.pay.kvell.group/v1/orders/payout/sbp/check
  • Stage: https://api.pay.stage.kvell.group/v1/orders/payout/sbp/check

Параметры запроса

Название Тип данных Обязательно Описание
amount integer Да Сумма в копейках
bank_id string Да Bank Id полученный из списка банков
bank_bic string Нет Бик банка полученый из списка банков. Зависит от банка-эквайера. Уточнять у менеджера.
fio string Да ФИО получателя
fio_check string Да Флаг для указания, что требуется проверка совпадения переданного ФИО и возвращаемого НСПК
phone string Да Номер телефона получателя. Только цифры.

fio и fio_check можно не передавать, в таком случае при получении статуса возможности выплаты будет приходить ФИО клиента.

Пример запроса

{
  "amount": 100,
  "bank_id": "100100000014",
  "fio": "Иванв Иван Иванович",
  "fio_check": true,
  "phone": "79991234567"
}

Заголовки запроса

Название Тип данных Обязательно Описание
X-Api-Key string Да Уникальный идентификатор магазина
X-Signature string Да Подпись

Подпись X-Signature формируется конкатенацией X-Api-Key, phone, bank_id и secret_key. Формируется sha256 от полученной строки:

sha256({X-Api-Key}{phone}{bank_id}{secret_key})

где secret_key - секретный ключ, который находится в настройках магазина мерчанта;

Ответ запроса

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

{
  "request_id": "1234"
}

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

Название Тип данных Описание
request_id string Используется в методе получения статуса возможности выплаты
{
  "errors":
  [
    {
      "code": 20002,
      "message": "Неверная подпись"
    }
  ]
}

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

Название Тип данных Описание
errors array Список ошибок
    code int Код ошибки
    message string Текст ошибки
{
  "message": "1706: Банк с RbankID = 100000000118 не найден!"
}

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

Название Тип данных Описание
message string Текст ошибки от банка
{
  "errors":
  [
    {
      "code": 20098,
      "message": "amount: Field required"
    }
  ]
}

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

Название Тип данных Описание
errors array Список ошибок
    code int Код ошибки
    message string Текст ошибки
{
  "errors":
  [
    {
      "code": 20000,
      "message": "Неизвестная ошибка"
    }
  ]
}

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

Название Тип данных Описание
errors array Список ошибок
    code int Код ошибки
    message string Текст ошибки