Пром
GET https://baas.alfabank.ru/api/order-core/pp/v1/bonus-accounts
Scope
coreorders
Описание
Метод позволяет клиентам получить информацию о балансе своих бонусных счетов.
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Bearer {access_token}, полученный по Authorization Code Flow
Accept
stringrequired
application/json
Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/order-core/pp/v1/bonus-accounts' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
Пример ответа 200 (OK)
1[
2 {
3 "typeName": "AlfaTravel",
4 "balance": 189594,
5 "unitName": "Мили"
6 }
7]
BODY
атрибут
описание
typeName
stringrequired
Наименование типа бонусного счёта
balance
integerrequired
Баланс счёта
unitName
stringrequired
Наименование единиц измерения бонусов
Пример ответа 200 (OK)
1[
2 {
3 "typeName": "AlfaTravel",
4 "balance": 189594,
5 "unitName": "Мили"
6 }
7]
BODY
атрибут
описание
error
stringoptional
Код ошибки. Принимает возможные значения:
-
•
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
stringoptional
Описание ошибки. Принимает возможные значения:
-
•
forbidden/insufficient_scope- у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope
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
stringoptional
Код ошибки. Принимает возможные значения:
-
•
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
stringoptional
Код ошибки. Принимает возможные значения:
-
•
internal_server_error- внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional
Описание ошибки
Пример ошибки 500 (Internal Server Error)
1{
2 "error": "internal_server_error",
3 "error_description": "Internal server error"
4}
BODY
атрибут
описание
error
stringoptional
Код ошибки. Принимает возможные значения:
-
•
bad_gateway- ошибка взаимодействия с внешним сервисом при обработке запроса
error_description
stringoptional
Описание ошибки
Пример ошибки 502 (Bad Gateway)
1{
2 "error": "bad_gateway",
3 "error_description": "External error"
4}
Нет тела ответа