B2C

Получение баланса бонусных счетов (для системы партнёра)

Пром
GET https://baas.alfabank.ru/api/order-core/pp/v1/users/{userId}/bonus-accounts
Scope

system-core-orders

Описание

Метод позволяет системе партнёра получать информацию о балансе бонусных счетов клиента для проверки корректности расчёта бонусами.

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

PATH
Атрибут
Описание
userId
stringrequired
Пример запроса
Язык
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'
Параметры ответа
Пример ответа 200 (OK)
1[
2  {
3    "typeName": "AlfaTravel",
4    "balance": 189594,
5    "unitName": "Мили",
6    "status": "Активный"
7  }
8]
BODY
атрибут
описание
typeName
stringoptional

Наименование типа бонусного счёта

balance
integerrequired

Баланс счёта в минорных единицах

unitName
stringoptional

Наименование единиц измерения бонусов

status
stringrequired

Статус счёта. Принимает возможные значения:

  • •
    Активный - активный;
  • •
    Заморожен - замороженный;
  • •
    Закрыт - закрытый;
  • •
    Заблокирован - заблокированный;
  • •
    Новый - новый
Пример ответа 200 (OK)
1[
2  {
3    "typeName": "AlfaTravel",
4    "balance": 189594,
5    "unitName": "Мили",
6    "status": "Активный"
7  }
8]
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    validation_error/ invalid_request- неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
1{
2  "error": "validation_error",
3  "error_description": "Field sub: must not be null"
4}
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

Код ошибки. Принимает возможные значения:

  • •
    access_denied - доступ к счёту запрещен;
  • •
    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

Код ошибки. Принимает возможные значения:

  • •
    external_error - ошибка взаимодействия с внешним сервисом при обработке запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 502 (Bad Gateway)
1{
2  "error": "external_error",
3  "error_description": "External error"
4}
Нет тела ответа