Пром GET https://baas.alfabank.ru/api/jp/v2/payments/{externalId}/state
Песочница GET https://sandbox.alfabank.ru/api/jp/v2/payments/{externalId}/state
Scope
payment
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
application/json
Идентификатор документа, присвоенный партнером (UUID)
curl --location --request GET 'https://baas.alfabank.ru/api/jp/v2/payments/:externalId/state' \
--header 'Authorization: Bearer {access-token}' \
--header 'Accept: application/json'
Параметры ответа
{
"bankStatus": "ACCEPTED",
"bankComment": "Отправим платёж в течение банковского дня",
"channelInfo": null,
"crucialFieldsHash": "3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316"
}
Статус документа. Принимает возможные значения:
- •
ACCEPTED
- Принят; - •
CREATED
- Создан; - •
SIGNED
- Подписан; - •
CARD2
- Ожидает оплаты; - •
DELETED
- Удален; - •
REFUSEDBYBANK
- Отвергнут банком; - •
REQUISITEERROR
- Ошибка реквизитов; - •
IMPLEMENTED
- Исполнен
Банковский комментарий к статусу документа
Комментарий, специфичный для документа, полученного по данному каналу
Hash от ключевых полей документа
{
"bankStatus": "ACCEPTED",
"bankComment": "Отправим платёж в течение банковского дня",
"channelInfo": null,
"crucialFieldsHash": "3ba4cecce366c3ad8db6edafb71052b37a8a1acc8013ff565879d8711c0c4316"
}
Код ошибки. Принимает возможные значения:
- •
invalid_request
- Неверные входные параметры запроса
Описание ошибки
{
"error": "invalid_request",
"error_description": "Authorization header is not present in request headers"
}
Код ошибки. Принимает возможные значения:
- •
invalid_token
- Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
Описание ошибки
{
"error": "invalid_token",
"error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
Код ошибки. Принимает возможные значения:
- •
insufficient_scope
- У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope
Описание ошибки
{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the access token"
}
Код ошибки. Принимает возможные значения:
- •
unknown_endpoint
- Эндпоинт не найден или неактивен; - •
not_found
- Платёж не найден или пока не исполнен
Описание ошибки
{
"error": "unknown_endpoint",
"error_description": "Endpoint is not found or not active"
}
Код ошибки. Принимает возможные значения:
- •
conflict
- Платёжное поручение с такимexternalId
уже существует
Описание ошибки
{
"error": "conflict",
"error_description": "Request could not be processed because of conflict in the request"
}
Код ошибки. Принимает возможные значения:
- •
internal_error
- Внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
{
"error": "internal_error",
"error_description": "Internal server error"
}