B2BH2H

Получение статуса исходящего платежа

Песочница
GET https://sandbox.alfabank.ru/api/sbp/jp/v1/outgoing-payments/{outgoingPaymentId}/status
Пром
GET https://baas.alfabank.ru/api/sbp/jp/v1/outgoing-payments/{outgoingPaymentId}/status
Scope

b2b-sbp

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

application/json

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

Идентификатор клиента, от имени которого выполняется запрос. Банк сообщает партнёру API при подключении

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

Идентификатор исходящего платежа

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/sbp/jp/v1/outgoing-payments/{outgoingPaymentId}/status?b2bClientId={b2bClientId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "outgoingPaymentId": "146e5f1a-073e-45a8-9b3e-f5350dfaab94",
3  "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
4  "status": "SENDING_MESSAGE"
5}
BODY
атрибут
описание
outgoingPaymentId
stringrequired

Идентификатор платежа в СБП B2B

qrcId
stringrequired

Идентификатор платёжной ссылки

status
stringrequired

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

  • •
    SENDING_MESSAGE - платёж в обработке;
  • •
    DRAFT - черновик платежа зарегистрирован;
  • •
    COMPLETE - платёж выполнен;
  • •
    ERROR - платёж отклонён
Пример ответа 200 (OK)
1{
2  "outgoingPaymentId": "146e5f1a-073e-45a8-9b3e-f5350dfaab94",
3  "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
4  "status": "SENDING_MESSAGE"
5}
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}
Нет тела ответа