B2C

Получение истории операций

Песочница
GET https://sandbox.alfabank.ru/api/pp/v1/operations
Пром
GET https://baas.alfabank.ru/api/pp/v1/operations
Scope

operations-history

Описание

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

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

QUERY
Атрибут
Описание
dateFrom
stringoptional

Дата начала запроса истории операций (включительно) в формате YYYY-MM-DD

dateTo
stringoptional

Дата окончания запроса истории операций (включительно) в формате YYYY-MM-DD

accounts
arrayoptional

Массив номеров счетов для выборки истории операций

cards
arrayoptional

Массив идентификаторов пластиковых карт для выборки истории операций

operationDirection
stringoptional

Направление движения денежных средств. Возможные значения:

  • INCOME - приход/пополнение;
  • EXPENSE - расход/списание
offset
integeroptional

Количество объектов в списке, которые необходимо пропустить

limit
integeroptional

Количество объектов на странице

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/pp/v1/operations?dateFrom={dateFrom}&dateTo={dateTo}&accounts={accounts}&cards={cards}&operationDirection={operationDirection}&offset={offset}&limit={limit}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "operations": [
3    {
4      "id": "1220117MOCOIBSR 04461",
5      "dateTime": "2022-01-17T14:47:49.65Z",
6      "title": "МТС 9166666666",
7      "amount": {
8        "value": 100,
9        "currency": "RUR",
10        "minorUnits": 100
11      },
12      "comment": "Перевод за услуги IPTV",
13      "mcc": "4899",
14      "category": {
15        "id": "00012",
16        "name": "Телефон, интернет, ТВ"
17      },
18      "direction": "EXPENSE",
19      "loyalty": {
20        "title": "Компенсация за плату услуг Альфа картой",
21        "percent": 10,
22        "amount": {
23          "value": 100,
24          "currency": "RUR",
25          "minorUnits": 100
26        }
27      },
28      "status": "SUCCESS",
29      "type": "A01",
30      "terminal": {
31        "number": "123456789",
32        "name": "МТС online",
33        "city": "Moscow",
34        "countryCode": "RU"
35      },
36      "sender": {
37        "name": "Сидоров Сидор Сидорович",
38        "accountNumber": "40817810810210032401",
39        "bankBik": "044525593",
40        "bankName": "Альфа Банк",
41        "phoneNumber": 79201112222,
42        "maskedCardNumber": "1111XXXXXXXX2222"
43      },
44      "recipient": {
45        "name": "МТС",
46        "bankBik": "044525500",
47        "bankName": "ООО МТС Банк",
48        "phoneNumber": 12223334455
49      },
50      "fee": 50,
51      "isAnotherClient": false,
52      "cashout": false
53    }
54  ]
55}
BODY
атрибут
описание
array of objectsrequired

Список операций

id
stringrequired

Идентификатор операции

dateTime
stringrequired

Дата и время операции

title
stringrequired

Заголовок операции

objectrequired

Сумма операции

value
integerrequired

Значение

currency
stringrequired

Код валюты

minorUnits
integerrequired

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

comment
stringoptional

Комментарий к операции

mcc
stringoptional

MCC-код операции

objectoptional

Категория программы лояльности

id
stringrequired

Идентификатор категории

name
stringrequired

Наименование категории

direction
stringrequired

Направление движения денежных средств. Возможные значения:

  • INCOME - приход/пополнение;
  • EXPENSE - расход/списание
objectoptional

Программа лояльности

title
stringoptional

Заголовок бонусной программы или программы лояльности

percent
numberoptional

Процент от суммы

objectoptional

Сумма по программе

value
integerrequired

Значение

currency
stringrequired

Код валюты

minorUnits
integerrequired

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

status
stringoptional

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

  • null - входящая операция или статус не определён;
  • SUCCESS - операция выполнена успешно;
  • HOLD - операция в обработке;
  • FAILED - операция не выполнена
type
stringoptional

Тип операции

objectoptional

Терминал точки продаж

number
stringoptional

Номер терминала точки продаж

name
stringoptional

Имя точки продаж

city
stringoptional

Город точки продаж (код)

countryCode
stringoptional

Страна точки продаж (код)

objectoptional

Отправитель перевода

name
stringoptional

Отправитель перевода

accountNumber
stringoptional

Номер счёта отправителя перевода / клиента

bankBik
stringoptional

БИК банка отправителя

bankName
stringoptional

Название банка отправителя

phoneNumber
stringoptional

Номер телефона отправителя

maskedCardNumber
stringoptional

Номер карты (маскированный) отправителя

objectoptional

Получатель перевода

name
stringoptional

Получатель перевода

bankBik
stringoptional

БИК банка получателя

bankName
stringoptional

Название банка получателя

phoneNumber
stringoptional

Номер телефона получателя

fee
numberrequired

Комиссия по операции

reference
stringoptional

Идентификатор операции из EQ

isAnotherClient
booleanrequired

Признак того, что операция выполнена другим клиентом

cashout
booleanrequired

Признак снятия наличности в банкомате

Пример ответа 200 (OK)
1{
2  "operations": [
3    {
4      "id": "1220117MOCOIBSR 04461",
5      "dateTime": "2022-01-17T14:47:49.65Z",
6      "title": "МТС 9166666666",
7      "amount": {
8        "value": 100,
9        "currency": "RUR",
10        "minorUnits": 100
11      },
12      "comment": "Перевод за услуги IPTV",
13      "mcc": "4899",
14      "category": {
15        "id": "00012",
16        "name": "Телефон, интернет, ТВ"
17      },
18      "direction": "EXPENSE",
19      "loyalty": {
20        "title": "Компенсация за плату услуг Альфа картой",
21        "percent": 10,
22        "amount": {
23          "value": 100,
24          "currency": "RUR",
25          "minorUnits": 100
26        }
27      },
28      "status": "SUCCESS",
29      "type": "A01",
30      "terminal": {
31        "number": "123456789",
32        "name": "МТС online",
33        "city": "Moscow",
34        "countryCode": "RU"
35      },
36      "sender": {
37        "name": "Сидоров Сидор Сидорович",
38        "accountNumber": "40817810810210032401",
39        "bankBik": "044525593",
40        "bankName": "Альфа Банк",
41        "phoneNumber": 79201112222,
42        "maskedCardNumber": "1111XXXXXXXX2222"
43      },
44      "recipient": {
45        "name": "МТС",
46        "bankBik": "044525500",
47        "bankName": "ООО МТС Банк",
48        "phoneNumber": 12223334455
49      },
50      "fee": 50,
51      "isAnotherClient": false,
52      "cashout": false
53    }
54  ]
55}
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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам
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}
Нет тела ответа