Basic use cases

The API allows you to export statements in XML format. You can export one statement (for one account per day) or several at once.

Note: To request statements, you need to generate a valid key.

Key description

To export a statement in XML format, you must generate and pass in the query statementKey.

statementKey is a compound value in the format "(account number):(cnum):(date of the statement in the format yyyyMMdd)".

Example of a key: 40700000000001000000:Z59280:20211124.

If you do not know the CNUM of your organization, you can get it using API Organizations (Organization data). Detailed API description in the Company Data section.

Export a final or intraday statement in XML format

If the statementKey contains the current date, the response will return an intraday statement. If the date is different from the current date and a final statement is generated for the specified date, the response will return the summary statement.

The method supports the following request parameters:

filename:

The value allows you to name the downloaded file. The default value is the name as the account number and date of receipt of the file, example: "xml_40702810000000000000_dd-mm-yyyy_hh-mm-ss".

sort:

The value allows you to set the direction of sorting operations:

  • "field": "debet" - by Debet field (outcoming transaction amount)
  • "field": "credit" - by Credit field (incoming transaction amount)
  • "desc": true - descending
  • "desc": false - ascending

These parameters are optional.

Request example:

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
    }
  ]
}'

Request description:

The request consists of one key "statementKey" - one statement will be received, parameters: "filename" - "example" the file will be appropriately named, sorting of outgoing operations in descending order, incoming in ascending order.

Responce example:

File: example.xml

Export multiple statements in XML format

To export multiple statements in XML format, you need to specify several statementKey in the query

Request example:

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
    }
  ]
}'

Request description:

The query consists of two keys "statementKey" - two statements will be received, parameters: "filename" - "example" the file will be appropriately named, sorting outgoing transactions in descending order, incoming in ascending order.

Responce example:

File: example.xml