Проверка возможности выплаты
Метод отправки запроса о возможности совершить выплату по данным реквизитам получателя.
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 | Да | Номер телефона получателя. Только цифры. |
description |
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
от полученной строки:
где secret_key - секретный ключ, который находится в настройках магазина мерчанта;
Ответ запроса
Примеры ответов
Параметры ответа
| Название | Тип данных | Описание |
|---|---|---|
request_id |
string | Используется в методе получения статуса возможности выплаты |
Параметры ответа
| Название | Тип данных | Описание |
|---|---|---|
errors |
array | Список ошибок |
code |
int | Код ошибки |
message |
string | Текст ошибки |
Параметры ответа
| Название | Тип данных | Описание |
|---|---|---|
message |
string | Текст ошибки от банка |
Параметры ответа
| Название | Тип данных | Описание |
|---|---|---|
errors |
array | Список ошибок |
code |
int | Код ошибки |
message |
string | Текст ошибки |