Песочница
GET https://sandbox.alfabank.ru/api/na/jp/v1/beneficiaries/{beneficiaryId}/balance
Пром
GET https://baas.alfabank.ru/api/na/jp/v1/beneficiaries/{beneficiaryId}/balance
Scope
beneficiaries
Описание
Метод позволяет получить баланс счёта бенефициара по beneficiaryId на определённую дату.
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Bearer {access_token}, полученный по Authorization Code Flow H2H
Accept
stringrequired
application/json
QUERY
Атрибут
Описание
accountNumber
stringrequired
Номер номинального счёта
date
stringrequired
Дата
PATH
Атрибут
Описание
beneficiaryId
stringrequired
Идентификатор бенефициара
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/na/jp/v1/beneficiaries/{beneficiaryId}/balance?accountNumber=40817810306050000000&date=2024-01-01' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
Пример ответа 200 (OK)
1{
2 "beneficiaryId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3 "accountNumber": "40817810306050000000",
4 "date": "2024-01-01",
5 "balances": [
6 {
7 "walletType": "MAIN",
8 "freeBalance": 10,
9 "heldBalance": 10
10 }
11 ]
12}
BODY
атрибут
описание
beneficiaryId
stringrequired
Идентификатор бенефициара
accountNumber
stringrequired
Номер счёта
date
stringrequired
Дата
array of objectsoptional
Балансы бенефициара
walletType
stringoptional
Тип кошелька. Принимает возможные значения:
-
•
MAIN- основной кошелек; -
•
TAX- налоговый кошелек
freeBalance
integeroptional
Свободные денежные средства в рублях
heldBalance
integeroptional
Захолдированные денежные средства в рублях
Пример ответа 200 (OK)
1{
2 "beneficiaryId": "ab9cbb96-360a-4462-a683-955cc29f7f54",
3 "accountNumber": "40817810306050000000",
4 "date": "2024-01-01",
5 "balances": [
6 {
7 "walletType": "MAIN",
8 "freeBalance": 10,
9 "heldBalance": 10
10 }
11 ]
12}
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}
Нет тела ответа