Scope
beneficiaries
Описание
Метод позволяет получить список универсальных реципиентов номинального счёта.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow H2H
application/json
Количество объектов на одной странице
Количество объектов в списке, которые необходимо пропустить
Номер номинального счёта
Тип универсального реципиента. Возможные значения:
-
•
FL_RESIDENT- физ. лицо, резидент; -
•
UL_RESIDENT- юр. лицо, резидент; -
•
IP_RESIDENT- ИП, резидент; -
•
FL_NONRESIDENT- физ. лицо, нерезидент; -
•
UL_NONRESIDENT- юр. лицо, нерезидент; -
•
IP_NONRESIDENT- ИП, нерезидент
Признак активности универсального реципиента. Возможные значения:
-
•
true- активен; -
•
false- деактивирован
Дата выборки
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/universal-recipients?limit={limit}&offset={offset}&accountNumber=40817810306050000000&type=UL_RESIDENT&isActive={isActive}&date=2024-01-01' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
1{
2 "pagination": {
3 "limit": 100,
4 "offset": 0,
5 "totalCount": 2
6 },
7 "accountNumber": "40817810306050000000",
8 "date": "2024-01-01",
9 "universalRecipients": [
10 {
11 "universalRecipientId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
12 "isBeneficiary": false,
13 "type": "UL_RESIDENT",
14 "isActive": true
15 },
16 {
17 "universalRecipientId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
18 "isBeneficiary": false,
19 "type": "FL_RESIDENT",
20 "isActive": true
21 }
22 ]
23}Данные пагинации
Количество записей на одной странице
Количество записей в списке, которые были пропущены
Общее количество записей
Номер номинального счёта
Дата
Информация об универсальных реципиентах
Идентификатор универсального реципиента
Признак бенефициара. Принимает возможные значения:
-
•
true- является бенефициаром; -
•
false- является универсальным реципиентом
Тип контрагента. Принимает возможные значения:
-
•
FL_RESIDENT- физ. лицо, резидент; -
•
UL_RESIDENT- юр. лицо, резидент
Признак активности универсального реципиента. Принимает возможные значения:
-
•
true- активен; -
•
false- деактивирован
1{
2 "pagination": {
3 "limit": 100,
4 "offset": 0,
5 "totalCount": 2
6 },
7 "accountNumber": "40817810306050000000",
8 "date": "2024-01-01",
9 "universalRecipients": [
10 {
11 "universalRecipientId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
12 "isBeneficiary": false,
13 "type": "UL_RESIDENT",
14 "isActive": true
15 },
16 {
17 "universalRecipientId": "cd9cbb96-360a-4462-a683-955cc29f7f55",
18 "isBeneficiary": false,
19 "type": "FL_RESIDENT",
20 "isActive": true
21 }
22 ]
23}Код ошибки. Принимает возможные значения:
-
•
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}