B2C

Проверка возможности совершения платежа по реквизитам получателя через СБП

Песочница
POST https://sandbox.alfabank.ru/api/b2cpay/jp/v1/clients/checks
Пром
POST https://baas.alfabank.ru/api/b2cpay/jp/v1/clients/checks
Scope

b2c_sbp_payments

Описание
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
objectrequired

Контекст клиента

b2cClientId
stringoptional

Идентификатор клиента, от имени которого отправляется платёж (возвращается при использовании API провайдером)

partnerId
integerrequired

Идентификатор партнёра

nameCheck
booleanrequired

Флаг необходимости проверки совпадения переданного ФИО получателя и зарегистрированного ФИО получателя в НСПК

account
stringoptional
array of objectsrequired

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

amount
numberrequired

Сумма платежа

nspkBankId
stringrequired

ID банка получателя

paymentDescription
stringoptional

Описание платежа

phone
stringrequired

Телефон получателя

objectoptional

ФИО получателя. Обязателен, если в запросе передан nameCheck = true

last
stringoptional

Фамилия

first
stringoptional

Имя

middle
stringoptional

Отчество

Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/b2cpay/jp/v1/clients/checks' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "client": {
7    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
8    "partnerId": 100
9  },
10  "nameCheck": true,
11  "account": "40802810802790005307",
12  "payments": [
13    {
14      "amount": 100.53,
15      "nspkBankId": "100000000025",
16      "paymentDescription": "Оплата по договору №331",
17      "phone": "0079612894744",
18      "name": {
19        "last": "Иванов",
20        "first": "Василий",
21        "middle": "Семенович"
22      }
23    }
24  ]
25}'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "checkId": 291,
3  "client": {
4    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
5    "partnerId": 100
6  }
7}
BODY
атрибут
описание
checkId
stringrequired

Уникальный идентификатор запроса на проверку, по которому в дальнейшем возможно получение статуса проверки

objectrequired

Контекст клиента

b2cClientId
stringoptional

Идентификатор клиента, от имени которого отправляется платёж (возвращается при использовании API провайдером)

partnerId
integerrequired

Идентификатор партнёра

Пример ответа 200 (OK)
1{
2  "checkId": 291,
3  "client": {
4    "b2cClientId": "1b00587d-09a1-4928-af4f-1ce5eb769724",
5    "partnerId": 100
6  }
7}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_request - неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    insufficient_scope - при запросе токена доступа не были переданы все необходимые scopes. Необходимо повторно отправить запрос на получение токена доступа с указанием всех доступных scopes
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - эндпоинт не найден или неактивен
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    internal_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}