B2BH2H

Получение статуса платёжного поручения

Пром GET https://baas.alfabank.ru/api/jp/v2/payments/{externalId}/state

Песочница GET https://sandbox.alfabank.ru/api/jp/v2/payments/{externalId}/state

Scope

payment

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

Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H

Accept
stringrequired

application/json

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

Идентификатор документа, присвоенный партнером (UUID)

Пример запроса
Язык
curl --location --request GET 'https://baas.alfabank.ru/api/jp/v2/payments/:externalId/state' \
--header 'Authorization: Bearer {access-token}' \
--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
{
  "bankStatus": "ACCEPTED",
  "bankComment": "Отправим платёж в течение банковского дня",
  "channelInfo": null,
  "crucialFieldsHash": "3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316"
}
BODY
атрибут
описание
bankStatus
stringoptional

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

  • ACCEPTED - Принят;
  • CREATED - Создан;
  • SIGNED - Подписан;
  • CARD2 - Ожидает оплаты;
  • DELETED - Удален;
  • REFUSEDBYBANK - Отвергнут банком;
  • REQUISITEERROR - Ошибка реквизитов;
  • IMPLEMENTED - Исполнен
bankComment
stringoptional

Банковский комментарий к статусу документа

channelInfo
stringoptional

Комментарий, специфичный для документа, полученного по данному каналу

crucialFieldsHash
stringoptional

Hash от ключевых полей документа

Пример ответа 200 (OK)
{
  "bankStatus": "ACCEPTED",
  "bankComment": "Отправим платёж в течение банковского дня",
  "channelInfo": null,
  "crucialFieldsHash": "3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316"
}
BODY
атрибут
описание
error
stringrequired

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

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

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
BODY
атрибут
описание
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"
}
BODY
атрибут
описание
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"
}
BODY
атрибут
описание
error
stringrequired

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

  • unknown_endpoint - Эндпоинт не найден или неактивен;
  • not_found - Платёж не найден или пока не исполнен
error_description
stringoptional

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

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

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

  • conflict - Платёжное поручение с таким externalId уже существует
error_description
stringoptional

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

Пример ошибки 409 (Conflict)
{
  "error": "conflict",
  "error_description": "Request could not be processed because of conflict in the request"
}
BODY
атрибут
описание
Нет тела ответа
BODY
атрибут
описание
error
stringrequired

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

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

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

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
BODY
атрибут
описание
Нет тела ответа