Scope
system-core-orders
Описание
Метод позволяет системе партнёра получать информацию о балансе бонусных счетов клиента для проверки корректности расчёта бонусами.
Параметры запроса
Bearer {access_token}, полученный по Client Credentials Flow
application/json
Идентификатор субъекта (sub), полученный при декодировании access_token, ранее выпущенного на клиента по Authorization Code Flow. Как декодировать access_token
1curl --location --globoff 'https://baas.alfabank.ru/api/order-core/pp/v1/users/{userId}/bonus-accounts' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
1[
2 {
3 "typeName": "AlfaTravel",
4 "balance": 189594,
5 "unitName": "Мили",
6 "status": "Активный"
7 }
8]
Наименование типа бонусного счёта
Баланс счёта в минорных единицах
Наименование единиц измерения бонусов
Статус счёта. Принимает возможные значения:
-
•
Активный- активный; -
•
Заморожен- замороженный; -
•
Закрыт- закрытый; -
•
Заблокирован- заблокированный; -
•
Новый- новый
1[
2 {
3 "typeName": "AlfaTravel",
4 "balance": 189594,
5 "unitName": "Мили",
6 "status": "Активный"
7 }
8]
Код ошибки. Принимает возможные значения:
-
•
validation_error/invalid_request- неверные входные параметры запроса
Описание ошибки
1{
2 "error": "validation_error",
3 "error_description": "Field sub: must not be null"
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}
Код ошибки. Принимает возможные значения:
-
•
access_denied- доступ к счёту запрещен; -
•
insufficient_scope- у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope
Описание ошибки
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_server_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_server_error",
3 "error_description": "Internal server error"
4}
Код ошибки. Принимает возможные значения:
-
•
external_error- ошибка взаимодействия с внешним сервисом при обработке запроса
Описание ошибки
1{
2 "error": "external_error",
3 "error_description": "External error"
4}