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

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

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

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

Вызов метода необязателен: выплату СБП можно создавать сразу. Проверка нужна, если требуется заранее убедиться, что выплата по реквизитам получателя возможна, сверить ФИО получателя с данными НСПК или получить request_id для передачи в запросе выплаты.

URL

Метод: POST

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

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

Название
 Тип данных Обязательно Описание
amount integer Да Сумма в копейках
phone string Да Номер телефона получателя. Только цифры.
bank_id string Да Название банка полученный из списка банков
session_id string Да Идентификатор авторизованной сессии Сбер
business_card_id string Да Идентификатор корпоративной карты Сбер, с которой выполняется выплата
fio string Нет ФИО получателя
fio_check boolean Нет Флаг для указания, что требуется проверка совпадения переданного ФИО и возвращаемого НСПК
description string Нет Назначение платежа. По умолчанию выплата.
user_crypto_type string Нет Криптопрофиль пользователя Сбер: SMS или Token. По умолчанию SMS.

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

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

{
  "amount": 10000,
  "phone": "79991234567",
  "bank_id": "100100000014",
  "fio": "Иванов Иван Иванович",
  "fio_check": true,
  "description": "Выплата по договору №123",
  "session_id": "11111111-1111-1111-1111-111111111111",
  "business_card_id": "business-card-id",
  "user_crypto_type": "SMS"
}

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

Название Тип данных Обязательно Описание
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": [
    {
      "code": 20098,
      "message": "session_id: Field required"
    }
  ]
}

Коды ошибок

Код Описание
20001 Неверный api-key
20002 Неверная подпись
20003 Payout профиль не привязан к магазину
20005 Ошибка от PSP сервиса
20041 Итоговое поле description превышает допустимую длину
20098 Ошибка валидации полей запроса