Песочница
GET https://sandbox.alfabank.ru/api/aff/jp/v1/registers/{registerId}
Пром
GET https://baas.alfabank.ru/api/aff/jp/v1/registers/{registerId}
Scope
factoring
Описание
Метод позволяет получить статус реестра поручений, отправленного в банк на финансирование.
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Bearer {access_token}, полученный по Authorization Code Flow H2H
Accept
stringrequired
application/json
PATH
Атрибут
Описание
registerId
stringrequired
Идентификатор реестра платёжных поручений в формате UUID, полученный в результате выполнения метода "Создание реестра поручений"
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/aff/jp/v1/registers/{registerId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
Пример ответа 200 (OK)
1{
2 "status": "PAID"
3}
BODY
атрибут
описание
status
stringrequired
Статус реестра платёжных поручений. Возможные значения:
-
•
NEW- новый; -
•
SENT- отправлено; -
•
ERROR- ошибка; -
•
RECEIVED- загружено; -
•
VERIFICATION- на проверке; -
•
EXECUTION- в работе; -
•
EXECUTED- исполнено; -
•
PARTIALLY_PAID- частично оплачено; -
•
OVERDUE- просрочено; -
•
PAID- оплачено; -
•
REJECTED- отклонено; -
•
CLOSED- закрыто
Пример ответа 200 (OK)
1{
2 "status": "PAID"
3}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
error_description
stringrequired
Описание ошибки
Пример ошибки 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 и параметраprompt=consent
error_description
stringrequired
Описание ошибки
Пример ошибки 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
Код ошибки. Принимает возможные значения:
-
•
not_found- реестр не найден
error_description
stringrequired
Описание ошибки
Пример ошибки 404 (Not Found)
1{
2 "error": "not_found",
3 "error_description": "Register not found"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringrequired
Описание ошибки
Пример ошибки 500 (Internal Server Error)
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}
Нет тела ответа