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

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

Пром GET https://baas.alfabank.ru/api/sbp/jp/v1/outgoing-payments/{outgoingPaymentId}/status

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

Scope

b2b-sbp

Параметры запроса

HEADER
Атрибут
Описание
Authorization
stringrequired

Bearer {access_token}, полученный по Client Credentials Flow

Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

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

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

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

Идентификатор клиента, от имени которого выполняется запрос

Пример запроса
curl -X GET https://baas.alfabank.ru/api/sbp/jp/v1/outgoing-payments/22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6/status?b2bClientId=021be5ed-6312-4982-a4e9-2a2cc44bc88c \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Параметры ответа

Пример ответа 200 (ОК)
{
  "outgoingPaymentId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6", 
  "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
  "status": "COMPLETE"
}
outgoingPaymentId
stringrequired

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

qrcId
stringrequired

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

status
stringrequired

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

  • SENDING_MESSAGE - Платёж в обработке;
  • COMPLETE - Платёж выполнен;
  • ERROR - Платёж отклонен
Пример ответа 200 (ОК)
{
  "outgoingPaymentId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6", 
  "qrcId": "AD1000038AQ1FG409KGACUQU5QRSH3FM",
  "status": "COMPLETE"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope

error_description
stringoptional

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

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен

error_description
stringoptional

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

Пример ошибки 404 (Not Found)
{
  "error": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
Пример ответа 429 (Too Many Requests)
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

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

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
Пример ответа 503 (Service Unavailable)
Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.