Statement-Download-v2: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
VisualWikitext
No edit summary
m (output columns table review-ready)
Line 41: Line 41:
* Optional
* Optional
|| The statement day. If specified, the system will serve a daily statement file.
|| The statement day. If specified, the system will serve a daily statement file.
Otherwise, a monthly statement is returned.


|-
|-
Line 49: Line 50:
Accepted values:
Accepted values:
{{CurrencyList}}
{{CurrencyList}}
|| The currency of the statement's account. Accounts with separate currencies have separate statement files. 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.
|| The currency of the statement's account. Accounts with separate currencies have separate statement files.  
 
If the user doesn't have an account in the specified currency, the API returns an error message with an HTTP 400 Bad request status code.
|}
|}


== Output ==
== Output ==
Depending on the parameters supplied to the call, the endpoint responds with one of the following outputs:
Depending on whether a day parameter was passed, the endpoint responds with one of the following outputs:


* an .xlsx-format daily statement with an XML digital signature to guarantee data integrity
* if a day parameter was passed, an .xlsx-format daily statement with an XML digital signature (signed by "Barion Payments Zrt", certified by an external issuer) to guarantee data integrity;
* a PDF-format monthly statement if only the year and month parameters were supplied
* if no day parameter was passed, a PDF-format monthly statement.
* If the caller fails to authenticate, the API will produce an empty output with an <code>HTTP 401 Unauthorized</code> status code.
 
* If only '''year''' and '''month''' were specified for the statement, the endpoint will try to serve the <u>monthly statement</u> 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 <u>daily statement</u> 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 <code>HTTP 404 Not found</code> 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 <code>HTTP 403 Forbidden</code> status code.
 
*


{| class="wikitable"
{| class="wikitable"
Line 79: Line 69:
| Transaction type || [[TransactionType|The type of the transaction]]. || This column is also part of the monthly statement.
| Transaction type || [[TransactionType|The type of the transaction]]. || This column is also part of the monthly statement.
|-
|-
| 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. || This column is also part of the monthly statement, as "Sender/Recipient".
| 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.
| This column is also part of the monthly statement, as "Sender/Recipient".
|-
|-
|Transaction amount||The locale-specific-formatted amount of the transaction. Deposits are positive, and withdrawals are negative. || This column is also part of the monthly statement.
|Transaction amount||The locale-specific-formatted amount of the transaction. Deposits are positive, and withdrawals are negative. || This column is also part of the monthly statement.
Line 87: Line 83:
|Currency||The currency of the statement, as specified in the call to the endpoint. || This column is also part of the monthly statement.
|Currency||The currency of the statement, as specified in the call to the endpoint. || This column is also part of the monthly statement.
|-
|-
|Payment ID generated by shop||The identifier of the payment, if applicable, generated by the webshop that requested the payment, if applicable.
|Payment ID generated by shop||The identifier of the payment generated by the webshop that requested the payment, if the entry is a payment and a webshop is involved.
|-
|-
|Transaction ID generated by shop||The identifier of the transaction generated by the webshop associated with it, if applicable.
|Transaction ID generated by shop||The identifier of the transaction generated by the webshop associated with it, if applicable.
Line 97: Line 93:
|Order ID generated by shop||The identifier generated by the webshop associated with the transaction, if applicable, to identify the order that the transaction was part of, if applicable.
|Order ID generated by shop||The identifier generated by the webshop associated with the transaction, if applicable, to identify the order that the transaction was part of, if applicable.
|-
|-
|Card number||Only applies to transactions credited to or debited from a bank card. Last four digits of the debited or credited bank card. || Card numbers are included in the monthly statement in the "Other information" column.
|Card number||Last four digits of the debited or credited bank card.
Only applies to transactions credited to or debited from a bank card.
| Card numbers are included in the monthly statement in the "Other information" column.
|-
|-
|Authorization code||Only applies to transactions credited to or debited from a bank card. The combination of letters and numbers that the card-issuing bank generates to indicate that the transfer of funds from the account associated with the card was successful.
|Authorization code||The combination of letters and numbers that the card-issuing bank generates to indicate that the transfer of funds from the account associated with the card was successful.
Only applies to transactions credited to or debited from a bank card.  
|-
|-
|Comment associated with transaction||Comments associated with the transaction. || Comments show up in the monthly statement in the "Other information" column.
|Comment associated with transaction||Comments associated with the transaction. || Comments show up in the monthly statement in the "Other information" column.
|}
|}
If the caller fails to authenticate, the API will produce an empty output with an <code>HTTP 401 Unauthorized</code> status code.
If the requested statement file is not available, the API returns an error message with an <code>HTTP 404 Not found</code> 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 <code>HTTP 403 Forbidden</code> status code.


== Things to know ==
== Things to know ==

Revision as of 04:40, 22 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.

Authentication

Barion Wallet Authentication

Input properties

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.

Otherwise, a monthly statement is returned.

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.

If the user doesn't have an account in the specified currency, the API returns an error message with an HTTP 400 Bad request status code.

Output

Depending on whether a day parameter was passed, the endpoint responds with one of the following outputs:

  • if a day parameter was passed, an .xlsx-format daily statement with an XML digital signature (signed by "Barion Payments Zrt", certified by an external issuer) to guarantee data integrity;
  • if no day parameter was passed, a PDF-format monthly statement.
Data columns in the statement returned by the endpoint. Columns only show up in the daily statement unless indicated.
Column name Description Note
Transaction time The locale-specific-formatted date and time of the transaction. This column is also part of the monthly statement.
Transaction type The type of the transaction. This column is also part of the monthly statement.
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.
 This column is also part of the monthly statement, as "Sender/Recipient".
Transaction amount The locale-specific-formatted amount of the transaction. Deposits are positive, and withdrawals are negative. This column is also part of the monthly statement.
Balance after transaction The locale-specific-formatted balance of the Barion Wallet after the transaction. Note that payment reservations and delayed capture transactions may not immediately affect the Barion Wallet balance. This column is also part of the monthly statement.
Currency The currency of the statement, as specified in the call to the endpoint. This column is also part of the monthly statement.
Payment ID generated by shop The identifier of the payment generated by the webshop that requested the payment, if the entry is a payment and a webshop is involved.
Transaction ID generated by shop The identifier of the transaction generated by the webshop associated with it, if applicable.
Unique payment ID generated by Barion Barion's GUID for the payment.
Unique transaction ID generated by Barion Barion's GUID for the transaction.
Order ID generated by shop The identifier generated by the webshop associated with the transaction, if applicable, to identify the order that the transaction was part of, if applicable.
Card number Last four digits of the debited or credited bank card.

Only applies to transactions credited to or debited from a bank card.

Card numbers are included in the monthly statement in the "Other information" column.
Authorization code The combination of letters and numbers that the card-issuing bank generates to indicate that the transfer of funds from the account associated with the card was successful.

Only applies to transactions credited to or debited from a bank card.

Comment associated with transaction Comments associated with the transaction. Comments show up in the monthly statement in the "Other information" column.

If the caller fails to authenticate, the API will produce an empty output with an HTTP 401 Unauthorized status code.

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.

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/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

Retrieved from "https://docs.barion.com/index.php?title=Statement-Download-v2&oldid=4217"