Statement-Download-v2: Difference between revisions
Jump to navigation
Jump to search
(change auth description) |
mNo edit summary |
||
Line 13: | Line 13: | ||
Prerequisites before use: | Prerequisites before use: | ||
* [[Calling_the_API|Calling the Barion API]] | * [[Calling_the_API|Calling the Barion API]] | ||
<span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only. | <span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only. | ||
== Authentication == | |||
[[Barion Wallet Authentication]] | |||
== Input properties == | == Input properties == |
Revision as of 10:53, 15 November 2022
Barion API: Download statement file
GET | /v2/Statement/Download |
---|
The /statement/download
API endpoint is used to download monthly or daily statement files generated by the Barion system.
Prerequisites before use:
v2 This API endpoint is available in API v2 only.
Authentication
Input properties
Property name | Property type | Limitations and constraints | Description |
---|---|---|---|
Year | int |
|
The statement year. |
Month | int |
|
The statement month. |
Day | int |
|
The statement day. If specified, the system will serve a daily statement file. |
Currency | string |
Accepted values:
|
The currency of the statement's account. Accounts with separate currencies have separate statement files. |
Output and response
Depending on the given input parameters the endpoint will produce the following outputs:
- If the caller fails to authenticate, the API will produce an empty output with an
HTTP 401 Unauthorized
status code.
- If only year and month were specified for the statement, the endpoint will try to serve the monthly statement for the corresponding year and month as a PDF (Printable Document Format) document.
- If year, month, and day were specified for the statement, the endpoint will try to serve the daily statement for the corresponding date as a signed XLSX (Microsoft Excel) document.
- If the requested statement file is not available, the API returns an error message with an
HTTP 404 Not found
status code. This can happen if the requested statement file has not been generated yet.
- If generation of the given statement type is disabled for the user, the API returns an error message with an
HTTP 403 Forbidden
status code.
- If the user does not have an account in the specified currency, the API returns an error message with an
HTTP 400 Bad request
status code.
Things to know
- To get daily statement files please contact Barion from the Customer Center in your Barion wallet.
- Daily statement files will not show up on the secure.barion.com site for download. They can only be downloaded via this API endpoint.
- Once the statement files have been generated, they are available to download for an indefinite time.
Examples
Downloading the daily statement of an EUR account for October 6th 2019:
https://api.barion.com/v2/statement/[email protected]&password=my5Tr0ngP4ssW0rd&year=2019&month=10&day=6¤cy=EUR
Downloading the monthly statement of an HUF account for April 2019:
https://api.barion.com/v2/statement/[email protected]&password=my5Tr0ngP4ssW0rd&year=2019&month=4¤cy=HUF