Revision as of 17:07, 20 February 2024

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.

Property name	Property type	Limitations and constraints	Description
Year	int	Required	The statement year.
Month	int	Required	The statement month.
Day	int	Optional	The statement day. If specified, the system will serve a daily statement file.
Currency	string	Required Required length: 3 characters Accepted values: "CZK" (Czech crown) "EUR" (Euro) "HUF" (Hungarian forint) "USD" (U.S. dollar)	The currency of the statement's account. Accounts with separate currencies have separate statement files.

Data columns in the statement returned by the endpoint
Transaction time	locale-specific date and time of the transaction
Transaction type	The type of the transaction.
Customer/beneficiary	The identifier of the payee, payer, or payment method, as appropriate to the transaction: name, username, email address, or the card scheme and last four digits of the debited or credited card.
Transaction amount
Balance after transaction
Currency
Payment ID generated by shop
Transaction ID generated by shop
Unique payment ID generated by Barion
Unique transaction ID generated by Barion
Order ID generated by shop
Last four digits of the debited or credited bank card, if applicable
Authorization code
Comment associated with transaction

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.

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.

Downloading the daily statement of an EUR account for October 6th 2019:

https://api.barion.com/v2/statement/download?year=2019&month=10&day=6&currency=EUR

Downloading the monthly statement of an HUF account for April 2019:

https://api.barion.com/v2/statement/download?year=2019&month=4&currency=HUF

@@ Line 60: / Line 60: @@
 | Transaction time || locale-specific date and time of the transaction
 |-
-| Transaction type || the type of the transaction
+| Transaction type || [[TransactionType|The type of the transaction]].
 |-
 | Customer/beneficiary || The identifier of the payee, payer, or payment method, as appropriate to the transaction: name, username, email address, or the card scheme and last four digits of the debited or credited card.