Основные сценарии использования

API позволяет скачивать выписки в форматах:

  • PDF
  • PDF с приложениями
  • PDF только приложения
  • Интервальные выписки в формате Excel

В формате PDF имеется возможность скачать единичную выписку (по одному счету за один день) или несколько сразу. В том числе, есть возможность настроить параметры формируемых файлов (группировку выписок в один файл).

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

Примечание: для запросов выписок необходимо сформировать корректный ключ.

Описание ключа

Для формата PDF

Для получения выписок в формате PDF необходимо сформировать и передать в запросе statementKey.

statementKey это составное значение в формате "(номер счета):(cnum):(дата выписки в формате yyyyMMdd)".

Пример ключа: 40700000000001000000:Z59280:20211124.

Для формата Excel

Для получения выписок в формате Excel необходимо сформировать и передать в запросе accountKey.

accountKey это составное значение в формате "(номер счета):(cnum)".

Пример ключа: 40700000000001000000:Z59280.

Скачивание итоговой или внутридневной выписки в формате PDF

Метод поддерживает следующие request параметры:

detail(обязательный параметр):

  • значение "with" позволяет скачать выписки с приложениями,
  • значение "without" позволяет скачать выписки без приложений,
  • значение "only" позволяет скачать только приложения, без выписок.

separate:

  • значение "true" позволяет скачать выписки, разделенные на отдельные PDF файлы в форме zip архива (при запросе одной выписки будет получен PDF файл),
  • значение (по умолчанию) "false" позволяет скачать выписки, объединенные в один общий PDF файл.

filename:

  • значение позволяет задать имя скачиваемому файлу,
  • значение (по умолчанию) - имя в виде даты получения файла, формата "export_to_pdf_yyyy-MM-dd_HH-mm-ss".

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

curl --location --request POST \
https://api.openapi.raiffeisen.ru/products/statements-service/statements/report/query \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--header 'ID-Token: {id_token}' \
--data-raw '{
  "statementKey": [
    "40700000000001000000:Z59280:20211124"
  ],
  "detail": "without",
  "filename": "statementTest_1"
}'

Описание запроса:

Запрос состоит из одного ключа "statementKey"-..., параметры: "detail" - "without"(выписка без приложений), "separate"(не применим, в случае скачивания одной выписки всегда возвращается PDF файл), "filename" - "statementTest_1" (файл будет с соответствующим наименованием).

Пример ответа:

Файл: statementTest_1.pdf.

Содержание файла: выписка_1.

Скачивание нескольких выписок в формате PDF

Примечание: несколько выписок можно скачать удобным способом:

  • одним PDF файлом
  • архивом с несколькими PDF файлами разделенными по каждой выписке отдельно

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

curl --location --request POST \
https://api.openapi.raiffeisen.ru/products/statements-service/statements/report/query \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--header 'ID-Token: {id_token}' \
--data-raw '{
  "statementKey": [
    "40700000000001000000:Z59280:20211124",
    "40700010000000000000:Z59280:20211124"
  ],
  "detail": "with",
  "separate": "true"
}'

Описание запроса:

Запрос состоит из двух ключей "statementKey"-..., параметры: "detail" - "with"(выписки с приложениями), "separate" - "true"(разделен на отдельные PDF файлы и будет скачан в форме архива), "filename"(отсутсвует, будет использовано наименование по умолчанию).

Пример ответа:

Файл: export_to_pdf_2021-11-24_13-43-34.zip.

Содержание файла export_to_pdf_2021-11-24_13-43-34.zip - file_1.pdf, file_2.pdf.

Содержание файла file_1.pdf - выписка_1, приложение_1,...приложение_n.

Содержание файла file_2.pdf - выписка_2, приложение_1,...приложение_n.

Скачивание интервальной итоговой выписки по одному счету в формате Excel

Для скачивания интервальной итоговой выписки по одному счету необходимо сформировать запрос метода /v2.0/statements/excel-interval/query со следующими параметрами:

ПараметрОписание
accountKeyКлюч выписки, которую требуется скачать
intradayПризнак внутридневной выписки. Для итоговой выписки необходимо указать false
fromНачало периода, за которые требуется скачать выписку.
Формат: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Начало периода должно начинаться с 00:00:00 задаваемого дня.
В качестве таймзоны необходимо указывать Москву (+03:00)
Пример: 2022-06-01T00:00:00+03:00
toОкончание периода, за которые требуется скачать выписку.
Формат: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Окончание периода должно заканчиваться с 23:59:59 задаваемого дня.
В качестве таймзоны необходимо указывать Москву (+03:00)
Пример: 2022-06-01T23:59:59+03:00
filenameНачало наименования файла с выпиской, который будет сформирован
Наименование файла поддерживает: латинские и кириллические буквы, цифры, дефис, символ подчеркивания. Максимальная длина - 50 символов.
По умолчанию наименование файла формируется по маске: kl_to_excel_{Номер счета}
sortПараметры сортировки
sort.fieldНазвание колонки, по которой будет выполнена сортировка (доступны debet и credit)
sort.descПризнак обратного направления сортировки (true - обратное, false - прямое)

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

curl --location --request POST \
https://api.openapi.raiffeisen.ru/products/statements-service/v2.0/statements/excel-interval/query' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--header 'ID-Token: {id_token}' \
--data-raw '{
  "accountKey": [
      "40700000000001000000:Z59280"
  ],
  "intraday": false,
  "from": "2022-06-01T00:00:00+03:00",
  "to": "2022-06-01T23:59:59+03:00",
  "filename": "Итоговая выписка",
  "sort": [
      {
          "field": "debet",
          "desc": true
      },
      {
          "field": "credit",
          "desc": false
      }
  ]
}'

Примечание: Начальный и конечный остаток будет расчитаны на начало и окончание, заданного в запросе, периода соответсвенно. В случае необходимости получение остатков на каждый день периода, необходимо сформировать отдельные запросы, по каждому из дней.

Скачивание интервальных итоговых выписки по нескольким счетам в формате Excel

Для скачивания интервальной итоговой выписки по нескольким счетам необходимо сформировать запрос метода /v2.0/statements/excel-interval/query со следующими параметрами:

ПараметрОписание
accountKeyСписок ключей выписки, которую требуется скачать
intradayПризнак внутридневной выписки. Для итоговой выписки необходимо указать false
fromНачало периода, за которые требуется скачать выписку.
Формат: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Начало периода должно начинаться с 00:00:00 задаваемого дня.
В качестве таймзоны необходимо указывать Москву (+03:00)
Пример: 2022-06-01T00:00:00+03:00
toОкончание периода, за которые требуется скачать выписку.
Формат: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
Окончание периода должно заканчиваться с 23:59:59 задаваемого дня.
В качестве таймзоны необходимо указывать Москву (+03:00)
Пример: 2022-06-30T23:59:59+03:00
filenameНачало наименований файлов с выписками, которые будут сформированы и помещены в архив для скачивания
Наименование файла поддерживает: латинские и кириллические буквы, цифры, дефис, символ подчеркивания. Максимальная длина - 50 символов.
По умолчанию наименование файла формируется по маске: kl_to_excel_{Номер счета}
sortПараметры сортировки
sort.fieldНазвание колонки, по которой будет выполнена сортировка (доступны debet и credit)
sort.descПризнак обратного направления сортировки (true - обратное, false - прямое)

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

curl --location --request POST \
https://api.openapi.raiffeisen.ru/products/statements-service/v2.0/statements/excel-interval/query' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--header 'ID-Token: {id_token}' \
--data-raw '{
  "accountKey": [
      "40700000000001000001:Z59280",
      "40700000000001000002:Z59280",
      "40700000000001000003:Z59280",
      "40700000000001000004:Z59280"
  ],
  "intraday": false,
  "from": "2022-06-01T00:00:00+03:00",
  "to": "2022-06-30T23:59:59+03:00",
  "filename": "Итоговая выписка",
  "sort": [
      {
          "field": "debet",
          "desc": true
      },
      {
          "field": "credit",
          "desc": false
      }
  ]
}'

Примечание: Начальный и конечный остаток будет расчитаны на начало и окончание, заданного в запросе, периода соответсвенно. В случае необходимости получение остатков на каждый день периода, необходимо сформировать отдельные запросы, по каждому из дней.

Скачивание интервальной внутредневной выписки по одному счету в формате Excel

Для скачивания интервальной внутридневной выписки по одному счету необходимо сформировать запрос метода /v2.0/statements/excel-interval/query с параметрами, аналогичными сценарию "Скачивание интервальной итоговой выписки по одному счету в формате Excel", изменив при этом параметр intraday на значени true.

Внутридневные данные возвращаются только за текущий день. В случае если в запросе задается период, который включает в себя предыдущие дни, то сформируется файл, содержащий итоговые данные за закрытые периоды + внутридневные данные за текущий день.

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

curl --location --request POST \
https://api.openapi.raiffeisen.ru/products/statements-service/v2.0/statements/excel-interval/query' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--header 'ID-Token: {id_token}' \
--data-raw '{
  "accountKey": [
      "40700000000001000000:Z59280"
  ],
  "intraday": true,
  "from": "2022-06-01T00:00:00+03:00",
  "to": "2022-06-01T23:59:59+03:00",
  "filename": "Внутридневная выписка",
  "sort": [
      {
          "field": "debet",
          "desc": true
      },
      {
          "field": "credit",
          "desc": false
      }
  ]
}'

Примечание: Начальный и конечный остаток будет расчитаны на начало и окончание, заданного в запросе, периода соответсвенно. В случае необходимости получение остатков на каждый день периода, необходимо сформировать отдельные запросы, по каждому из дней.

Скачивание интервальной внутредневной выписки по нескольким счетам в формате Excel

Для скачивания интервальной внутридневной выписки по нескольким счетам необходимо сформировать запрос метода /v2.0/statements/excel-interval/query с параметрами, аналогичными сценарию "Скачивание интервальных итоговых выписки по нескольким счетам в формате Excel", изменив при этом параметр intraday на значение true.

Внутридневные данные возвращаются только за текущий день. В случае если в запросе задается период, который включает в себя предыдущие дни, то сформируется файл, содержащий итоговые данные за закрытые периоды + внутридневные данные за текущий день.

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

curl --location --request POST \
https://api.openapi.raiffeisen.ru/products/statements-service/v2.0/statements/excel-interval/query' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--header 'ID-Token: {id_token}' \
--data-raw '{
  "accountKey": [
      "40700000000001000001:Z59280",
      "40700000000001000002:Z59280",
      "40700000000001000003:Z59280",
      "40700000000001000004:Z59280"
  ],
  "intraday": true,
  "from": "2022-06-01T00:00:00+03:00",
  "to": "2022-06-30T23:59:59+03:00",
  "filename": "Внутридневная выписка",
  "sort": [
      {
          "field": "debet",
          "desc": true
      },
      {
          "field": "credit",
          "desc": false
      }
  ]
}'

Примечание: Начальный и конечный остаток будет расчитаны на начало и окончание, заданного в запросе, периода соответсвенно. В случае необходимости получение остатков на каждый день периода, необходимо сформировать отдельные запросы, по каждому из дней.