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

API позволяет экспортировать выписки в формате XML. Можно экспортировать одну выписку (по одному счету за один день) или несколько сразу.

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

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

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

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

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

Если вам неизвестен CNUM вашей организации, получить его можно с помощью API Organizations (Данные организации). Подробное описание API в разделе Даннные компании.

Экспорт итоговой или внутридневной выписки в формате XML

Если в statementKey указана текущая дата, в ответе вернется внутридневная выписка. Если дата отличается от текущей и за указанную дату сформирована итоговая выписка, в ответе вернется итоговая выписка.

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

filename:

Значение позволяет задать имя скачиваемому файлу. Значение по умолчанию - имя в виде номера счета и даты получения файла, формата "xml_40702810000000000000_dd-mm-yyyy_hh-mm-ss".

sort:

Значение позволяет задать направление сортировки операций:

• "field": "debet" - по полю Дебет (сумма исходящей операции)
• "field": "credit" - по полю Кредит (сумма входящей операции)
• "desc": true - по убыванию
• "desc": false - по возрастанию.

Указанные параметры необязательны.

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

curl --location --request POST \
https://api.openapi.raiffeisen.ru/products/statements-service/statements/xml/query \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--header 'ID-Token: {id_token}' \
--data-raw '{
  "statementKey": [
    "40700000000001000000:Z00000:20211124"
  ],
  "filename": "example",
  "sort": [
    {
      "field": "debet",
      "desc": true
    },
    {
      "field": "credit",
      "desc": false
    }
  ]
}'

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

Запрос состоит из одного ключа "statementKey"- будет получена одна выписка, параметры: "filename" - "example" файл будет с соответствующим наименованием, сортировка исходящих операций по убыванию, входящих по возрастанию.

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

Файл: example.xml

Экспорт нескольких выписок в формате XML

Для экспорта нескольких выписок в формате XML нужно указать в запросе несколько statementKey

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

curl --location --request POST \
https://api.openapi.raiffeisen.ru/products/statements-service/statements/xml/query \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--header 'ID-Token: {id_token}' \
--data-raw '{
  "statementKey": [
    "40702810000001000000:Z59280:20211124",
    "40702810000000000000:Z59280:20211123"
  ],
  "filename": "example",
  "sort": [
    {
      "field": "debet",
      "desc": true
    },
    {
      "field": "credit",
      "desc": false
    }
  ]
}'

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

Запрос состоит из двух ключей "statementKey"- будет получено две выписки, параметры: "filename" - "example" файл будет с соответствующим наименованием, сортировка исходящих операций по убыванию, входящих по возрастанию.

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

Файл: example.xml