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

Песочница

GET https://sandbox.alfabank.ru/api/pp/v1/bonus-accounts

Пром

GET https://baas.alfabank.ru/api/pp/v1/bonus-accounts

Scope

loyalty

Описание

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

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

stringrequired

application/json

Пример запроса

Язык

1curl --location 'https://baas.alfabank.ru/api/pp/v1/bonus-accounts' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

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

Пример ответа 200 (OK)

1{
2  "loyaltyAccounts": [
3    {
4      "accountNumber": "1419602531731418",
5      "typeDescription": "Лояльность X5 Карты",
6      "typeId": "205",
7      "balanceAmount": {
8        "value": 100,
9        "currency": "RUR",
10        "minorUnits": 100
11      }
12    }
13  ]
14}

BODY

атрибут

описание

array of objectsrequired

Бонусный счёт

accountNumber

stringrequired

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

typeId

stringrequired

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

typeDescription

stringrequired

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

objectoptional

Баланс счёта

value

integerrequired

Значение

currency

stringrequired

Код валюты

minorUnits

integerrequired

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

Пример ответа 200 (OK)

1{
2  "loyaltyAccounts": [
3    {
4      "accountNumber": "1419602531731418",
5      "typeDescription": "Лояльность X5 Карты",
6      "typeId": "205",
7      "balanceAmount": {
8        "value": 100,
9        "currency": "RUR",
10        "minorUnits": 100
11      }
12    }
13  ]
14}

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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_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;
•

access_denied - доступ к счёту запрещён

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}

Нет тела ответа