Skip to content

Payout Feasibility Check

A method for sending a request to check whether an SBP payout via Sber can be made to the given recipient's bank details.

The check status is obtained using the getting the payout feasibility check status method, using the request_id from the response.

Calling this method is optional: an SBP payout can be created right away. The check is needed if you need to confirm in advance that a payout to the recipient's bank details is possible, verify the recipient's full name against NSPK data, or obtain a request_id to pass in the payout request.

URL

Method: 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

Request parameters

Name
 Type Required Description
amount integer Yes Amount in kopecks
phone string Yes Recipient's phone number. Digits only.
bank_id string Yes Bank name obtained from the list of banks
session_id string Yes Identifier of the authorized Sber session
business_card_id string Yes Identifier of the Sber corporate card the payout is made from
fio string No Recipient's full name
fio_check boolean No Flag indicating that the passed full name must be checked against the one returned by NSPK
description string No Purpose of payment. Defaults to выплата (Russian for "payout").
user_crypto_type string No Sber user crypto profile: SMS or Token. Defaults to SMS.

fio and fio_check can be omitted, in which case the customer's full name will be returned when getting the payout feasibility status.

Request example

Do not transliterate personal data

Enter fio exactly as recorded, in Cyrillic; do not translate or transliterate it. This matters in particular when fio_check: true, since NSPK compares it against the recipient's actual full name.

{
  "amount": 10000,
  "phone": "79991234567",
  "bank_id": "100100000014",
  "fio": "Иванов Иван Иванович",
  "fio_check": true,
  "description": "Payout under contract No. 123",
  "session_id": "11111111-1111-1111-1111-111111111111",
  "business_card_id": "business-card-id",
  "user_crypto_type": "SMS"
}

Request headers

Name Type Required Description
X-Api-Key string Yes Unique shop identifier
X-Signature string Yes Signature

The X-Signature signature is formed by concatenating X-Api-Key, phone, bank_id, and secret_key. sha256 is computed from the resulting string:

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

where secret_key is the secret key found in the merchant's shop settings.

Response

Response example

{
  "request_id": "1234"
}

Response parameters

Name Type Description
request_id string Used in the method for getting the payout feasibility status 
{
  "errors": [
    {
      "code": 20002,
      "message": "Invalid signature"
    }
  ]
}

{
  "errors": [
    {
      "code": 20098,
      "message": "session_id: Field required"
    }
  ]
}

Error codes

Code Description
20001 Invalid api-key
20002 Invalid signature
20003 Payout profile is not linked to the shop
20005 Error from the PSP service
20041 The resulting description field exceeds the allowed length
20098 Request field validation error