Песочница
GET https://sandbox.alfabank.ru/api/na/jp/v1/universal-recipients/{universalRecipientId}
Пром
GET https://baas.alfabank.ru/api/na/jp/v1/universal-recipients/{universalRecipientId}
Scope
beneficiaries
Описание
Метод позволяет получить информацию об универсальном реципиенте по universalRecipientId.
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Bearer {access_token}, полученный по Authorization Code Flow H2H
Accept
stringrequired
application/json
PATH
Атрибут
Описание
universalRecipientId
stringrequired
Идентификатор универсального реципиента
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/universal-recipients/{universalRecipientId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
Пример ответа 200 (OK)
1{
2 "universalRecipientId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3 "accountNumber": "40817810306050000000",
4 "isBeneficiary": false,
5 "type": "UL_RESIDENT",
6 "isActive": true
7}
BODY
атрибут
описание
universalRecipientId
stringrequired
Идентификатор универсального реципиента
accountNumber
stringrequired
Номер номинального счёта
isBeneficiary
booleanrequired
Признак бенефициара. Принимает возможные значения:
-
•
true- является бенефициаром; -
•
false- является универсальным реципиентом
type
stringrequired
Тип контрагента. Принимает возможные значения:
-
•
FL_RESIDENT- физ. лицо, резидент; -
•
UL_RESIDENT- юр. лицо, резидент; -
•
IP_RESIDENT- ИП, резидент; -
•
FL_NONRESIDENT- физ. лицо, нерезидент; -
•
UL_NONRESIDENT- юр. лицо, нерезидент; -
•
IP_NONRESIDENT- ИП, нерезидент
isActive
booleanrequired
Признак активности бенефициара. Принимает возможные значения:
-
•
true- активен; -
•
false- деактивирован
Пример ответа 200 (OK)
1{
2 "universalRecipientId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3 "accountNumber": "40817810306050000000",
4 "isBeneficiary": false,
5 "type": "UL_RESIDENT",
6 "isActive": true
7}
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- при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметраprompt=consent
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}
Нет тела ответа