B2C

Получение списка бонусных счетов

Пром GET https://baas.alfabank.ru/api/pp/v1/bonus-accounts

Песочница GET https://sandbox.alfabank.ru/api/pp/v1/bonus-accounts

Scope

loyalty

Описание

В результате выполнения данного запроса пользователь получает список бонусных счетов, с указанием по каждому из них: номера, наименования и баланса.

Параметры запроса

HEADERS
Атрибут
Описание
Accept
stringrequired

application/json

Authorization
stringrequired

Bearer {access_token}, полученный по Authorization Code Flow

Пример запроса
curl -X GET https://baas.alfabank.ru/api/pp/v1/bonus-accounts \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \

Параметры ответа

Пример ответа 200 (ОК)
{
  "loyaltyAccounts": [
    {
      "accountNumber": "1044074103953882",
      "typeId": "140",
      "typeDescription": "Банковский Cashback",
      "balanceAmount": {
        "value": 1000000,
        "currency": "RUR",
        "minorUnits": 100
      }
    },
    {
      "accountNumber": "1419602531731418",
      "typeDescription": "Лояльность X5 Карты",
      "typeId": "205",
      "balanceAmount": {
        "value": 100,
        "currency": "RUR",
        "minorUnits": 100
      }
    }
  ]
}
array of objectrequired

Бонусные счета

accountNumber
stringrequired

Номер бонусного счёта

typeId
stringrequired

Идентификатор типа бонусного счёта

typeDescription
stringrequired

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

objectoptional

Баланс счёта

value
integerrequired

Значение

currency
stringrequired

Код валюты

minorUnits
integerrequired

Минорные единицы

Пример ответа 200 (ОК)
{
  "loyaltyAccounts": [
    {
      "accountNumber": "1044074103953882",
      "typeId": "140",
      "typeDescription": "Банковский Cashback",
      "balanceAmount": {
        "value": 1000000,
        "currency": "RUR",
        "minorUnits": 100
      }
    },
    {
      "accountNumber": "1419602531731418",
      "typeDescription": "Лояльность X5 Карты",
      "typeId": "205",
      "balanceAmount": {
        "value": 100,
        "currency": "RUR",
        "minorUnits": 100
      }
    }
  ]
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; access_denied - доступ к счету запрещен

error_description
stringoptional

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

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
error
stringrequired

Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен

error_description
stringoptional

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

Пример ошибки 404 (Not Found)
{
  "error": "unknown_endpoint",
  "error_description": "Endpoint is not found or not active"
}
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

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

Пример ошибки 500 (Internal Server Error)
{
  "error": "internal_error",
  "error_description": "Internal server error"
}
Нет тела ответа

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.