Пром GET https://baas.alfabank.ru/api/pp/v1/bonus-accounts/{accountNumber}
Песочница GET https://sandbox.alfabank.ru/api/pp/v1/bonus-accounts/{accountNumber}
Scope
loyalty
Описание
В рамках вызова данного метода клиент получает информацию о начислениях по конкретному бонусному счёту, в частности:
- •кэшбэк за текущий период;
- •прогноз начисления кэшбэка на следующий расчётный период;
- •график начислений кэшбэка;
- •общую сумму начисленного кэшбэка за всё время.
Параметры запроса
application/json
Bearer {access_token}, полученный по Authorization Code Flow
curl -X GET https://baas.alfabank.ru/api/pp/v1/bonus-accounts/1209602531731417 \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
Параметры ответа
{
"cashbackAccount": {
"accountNumber": "1209602531731417",
"typeId": "140",
"typeDescription": "Банковский кешбэк",
"balanceAmount": null
},
"cashbackForecast": {
"totalActivePeriodAmount": {
"amount": {
"value": 0,
"currency": "PEREKRESTOK",
"minorUnits": 100
},
"payOutDate": "2021-08-10"
},
"totalIntermediatePeriodAmount": {
"amount": {
"value": 61260,
"currency": "PEREKRESTOK",
"minorUnits": 100
},
"payOutDate": "2021-07-10"
}
},
"cashbackStatistic": {
"payments": [
{
"period": "082020",
"status": "PAST",
"amount": {
"value": 2009000,
"currency": "PEREKRESTOK",
"minorUnits": 100
}
}
]
},
"overallCashback": {
"amount": {
"value": 1000000,
"currency": "PEREKRESTOK",
"minorUnits": 100
},
"description": "Баллы за всё время"
}
}
Номер бонусного счёта
Идентификатор типа бонусного счёта
Наименование/описание типа бонусного счёта
Значение
Код валюты
Минорные единицы
Значение
Код валюты
Минорные единицы
Дата начисления кешбэка
Значение
Код валюты
Минорные единицы
Дата начисления кешбэка
Месяц и год периода в формате MMYYYY
Статус периода начисления. Принимает возможные значения: PAST - для предыдущих месяцев; PRESENT - для текущего месяца
Значение
Код валюты
Минорные единицы
Значение
Код валюты
Минорные единицы
Период начисления кешбэка
{
"cashbackAccount": {
"accountNumber": "1209602531731417",
"typeId": "140",
"typeDescription": "Банковский кешбэк",
"balanceAmount": null
},
"cashbackForecast": {
"totalActivePeriodAmount": {
"amount": {
"value": 0,
"currency": "PEREKRESTOK",
"minorUnits": 100
},
"payOutDate": "2021-08-10"
},
"totalIntermediatePeriodAmount": {
"amount": {
"value": 61260,
"currency": "PEREKRESTOK",
"minorUnits": 100
},
"payOutDate": "2021-07-10"
}
},
"cashbackStatistic": {
"payments": [
{
"period": "082020",
"status": "PAST",
"amount": {
"value": 2009000,
"currency": "PEREKRESTOK",
"minorUnits": 100
}
}
]
},
"overallCashback": {
"amount": {
"value": 1000000,
"currency": "PEREKRESTOK",
"minorUnits": 100
},
"description": "Баллы за всё время"
}
}
Код ошибки. Принимает возможные значения: invalid_request - Неверные входные параметры запроса
Описание ошибки
{
"error": "invalid_request",
"error_description": "Authorization header is not present in request headers"
}
Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
Описание ошибки
{
"error": "invalid_token",
"error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
Код ошибки. Принимает возможные значения: insufficient_scope - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; access_denied - доступ к счету запрещен
Описание ошибки
{
"error": "insufficient_scope",
"error_description": "The request requires higher privileges than provided by the access token"
}
Код ошибки. Принимает возможные значения: unknown_endpoint - Эндпоинт не найден или неактивен
Описание ошибки
{
"error": "unknown_endpoint",
"error_description": "Endpoint is not found or not active"
}
Код ошибки. Принимает возможные значения: internal_error - Внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
{
"error": "internal_error",
"error_description": "Internal server error"
}
Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.