СКОРО В РЕЛИЗЕB2BH2H

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

Песочница
GET https://sandbox.alfabank.ru/api/semp/v1/payouts/registries/payments-check/{checkId}
Пром
GET https://baas.alfabank.ru/api/semp/v1/payouts/registries/payments-check/{checkId}
Scope

payment

Описание

Метод позволяет получить результаты проверки возможности совершения платежа через СБП по реквизитам получателя, выполненной с помощью метода «Проверка возможности совершения платежа через СБП по реквизитам получателя».

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

application/json

QUERY
Атрибут
Описание
accountNumber
stringrequired

Номер счёта отправителя

PATH
Атрибут
Описание
checkId
stringrequired
Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/semp/v1/payouts/registries/payments-check/{checkId}?accountNumber={accountNumber}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1[
2  {
3    "nameCheck": true,
4    "name": "Иванов Иван Иванович",
5    "nspkName": "Иванов Иван Иванович",
6    "phoneNumber": "79130000011",
7    "bankId": "012345678910",
8    "recipientAccount": "40817***************",
9    "amount": "10.00",
10    "feeAmount": "1.00",
11    "purpose": "Назначение платежа",
12    "nspkId": "A22060539473740100000533E625FCB3",
13    "status": "ALLOWED"
14  }
15]
BODY
атрибут
описание
nameCheck
booleanoptional

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

name
stringoptional

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

nspkName
stringoptional

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

phoneNumber
stringoptional

Номер телефона

bankId
stringoptional

Идентификатор банка получателя

recipientAccount
stringoptional

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

amount
stringoptional

Сумма выплаты

feeAmount
stringoptional

Расчётная сумма комиссии выплаты в рублях

purpose
stringoptional

Назначение платежа, которое будет отображено в выписке. Максимальная длина:

  • •
    для выплат резидентам - 110 символов;
  • •
    для выплат нерезидентам - 92 символа
nspkId
stringoptional

Референс операции НСПК (платёжная ссылка)

status
stringoptional

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

  • •
    IN_PROGRESS - в процессе обработки;
  • •
    ALLOWED - перевод по реквизитам phoneNumber и bankId возможен;
  • •
    RESTRICTED - перевод по реквизитам phoneNumber и bankId невозможен
Пример ответа 200 (OK) 
1[
2  {
3    "nameCheck": true,
4    "name": "Иванов Иван Иванович",
5    "nspkName": "Иванов Иван Иванович",
6    "phoneNumber": "79130000011",
7    "bankId": "012345678910",
8    "recipientAccount": "40817***************",
9    "amount": "10.00",
10    "feeAmount": "1.00",
11    "purpose": "Назначение платежа",
12    "nspkId": "A22060539473740100000533E625FCB3",
13    "status": "ALLOWED"
14  }
15]
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 и параметра prompt=consent
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}
Нет тела ответа
Проверка возможности совершения платежа через СБП по реквизитам получателяКак выбрать сервис