Scope
beneficiaries
Описание
Метод позволяет получить статус запроса на регистрацию, изменение или проверку контрагента (бенефициара или универсального реципиента) по идентификатору соответствующего запроса.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow H2H
application/json
Идентификатор запроса, полученный при создании запроса на регистрацию, изменение или проверку контрагента
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/beneficiaries/requests/{requestId}/status' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
1{
2 "requestId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3 "status": "COMPLETE",
4 "beneficiaryId": "cd9cbb96-360a-4462-a683-955cc29f7f55"
5}Идентификатор запроса
Статус запроса. Принимает возможные значения:
-
•
PENDING- запрос в процессе обработки; -
•
FAILED- обработка запроса завершилась ошибкой; -
•
COMPLETE- обработка запроса завершилась успешно
Идентификатор бенефициара. Возвращается при получении статуса запроса на регистрацию бенефициара
Идентификатор универсального реципиента. Возвращается при получении статуса запроса на регистрацию универсального реципиента
Описание причины, по которой запрос завершился неуспешно. Возвращается, если статус запроса равен FAILED
Результаты прохождения проверки. Возвращается при получении статуса запроса на проверку бенефициара
1{
2 "requestId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3 "status": "COMPLETE",
4 "beneficiaryId": "cd9cbb96-360a-4462-a683-955cc29f7f55"
5}Код ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
Описание ошибки
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
4}Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
Описание ошибки
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметраprompt=consent
Описание ошибки
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен
Описание ошибки
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}