B2C

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

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

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

Scope

loyalty

Описание

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

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

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

application/json

Authorization
stringrequired

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

Content-Type
stringrequired

application/json

BODY
Атрибут
Описание
references
array of stringrequired

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

startDate
stringrequired

Дата начала в формате yyyy-MM-dd

endDate
stringrequired

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

Пример запроса
curl -X POST https://baas.alfabank.ru/api/pp/v1/bonus-accounts-transactions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}' \
  -H 'Content-Type: application/json' \
  -d '{
      "references": [
        "ref1"
      ],
	  "startDate": "2020-01-01",
      "endDate": "2020-01-05"
    }'

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

Пример ответа 200 (ОК)
{
  "transactions": [
    {
      "title": "Операция 1",
	  "account": "****1234",
	  "reference": "ref1",
	  "cashbackPercent": 10,
      "cashbackAmount": {
        "value": 500,
        "currency": "RUB",
        "minorUnits": 100
      },
    },
    {
      "title": "Операция 2",
	  "account": "****1234",
	  "reference": "ref2",
	  "cashbackPercent": 10,
      "cashbackAmount": {
        "value": 500,
        "currency": "RUB",
        "minorUnits": 100
      },
    },
    {
      "title": "Операция 3",
	  "account": "****1234",
	  "reference": "ref3",
	  "cashbackPercent": 10,
      "cashbackAmount": {
        "value": 500,
        "currency": "RUB",
        "minorUnits": 100
      },
    }
  ]
}
array of objectrequired

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

title
stringrequired

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

account
stringrequired

Номер счёта

reference
stringoptional

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

cashbackPercent
numberoptional

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

objectrequired

Сумма бонуса

value
integerrequired

Значение

currency
stringrequired

Код валюты

minorUnits
integerrequired

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

Пример ответа 200 (ОК)
{
  "transactions": [
    {
      "title": "Операция 1",
	  "account": "****1234",
	  "reference": "ref1",
	  "cashbackPercent": 10,
      "cashbackAmount": {
        "value": 500,
        "currency": "RUB",
        "minorUnits": 100
      },
    },
    {
      "title": "Операция 2",
	  "account": "****1234",
	  "reference": "ref2",
	  "cashbackPercent": 10,
      "cashbackAmount": {
        "value": 500,
        "currency": "RUB",
        "minorUnits": 100
      },
    },
    {
      "title": "Операция 3",
	  "account": "****1234",
	  "reference": "ref3",
	  "cashbackPercent": 10,
      "cashbackAmount": {
        "value": 500,
        "currency": "RUB",
        "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"
}
Нет тела ответа

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