B2C

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

Пром GET https://baas.alfabank.ru/api/pp/v1/operations

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

Scope

operations-history

Описание

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

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

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

application/json

Authorization
stringrequired

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

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

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

dateTo
stringoptional

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

accounts
array of stringoptional

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

cards
array of stringoptional

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

operationDirection
stringoptional

Направление движения денежных средств. Принимает возможные значения: INCOME - приход/пополнение; EXPENSE - расход/списание

offset
integeroptional

Параметр пагинации - Смещение от начала

limit
integeroptional

Параметр пагинации - Запрашиваемое кол-во элементов на странице

Пример запроса
curl -X GET https://baas.alfabank.ru/api/pp/v1/operations?dateFrom=2018-03-15&dateTo=2018-03-16&accounts=11112222333344445555&cards=1111222233334444&operationDirection=EXPENSE&offset=0&limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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

Пример ответа 200 (ОК)
{
  "operations": [
    {
      "id": "1220117MOCOIBSR 04461",
      "dateTime": "2022-01-17T14:47:49.65Z",
      "title": "МТС 9166666666",
      "amount": {
        "value": 100,
        "currency": "RUR",
        "minorUnits": 100
      },
      "comment": "Перевод за услуги IPTV",
      "mcc": "4899",
      "category": {
        "id": "00012",
        "name": "Телефон, интернет, ТВ"
      },
      "direction": "EXPENSE",
      "loyalty": {
        "title": "Компенсация за плату услуг Альфа картой",
        "percent": 10,
        "amount": {
          "value": 100,
          "currency": "RUR",
          "minorUnits": 100
        }
      },
      "status": "SUCCESS",
      "type": "A01",
      "terminal": {
        "number": "123456789",
        "name": "МТС online",
        "city": "Moscow",
        "countryCode": "RU"
      },
      "sender": {
        "name": "Сидоров Сидор Сидорович",
        "accountNumber": "40817810810210032401",
        "bankBik": "044525593",
        "bankName": "Альфа Банк",
        "phoneNumber": 79201112222,
        "maskedCardNumber": "1111XXXXXXXX2222"
      },
      "recipient": {
        "name": "МТС",
        "bankBik": "044525500",
        "bankName": "ООО МТС Банк",
        "phoneNumber": 12223334455
      },
      "fee": 50,
      "isAnotherClient": false,
      "cashout": false
    },
    {
      "id": "1220618MOCOIBSR 00789",
      "dateTime": "2022-03-18T18:03:02.681Z",
      "title": "123123",
      "amount": {
        "value": 100,
        "currency": "RUR",
        "minorUnits": 100
      },
      "direction": "EXPENSE",
      "fee": 0,
      "isAnotherClient": false,
      "cashout": false,
      "comment": null,
      "mcc": null,
      "category": {
        "id": "00012",
        "name": "Телефон, интернет, ТВ"
      },
      "loyalty": null,
      "status": "SUCCESS",
      "type": "A01",
      "terminal": {
        "number": "-1",
        "name": null,
        "city": null,
        "countryCode": null
      },
      "sender": {
        "name": null,
        "accountNumber": "40817810310210282379",
        "bankBik": null,
        "bankName": null,
        "phoneNumber": null,
        "maskedCardNumber": null
      },
      "recipient": {
        "name": "билайн",
        "bankBik": null,
        "bankName": null,
        "phoneNumber": null
      },
      "reference": "CRD_1SUBUR"
    }
  ]
}
array of objectrequired

Массив операций

id
stringrequired

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

dateTime
stringrequired

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

title
stringrequired

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

Objectrequired

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

value
integerrequired

Значение

currency
stringrequired

Код валюты

minorUnits
integerrequired

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

direction
stringrequired

Направление движения денежных средств. Принимает возможные значения: INCOME - приход/пополнение; EXPENSE - расход/списание

fee
numberrequired

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

isAnotherClient
booleanrequired

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

cashout
booleanrequired

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

comment
stringoptional

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

mcc
stringoptional

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

Objectoptional

Объект программы лояльности

id
stringrequired

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

name
stringrequired

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

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

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

reference
stringoptional

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

Пример ответа 200 (ОК)
{
  "operations": [
    {
      "id": "1220117MOCOIBSR 04461",
      "dateTime": "2022-01-17T14:47:49.65Z",
      "title": "МТС 9166666666",
      "amount": {
        "value": 100,
        "currency": "RUR",
        "minorUnits": 100
      },
      "comment": "Перевод за услуги IPTV",
      "mcc": "4899",
      "category": {
        "id": "00012",
        "name": "Телефон, интернет, ТВ"
      },
      "direction": "EXPENSE",
      "loyalty": {
        "title": "Компенсация за плату услуг Альфа картой",
        "percent": 10,
        "amount": {
          "value": 100,
          "currency": "RUR",
          "minorUnits": 100
        }
      },
      "status": "SUCCESS",
      "type": "A01",
      "terminal": {
        "number": "123456789",
        "name": "МТС online",
        "city": "Moscow",
        "countryCode": "RU"
      },
      "sender": {
        "name": "Сидоров Сидор Сидорович",
        "accountNumber": "40817810810210032401",
        "bankBik": "044525593",
        "bankName": "Альфа Банк",
        "phoneNumber": 79201112222,
        "maskedCardNumber": "1111XXXXXXXX2222"
      },
      "recipient": {
        "name": "МТС",
        "bankBik": "044525500",
        "bankName": "ООО МТС Банк",
        "phoneNumber": 12223334455
      },
      "fee": 50,
      "isAnotherClient": false,
      "cashout": false
    },
    {
      "id": "1220618MOCOIBSR 00789",
      "dateTime": "2022-03-18T18:03:02.681Z",
      "title": "123123",
      "amount": {
        "value": 100,
        "currency": "RUR",
        "minorUnits": 100
      },
      "direction": "EXPENSE",
      "fee": 0,
      "isAnotherClient": false,
      "cashout": false,
      "comment": null,
      "mcc": null,
      "category": {
        "id": "00012",
        "name": "Телефон, интернет, ТВ"
      },
      "loyalty": null,
      "status": "SUCCESS",
      "type": "A01",
      "terminal": {
        "number": "-1",
        "name": null,
        "city": null,
        "countryCode": null
      },
      "sender": {
        "name": null,
        "accountNumber": "40817810310210282379",
        "bankBik": null,
        "bankName": null,
        "phoneNumber": null,
        "maskedCardNumber": null
      },
      "recipient": {
        "name": "билайн",
        "bankBik": null,
        "bankName": null,
        "phoneNumber": null
      },
      "reference": "CRD_1SUBUR"
    }
  ]
}
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_route",
  "error_description": "Route 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"
}
Нет тела ответа

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