Получение истории начисления баллов лояльности

Песочница

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

Пром

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

Scope

loyalty

Описание

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

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

stringrequired

application/json

Content-Type

stringrequired

application/json

BODY

Атрибут

Описание

references

array of stringsrequired

Массив референсов транзакций

startDate

stringrequired

Дата начала в формате YYYY-MM-DD

endDate

stringrequired

Дата окончания в формате YYYY-MM-DD

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

Язык

1curl --location 'https://baas.alfabank.ru/api/pp/v1/bonus-account-transactions' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "references": [
7    "references",
8    "references"
9  ],
10  "endDate": "2000-01-23",
11  "startDate": "2000-01-23"
12}'

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

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

1{
2  "transactions": [
3    {
4      "title": "Покупка мороженого",
5      "account": "****1234",
6      "reference": "ref1",
7      "cashbackPercent": 10,
8      "cashbackAmount": {
9        "value": 500,
10        "currency": "RUB",
11        "minorUnits": 100
12      }
13    }
14  ]
15}

BODY

атрибут

описание

array of objectsrequired

Список транзакций

title

stringrequired

Наименование операции

account

stringrequired

Номер счёта

reference

stringoptional

Референс (идентификатор) операции

cashbackPercent

numberoptional

Процент кэшбэка

objectrequired

Сумма бонуса

value

integerrequired

Значение

currency

stringrequired

Код валюты

minorUnits

integerrequired

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

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

1{
2  "transactions": [
3    {
4      "title": "Покупка мороженого",
5      "account": "****1234",
6      "reference": "ref1",
7      "cashbackPercent": 10,
8      "cashbackAmount": {
9        "value": 500,
10        "currency": "RUB",
11        "minorUnits": 100
12      }
13    }
14  ]
15}

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}

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