Basic use cases
API allows you to download statements in the following formats:
- PDF with attachments
- PDF only attachments
You can download a single statement or several statements at once. In particular, it is possible to configure the parameters of the generated files.
Note: you need to generate a valid key.
Key description
Statement key is a composite value in the format “(account number):(cnum):(statement date in the format yyyyMMdd)”.
Key example: 40700000000001000000:Z59280:20211124.
Downloading the final or intraday statement in PDF format
The method supports the following request parameters:
detail(mandatory parameter):
- “with” value allows you to download statements with attachments,
- “without” value allows you to download statements without attachments,
- “only” value allows you to download only attachments, without statements.
separate:
- “true” value allows you to download statements divided into separate PDF files in the form of a zip archive (when requesting one statement, a PDF file will be received),
- “false” value (by default) allows you to download statements combined into one common PDF file.
filename:
- the value allows you to set a name for the downloaded file,
- value (by default) - name in the form of the date when the file was received, in the format “export_to_pdf_yyyy-MM-dd_HH-mm-ss”.
Request example:
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"
}'Request description:
The request consists of one key “statementKey”-..., parameters: “detail” - “without” (statement without attachments), “separate”(not applicable, in case of downloading one statement, a PDF file is always returned), “filename” - “statementTest_1” (the file will be named accordingly).
Response example:
File: statementTest_1.pdf.
File content: выписка_1.
Downloading several statements in PDF format
Note: several statements can be downloaded in a convenient way:
- in one PDF file
- in an archive with several PDF files divided for each statement separately
Request example:
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"
}'Request description:
The request consists of two keys “statementKey”-..., parameters: “detail” - “with” (statements with attachments), “separate” - “true” (divided into separate PDF files and will be downloaded as an archive), “filename” (none, the name will be used by default).
Response example:
File: export_to_pdf_2021-11-24_13-43-34.zip.
Content of the file export_to_pdf_2021-11-24_13-43-34.zip - file_1.pdf, file_2.pdf.
Content of the file file_1.pdf - extract_1, attachement_1,...attachement_n.
Content of the file file_2.pdf - extract_2, application_1,...application_n.