B2C

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

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

b2c_sbp_payments

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

application/json

QUERY
Атрибут
Описание
partnerId
integerrequired

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

PATH
Атрибут
Описание
checkId
stringrequired

Идентификатор запроса на проверку возможности платежа

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/b2cpay/jp/v1/clients/checks/{checkId}?partnerId={partnerId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "client": {
3    "b2cClientId": "6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4",
4    "partnerId": 214
5  },
6  "payments": [
7    {
8      "amount": 10007.03,
9      "nspkBankId": "1crt88888881",
10      "nspkName": {
11        "first": "Иван",
12        "middle": "Иванович",
13        "last": "Иванов"
14      },
15      "name": {
16        "first": "Иван",
17        "middle": "Иванович",
18        "last": "Иванов"
19      },
20      "nameCheck": true,
21      "phone": "0079056010339",
22      "recipientAccount": 40702810000000000000,
23      "status": "ALLOWED",
24      "nspkId": "A3327083851463010000020011130505",
25      "error": null
26    }
27  ]
28}
BODY
атрибут
описание
objectrequired

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

b2cClientId
stringoptional

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

partnerId
integerrequired

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

array of objectsrequired

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

amount
numberrequired

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

nspkBankId
stringrequired

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

objectoptional

ФИО получателя в НСПК

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

objectoptional

ФИО получателя

first
stringoptional

Имя

middle
stringoptional

Отчество

last
stringoptional

Фамилия

nameCheck
booleanoptional

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

phone
stringrequired

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

recipientAccount
stringoptional

Счёт получателя ФЛ

status
stringrequired

Результат проверки возможности отправки платежа по реквизитам. Принимает возможные значения:

  • •
    PROCESSING - запрос находится в обработке;
  • •
    ALLOWED - возможен перевод по реквизитам phone и nspkBankId;
  • •
    RESTRICTED - невозможен перевод по реквизитам phone и nspkBankId
nspkId
stringoptional

Референс операции НСПК

error
stringoptional

Ошибка

Пример ответа 200 (OK)
1{
2  "client": {
3    "b2cClientId": "6abd7050-6aea-4fb1-90cd-0e1d8fecb1e4",
4    "partnerId": 214
5  },
6  "payments": [
7    {
8      "amount": 10007.03,
9      "nspkBankId": "1crt88888881",
10      "nspkName": {
11        "first": "Иван",
12        "middle": "Иванович",
13        "last": "Иванов"
14      },
15      "name": {
16        "first": "Иван",
17        "middle": "Иванович",
18        "last": "Иванов"
19      },
20      "nameCheck": true,
21      "phone": "0079056010339",
22      "recipientAccount": 40702810000000000000,
23      "status": "ALLOWED",
24      "nspkId": "A3327083851463010000020011130505",
25      "error": null
26    }
27  ]
28}
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}