Получение информации о начислениях по бонусному счёту

Песочница

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

Пром

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

Scope

loyalty

Описание

В рамках вызова данного метода клиент получает информацию о начислениях по конкретному бонусному счёту, в частности:

•

кэшбэк за текущий период;
•

прогноз начисления кэшбэка на следующий расчётный период;
•

график начислений кэшбэка;
•

общую сумму начисленного за всё время кэшбэка.

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

stringrequired

application/json

PATH

Атрибут

Описание

accountNumber

stringrequired

Номер счёта

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

Язык

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

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

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

1{
2  "cashbackAccount": {
3    "accountNumber": "1419602531731418",
4    "typeDescription": "Лояльность X5 Карты",
5    "typeId": "205",
6    "balanceAmount": {
7      "value": 100,
8      "currency": "RUR",
9      "minorUnits": 100
10    }
11  },
12  "cashbackForecast": {
13    "totalActivePeriodAmount": {
14      "amount": {
15        "value": 100,
16        "currency": "RUR",
17        "minorUnits": 100
18      },
19      "payOutDate": "2022-02-02"
20    },
21    "totalIntermediatePeriodAmount": {
22      "amount": {
23        "value": 100,
24        "currency": "RUR",
25        "minorUnits": 100
26      },
27      "payOutDate": "2022-02-02"
28    }
29  },
30  "cashbackStatistic": {
31    "payments": [
32      {
33        "period": "Июнь 2022",
34        "status": "PAST",
35        "amount": {
36          "value": 100,
37          "currency": "RUR",
38          "minorUnits": 100
39        }
40      }
41    ]
42  },
43  "overallCashback": {
44    "amount": {
45      "value": 100,
46      "currency": "RUR",
47      "minorUnits": 100
48    },
49    "description": "кэшбэк за всё время"
50  }
51}

BODY

атрибут

описание

objectrequired

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

accountNumber

stringrequired

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

typeId

stringrequired

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

typeDescription

stringrequired

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

objectoptional

Баланс счёта

value

integerrequired

Значение

currency

stringrequired

Код валюты

minorUnits

integerrequired

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

objectrequired

Прогноз начислений кэшбэка

objectrequired

кэшбэк за текущий расчетный период

objectrequired

Количество начисленного кэшбэка

value

integerrequired

Значение

currency

stringrequired

Код валюты

minorUnits

integerrequired

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

payOutDate

stringrequired

Дата начисления кэшбэка

objectoptional

Прогноз начисления кэшбэка за следующий расчетный период

objectrequired

Количество начисленного кэшбэка

value

integerrequired

Значение

currency

stringrequired

Код валюты

minorUnits

integerrequired

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

payOutDate

stringrequired

Дата начисления кэшбэка

objectrequired

График начислений кэшбэка

array of objectsrequired

Массив с графиком начислений кэшбэка

period

stringrequired

Месяц и год периода в формате MMYYYY

status

stringrequired

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

•

PAST - для предыдущих месяцев;
•

PRESENT - для текущего месяца

objectrequired

Количество начисленного кэшбэка

value

integerrequired

Значение

currency

stringrequired

Код валюты

minorUnits

integerrequired

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

objectrequired

Общий кэшбэк за все время

objectrequired

Количество начисленного кэшбэка

value

integerrequired

Значение

currency

stringrequired

Код валюты

minorUnits

integerrequired

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

description

stringrequired

Период начисления кэшбэка

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

1{
2  "cashbackAccount": {
3    "accountNumber": "1419602531731418",
4    "typeDescription": "Лояльность X5 Карты",
5    "typeId": "205",
6    "balanceAmount": {
7      "value": 100,
8      "currency": "RUR",
9      "minorUnits": 100
10    }
11  },
12  "cashbackForecast": {
13    "totalActivePeriodAmount": {
14      "amount": {
15        "value": 100,
16        "currency": "RUR",
17        "minorUnits": 100
18      },
19      "payOutDate": "2022-02-02"
20    },
21    "totalIntermediatePeriodAmount": {
22      "amount": {
23        "value": 100,
24        "currency": "RUR",
25        "minorUnits": 100
26      },
27      "payOutDate": "2022-02-02"
28    }
29  },
30  "cashbackStatistic": {
31    "payments": [
32      {
33        "period": "Июнь 2022",
34        "status": "PAST",
35        "amount": {
36          "value": 100,
37          "currency": "RUR",
38          "minorUnits": 100
39        }
40      }
41    ]
42  },
43  "overallCashback": {
44    "amount": {
45      "value": 100,
46      "currency": "RUR",
47      "minorUnits": 100
48    },
49    "description": "кэшбэк за всё время"
50  }
51}

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}

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