Песочница
GET https://sandbox.alfabank.ru/api/jp/v1/payments/{externalId}/state
Пром
GET https://baas.alfabank.ru/api/jp/v1/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
Внешний идентификатор платежа
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/jp/v1/payments/{externalId}/state' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
Пример ответа 200 (OK)
1{
2 "bankStatus": "IMPLEMENTED",
3 "bankComment": "Платёж выполнен успешно"
4}
HEADERS
Атрибут
Описание
x-traceid
stringoptional
Идентификатор трассировки запроса
BODY
атрибут
описание
bankStatus
stringoptional
Статус обработки платежа в банке. Принимает возможные значения:
-
•
ACCEPTED- принят; -
•
CREATED- создан; -
•
PARTSIGNED- отправлен на подпись или частично подписан; -
•
SIGNED- подписан; -
•
CARD2- ожидает оплаты; -
•
DELETED- удалён; -
•
REFUSEDBYBANK- отклонён Банком; -
•
REQUISITEERROR- ошибка реквизитов; -
•
IMPLEMENTED- исполнен
bankComment
stringoptional
Комментарий банка по результату операции
Пример ответа 200 (OK)
1{
2 "bankStatus": "IMPLEMENTED",
3 "bankComment": "Платёж выполнен успешно"
4}
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- у пользователя нет прав на использование запрашиваемого сервиса
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}
Нет тела ответа