<?xml version="1.0"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en">
	<id>https://docs.barion.com/api.php?action=feedcontributions&amp;feedformat=atom&amp;user=Adamsz</id>
	<title>Barion Documentation - User contributions [en]</title>
	<link rel="self" type="application/atom+xml" href="https://docs.barion.com/api.php?action=feedcontributions&amp;feedformat=atom&amp;user=Adamsz"/>
	<link rel="alternate" type="text/html" href="https://docs.barion.com/Special:Contributions/Adamsz"/>
	<updated>2026-11-21T14:58:53Z</updated>
	<subtitle>User contributions</subtitle>
	<generator>MediaWiki 1.43.11</generator>
	<entry>
		<id>https://docs.barion.com/index.php?title=Statement_and_history_export_in_ABO_file_format&amp;diff=4077</id>
		<title>Statement and history export in ABO file format</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Statement_and_history_export_in_ABO_file_format&amp;diff=4077"/>
		<updated>2023-07-07T07:19:39Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: grammar in warning&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{NotificationBox|title=WARNING|text=This feature is under active development and subject to change at any time without notice!&lt;br /&gt;
Please don&#039;t use this documentation for integration with Barion in its current state!|color=#c20000}}&lt;br /&gt;
&lt;br /&gt;
= About the file format =&lt;br /&gt;
&lt;br /&gt;
ABO is a file format for exchanging financial data mainly used in the Czech and Slovakian market.&lt;br /&gt;
&lt;br /&gt;
It&#039;s a fixed-width format which is capable of importing transaction requests or exporting details of already completed transactions.&lt;br /&gt;
&lt;br /&gt;
== Usage in Barion ==&lt;br /&gt;
&lt;br /&gt;
Barion only uses ABO for exporting past transactions either in daily statement generation or in the manual export of transaction history.&lt;br /&gt;
Our format is based on the extended ABO format used by Česká spořitelna.&lt;br /&gt;
&lt;br /&gt;
= Structure =&lt;br /&gt;
&lt;br /&gt;
ABO files contain fixed-length fields and consist of two types of rows:&lt;br /&gt;
* one header row (code 074)&lt;br /&gt;
* zero or more transaction rows (code 075)&lt;br /&gt;
&lt;br /&gt;
== Header row ==&lt;br /&gt;
&lt;br /&gt;
The header row is the first row in an ABO file and contains general information about the export in question and the account which&#039;s history is contained within.&lt;br /&gt;
&lt;br /&gt;
=== Fields in header row ===&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;margin:auto&amp;quot;&lt;br /&gt;
|+ Detailed description of header row columns in ABO file&lt;br /&gt;
|-&lt;br /&gt;
! Number !! Name !! Length !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Field code || 3 || Always contains string &amp;quot;074&amp;quot; &lt;br /&gt;
|-&lt;br /&gt;
| 2 || Account number of client || 16 || The unique alphanumeric identifier of the Barion account, case sensitive.&lt;br /&gt;
|-&lt;br /&gt;
| 3 || Client name || 20 || The name of the wallet to which the exported account belongs to.&lt;br /&gt;
The name is cut off after 20 characters and padded with spaces from the right if too short.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Date of opening balance || 6 || The date from which the export contains transactions in the account.&lt;br /&gt;
|-&lt;br /&gt;
| 5  || Opening balance || 14 || The opening balance of the account before the first exported transaction.&lt;br /&gt;
|-&lt;br /&gt;
| 6  || Sign of opening balance || 1 || -&lt;br /&gt;
|-&lt;br /&gt;
| 7  || Closing balance || 14 || The closing balance of the account after the last exported transaction.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || Sign of closing balance || 1 || -&lt;br /&gt;
|-&lt;br /&gt;
| 9  || Sum of DEBIT transactions || 14 || The sum of all transactions that are categorized as DEBIT of DEBIT REVERSAL by the posting code.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Sign of sum of debit transactions || 1 || -&lt;br /&gt;
|-&lt;br /&gt;
| 11 || Sum of CREDIT transactions || 14 || The sum of all transactions that are categorized as CREDIT of CREDIT REVERSAL by the posting code.&lt;br /&gt;
|-&lt;br /&gt;
| 12 || Sign of sum of credit transactions || 1 || -&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Statement sequence number || 3 || the serial number of this statement withing the ABO file, should always be &amp;quot;001&amp;quot;.&lt;br /&gt;
|-&lt;br /&gt;
| 14 || Date of statement || 6 || The date on which this statement was generated.&lt;br /&gt;
|-&lt;br /&gt;
| 15 || Filler || 14 || Contains only whitespaces.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
==== Summary fields ====&lt;br /&gt;
&lt;br /&gt;
Fields (9-10) and (11-12) contain a summary of transactions based on the transaction categorization described in &amp;quot;Transaction categorization in ABO&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
The opening balance and closing balance should relate to these summaries in the following way:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Closing balance = Opening balance - Debit summary + Credit summary&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The daily statement export will always follow this rule, however it is possible that manual transaction exports will not as they can be filtered.&lt;br /&gt;
&lt;br /&gt;
== Transaction rows ==&lt;br /&gt;
&lt;br /&gt;
Each transaction row provides details about a transaction in which the account mentioned in the header row is affected.&lt;br /&gt;
&lt;br /&gt;
=== Fields in transaction rows ===&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;margin:auto&amp;quot;&lt;br /&gt;
|+ Detailed description of transaction row columns in ABO file&lt;br /&gt;
|-&lt;br /&gt;
! Number !! Name !! Length !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Field code || 3 ||  Always contains string &amp;quot;075&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 2 || Client account number || 16 || The unique alphanumeric identifier of the Barion account, case sensitive.&lt;br /&gt;
|-&lt;br /&gt;
| 3 || Counter-account number || 16 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 4 || Document number || 13 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 5 || Transaction Amount || 12 || -&lt;br /&gt;
|-&lt;br /&gt;
| 6 || Posting code || 1 || See &amp;quot;Transaction categorization in ABO&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 7 || V-symbol || 10 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 8 || K-symbol || 10 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 9 || S-symbol || 10 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Date of Transaction || 6 || The date on which this transaction was completed.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || Extra information || 20 || Contains the name of the Barion transaction type. Cut to 20 characters, padded from the right with spaces if needed.&lt;br /&gt;
|-&lt;br /&gt;
| 12 || Item change code || 1 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Data type || 4 || See &amp;quot;Data type field&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 14 || Due date || 6 || Not used by Barion as the export only contains past transactions&lt;br /&gt;
|-&lt;br /&gt;
| 15 || Message for payee #1 || 35 ||rowspan=4|Free text message for the payee of this transaction&lt;br /&gt;
Treated as one field which is 140 characters long.&lt;br /&gt;
|-&lt;br /&gt;
| 16 || Message for payee #2 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 17 || Message for payee #3 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 18 || Message for payee #4 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 19 || Message for payer || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 20 || Debited on || 6 || Not used by Barion, filled with &amp;quot;010101&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 21 || Item || 25 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 22 || Reference || 16 || The short identifier of this transaction in the Barion system.&lt;br /&gt;
|-&lt;br /&gt;
| 23 || ISO transaction amount || 15 || - &lt;br /&gt;
|-&lt;br /&gt;
| 24 || ISO transaction currency || 3 || 3-character ISO code of the transaction currency&lt;br /&gt;
|-&lt;br /&gt;
| 25 || Name of counter-account || 35 || The name belonging to the account on the other side of the transaction&lt;br /&gt;
|-&lt;br /&gt;
| 26 || Change rate of the transaction currency || 11 || Not used by Barion, always 1&lt;br /&gt;
|-&lt;br /&gt;
| 27 || Change rate of the account currency || 11 || Not used by Barion, always 1&lt;br /&gt;
|-&lt;br /&gt;
| 28 || V-symbol 2 || 10 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 29 || Description of transaction #2 || 35 || Contains the id of the payment as provided by the POS&lt;br /&gt;
|-&lt;br /&gt;
| 30 || Description of transaction #3 || 35 || Contains the id of the transaction as provided by the POS&lt;br /&gt;
|-&lt;br /&gt;
| 31 || Description of transaction #4 || 35 || Contains the id of the order as provided by the POS&lt;br /&gt;
|-&lt;br /&gt;
| 32 || SWIFT code of the bank of the counter-account #1 || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 33 || SWIFT code of the bank of the counter-account #1 || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 34 || Fee details #1 || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 35 || Fee details #2 || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 36 || Original transaction amount || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 37 || - || 35 || -&lt;br /&gt;
|-&lt;br /&gt;
| 38 || Payer bank reference || 35 || Contains the bank authorization code of the transaction&lt;br /&gt;
|-&lt;br /&gt;
| 39 || SEPA info #1 || 35 ||rowspan=3|Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 40 || SEPA info #2 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 41 || SEPA info #3 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 42 || CL fee type description || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 43 || CL fee specification #1 || 35 ||rowspan=2|Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 44 || CL fee specification #2 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 45 || Payer note #1 || 35 || Barion long identifier of transaction&lt;br /&gt;
|-&lt;br /&gt;
| 46 || Payer note #2 || 35 || Barion long identifier of payment&lt;br /&gt;
|-&lt;br /&gt;
| 47 || Payer note #3 || 35 ||rowspan=2|Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 48 || Payer note #4 || 35&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
==== Data type field ====&lt;br /&gt;
&lt;br /&gt;
The data type field consists of 3 parts and takes up 4 characters:&lt;br /&gt;
* the first character is always &amp;quot;1&amp;quot;,&lt;br /&gt;
* the second character is &amp;quot;1&amp;quot; of the transaction is in CZK and &amp;quot;2&amp;quot; otherwise&lt;br /&gt;
* the third and fourth characters are &amp;quot;01&amp;quot; if the transaction lowers the account balance, &amp;quot;02&amp;quot; otherwise&lt;br /&gt;
&lt;br /&gt;
== Transaction categorization in ABO ==&lt;br /&gt;
&lt;br /&gt;
In an ABO export, transactions are categorized into four categories with the following properties.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;margin:auto&amp;quot;&lt;br /&gt;
|+ Transaction category details&lt;br /&gt;
|-&lt;br /&gt;
! Category name !! Posting code !! Contributes to summary in header !! Affects balance in direction&lt;br /&gt;
|-&lt;br /&gt;
| Debit || 1 || Debit summary (+) || -&lt;br /&gt;
|-&lt;br /&gt;
| Credit || 2 || Credit summary (+) || +&lt;br /&gt;
|-&lt;br /&gt;
| Debit reversal || 3 || Debit summary (-) || +&lt;br /&gt;
|-&lt;br /&gt;
| Credit reversal || 4 || Credit summary (-) || -&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Formatting of fields ==&lt;br /&gt;
&lt;br /&gt;
All&lt;br /&gt;
* date fields are formatted as ddMMyy,&lt;br /&gt;
* numeric fields representing money&lt;br /&gt;
** contain the first n-2 characters as the whole part,&lt;br /&gt;
** contain the last 2 characters are the decimal part,&lt;br /&gt;
** and the field is padded from the left with &amp;quot;0&amp;quot; characters,&lt;br /&gt;
* signs of money fields are either the character &amp;quot;+&amp;quot; or &amp;quot;-&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
= Exported files =&lt;br /&gt;
&lt;br /&gt;
In all cases when you export statements in ABO format, you will get a zip file which will contain a separate ABO file for every account that is included in the export. If there were no transactions for the given filters for an account, the file will only contain a header row and all money type fields (opening balance, closing balance, sum of credit, sum of debit) will be zeroed out with a positive sign.&lt;br /&gt;
&lt;br /&gt;
ABO files have a &amp;quot;.gpc&amp;quot; extension and Barion creates UTF-8 encoded files.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Statement_and_history_export_in_ABO_file_format&amp;diff=4076</id>
		<title>Statement and history export in ABO file format</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Statement_and_history_export_in_ABO_file_format&amp;diff=4076"/>
		<updated>2023-07-07T07:19:09Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: Initial version&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{NotificationBox|title=WARNING|text=This feature is active under development and subject to change at any time without notice!&lt;br /&gt;
Please don&#039;t use this documentation for integration with Barion in its current state!|color=#c20000}}&lt;br /&gt;
&lt;br /&gt;
= About the file format =&lt;br /&gt;
&lt;br /&gt;
ABO is a file format for exchanging financial data mainly used in the Czech and Slovakian market.&lt;br /&gt;
&lt;br /&gt;
It&#039;s a fixed-width format which is capable of importing transaction requests or exporting details of already completed transactions.&lt;br /&gt;
&lt;br /&gt;
== Usage in Barion ==&lt;br /&gt;
&lt;br /&gt;
Barion only uses ABO for exporting past transactions either in daily statement generation or in the manual export of transaction history.&lt;br /&gt;
Our format is based on the extended ABO format used by Česká spořitelna.&lt;br /&gt;
&lt;br /&gt;
= Structure =&lt;br /&gt;
&lt;br /&gt;
ABO files contain fixed-length fields and consist of two types of rows:&lt;br /&gt;
* one header row (code 074)&lt;br /&gt;
* zero or more transaction rows (code 075)&lt;br /&gt;
&lt;br /&gt;
== Header row ==&lt;br /&gt;
&lt;br /&gt;
The header row is the first row in an ABO file and contains general information about the export in question and the account which&#039;s history is contained within.&lt;br /&gt;
&lt;br /&gt;
=== Fields in header row ===&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;margin:auto&amp;quot;&lt;br /&gt;
|+ Detailed description of header row columns in ABO file&lt;br /&gt;
|-&lt;br /&gt;
! Number !! Name !! Length !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Field code || 3 || Always contains string &amp;quot;074&amp;quot; &lt;br /&gt;
|-&lt;br /&gt;
| 2 || Account number of client || 16 || The unique alphanumeric identifier of the Barion account, case sensitive.&lt;br /&gt;
|-&lt;br /&gt;
| 3 || Client name || 20 || The name of the wallet to which the exported account belongs to.&lt;br /&gt;
The name is cut off after 20 characters and padded with spaces from the right if too short.&lt;br /&gt;
|-&lt;br /&gt;
| 4  || Date of opening balance || 6 || The date from which the export contains transactions in the account.&lt;br /&gt;
|-&lt;br /&gt;
| 5  || Opening balance || 14 || The opening balance of the account before the first exported transaction.&lt;br /&gt;
|-&lt;br /&gt;
| 6  || Sign of opening balance || 1 || -&lt;br /&gt;
|-&lt;br /&gt;
| 7  || Closing balance || 14 || The closing balance of the account after the last exported transaction.&lt;br /&gt;
|-&lt;br /&gt;
| 8  || Sign of closing balance || 1 || -&lt;br /&gt;
|-&lt;br /&gt;
| 9  || Sum of DEBIT transactions || 14 || The sum of all transactions that are categorized as DEBIT of DEBIT REVERSAL by the posting code.&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Sign of sum of debit transactions || 1 || -&lt;br /&gt;
|-&lt;br /&gt;
| 11 || Sum of CREDIT transactions || 14 || The sum of all transactions that are categorized as CREDIT of CREDIT REVERSAL by the posting code.&lt;br /&gt;
|-&lt;br /&gt;
| 12 || Sign of sum of credit transactions || 1 || -&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Statement sequence number || 3 || the serial number of this statement withing the ABO file, should always be &amp;quot;001&amp;quot;.&lt;br /&gt;
|-&lt;br /&gt;
| 14 || Date of statement || 6 || The date on which this statement was generated.&lt;br /&gt;
|-&lt;br /&gt;
| 15 || Filler || 14 || Contains only whitespaces.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
==== Summary fields ====&lt;br /&gt;
&lt;br /&gt;
Fields (9-10) and (11-12) contain a summary of transactions based on the transaction categorization described in &amp;quot;Transaction categorization in ABO&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
The opening balance and closing balance should relate to these summaries in the following way:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Closing balance = Opening balance - Debit summary + Credit summary&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The daily statement export will always follow this rule, however it is possible that manual transaction exports will not as they can be filtered.&lt;br /&gt;
&lt;br /&gt;
== Transaction rows ==&lt;br /&gt;
&lt;br /&gt;
Each transaction row provides details about a transaction in which the account mentioned in the header row is affected.&lt;br /&gt;
&lt;br /&gt;
=== Fields in transaction rows ===&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;margin:auto&amp;quot;&lt;br /&gt;
|+ Detailed description of transaction row columns in ABO file&lt;br /&gt;
|-&lt;br /&gt;
! Number !! Name !! Length !! Description&lt;br /&gt;
|-&lt;br /&gt;
| 1 || Field code || 3 ||  Always contains string &amp;quot;075&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 2 || Client account number || 16 || The unique alphanumeric identifier of the Barion account, case sensitive.&lt;br /&gt;
|-&lt;br /&gt;
| 3 || Counter-account number || 16 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 4 || Document number || 13 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 5 || Transaction Amount || 12 || -&lt;br /&gt;
|-&lt;br /&gt;
| 6 || Posting code || 1 || See &amp;quot;Transaction categorization in ABO&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 7 || V-symbol || 10 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 8 || K-symbol || 10 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 9 || S-symbol || 10 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 10 || Date of Transaction || 6 || The date on which this transaction was completed.&lt;br /&gt;
|-&lt;br /&gt;
| 11 || Extra information || 20 || Contains the name of the Barion transaction type. Cut to 20 characters, padded from the right with spaces if needed.&lt;br /&gt;
|-&lt;br /&gt;
| 12 || Item change code || 1 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 13 || Data type || 4 || See &amp;quot;Data type field&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 14 || Due date || 6 || Not used by Barion as the export only contains past transactions&lt;br /&gt;
|-&lt;br /&gt;
| 15 || Message for payee #1 || 35 ||rowspan=4|Free text message for the payee of this transaction&lt;br /&gt;
Treated as one field which is 140 characters long.&lt;br /&gt;
|-&lt;br /&gt;
| 16 || Message for payee #2 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 17 || Message for payee #3 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 18 || Message for payee #4 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 19 || Message for payer || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 20 || Debited on || 6 || Not used by Barion, filled with &amp;quot;010101&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
| 21 || Item || 25 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 22 || Reference || 16 || The short identifier of this transaction in the Barion system.&lt;br /&gt;
|-&lt;br /&gt;
| 23 || ISO transaction amount || 15 || - &lt;br /&gt;
|-&lt;br /&gt;
| 24 || ISO transaction currency || 3 || 3-character ISO code of the transaction currency&lt;br /&gt;
|-&lt;br /&gt;
| 25 || Name of counter-account || 35 || The name belonging to the account on the other side of the transaction&lt;br /&gt;
|-&lt;br /&gt;
| 26 || Change rate of the transaction currency || 11 || Not used by Barion, always 1&lt;br /&gt;
|-&lt;br /&gt;
| 27 || Change rate of the account currency || 11 || Not used by Barion, always 1&lt;br /&gt;
|-&lt;br /&gt;
| 28 || V-symbol 2 || 10 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 29 || Description of transaction #2 || 35 || Contains the id of the payment as provided by the POS&lt;br /&gt;
|-&lt;br /&gt;
| 30 || Description of transaction #3 || 35 || Contains the id of the transaction as provided by the POS&lt;br /&gt;
|-&lt;br /&gt;
| 31 || Description of transaction #4 || 35 || Contains the id of the order as provided by the POS&lt;br /&gt;
|-&lt;br /&gt;
| 32 || SWIFT code of the bank of the counter-account #1 || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 33 || SWIFT code of the bank of the counter-account #1 || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 34 || Fee details #1 || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 35 || Fee details #2 || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 36 || Original transaction amount || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 37 || - || 35 || -&lt;br /&gt;
|-&lt;br /&gt;
| 38 || Payer bank reference || 35 || Contains the bank authorization code of the transaction&lt;br /&gt;
|-&lt;br /&gt;
| 39 || SEPA info #1 || 35 ||rowspan=3|Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 40 || SEPA info #2 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 41 || SEPA info #3 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 42 || CL fee type description || 35 || Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 43 || CL fee specification #1 || 35 ||rowspan=2|Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 44 || CL fee specification #2 || 35&lt;br /&gt;
|-&lt;br /&gt;
| 45 || Payer note #1 || 35 || Barion long identifier of transaction&lt;br /&gt;
|-&lt;br /&gt;
| 46 || Payer note #2 || 35 || Barion long identifier of payment&lt;br /&gt;
|-&lt;br /&gt;
| 47 || Payer note #3 || 35 ||rowspan=2|Not used by Barion&lt;br /&gt;
|-&lt;br /&gt;
| 48 || Payer note #4 || 35&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
==== Data type field ====&lt;br /&gt;
&lt;br /&gt;
The data type field consists of 3 parts and takes up 4 characters:&lt;br /&gt;
* the first character is always &amp;quot;1&amp;quot;,&lt;br /&gt;
* the second character is &amp;quot;1&amp;quot; of the transaction is in CZK and &amp;quot;2&amp;quot; otherwise&lt;br /&gt;
* the third and fourth characters are &amp;quot;01&amp;quot; if the transaction lowers the account balance, &amp;quot;02&amp;quot; otherwise&lt;br /&gt;
&lt;br /&gt;
== Transaction categorization in ABO ==&lt;br /&gt;
&lt;br /&gt;
In an ABO export, transactions are categorized into four categories with the following properties.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable&amp;quot; style=&amp;quot;margin:auto&amp;quot;&lt;br /&gt;
|+ Transaction category details&lt;br /&gt;
|-&lt;br /&gt;
! Category name !! Posting code !! Contributes to summary in header !! Affects balance in direction&lt;br /&gt;
|-&lt;br /&gt;
| Debit || 1 || Debit summary (+) || -&lt;br /&gt;
|-&lt;br /&gt;
| Credit || 2 || Credit summary (+) || +&lt;br /&gt;
|-&lt;br /&gt;
| Debit reversal || 3 || Debit summary (-) || +&lt;br /&gt;
|-&lt;br /&gt;
| Credit reversal || 4 || Credit summary (-) || -&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Formatting of fields ==&lt;br /&gt;
&lt;br /&gt;
All&lt;br /&gt;
* date fields are formatted as ddMMyy,&lt;br /&gt;
* numeric fields representing money&lt;br /&gt;
** contain the first n-2 characters as the whole part,&lt;br /&gt;
** contain the last 2 characters are the decimal part,&lt;br /&gt;
** and the field is padded from the left with &amp;quot;0&amp;quot; characters,&lt;br /&gt;
* signs of money fields are either the character &amp;quot;+&amp;quot; or &amp;quot;-&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
= Exported files =&lt;br /&gt;
&lt;br /&gt;
In all cases when you export statements in ABO format, you will get a zip file which will contain a separate ABO file for every account that is included in the export. If there were no transactions for the given filters for an account, the file will only contain a header row and all money type fields (opening balance, closing balance, sum of credit, sum of debit) will be zeroed out with a positive sign.&lt;br /&gt;
&lt;br /&gt;
ABO files have a &amp;quot;.gpc&amp;quot; extension and Barion creates UTF-8 encoded files.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Registration_with_pre-filled_values&amp;diff=4054</id>
		<title>Registration with pre-filled values</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Registration_with_pre-filled_values&amp;diff=4054"/>
		<updated>2023-05-23T06:21:57Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: rename parameter for representative house number from rt to rhn to match code&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=Opening the Barion wallet registration page with pre-filled values=&lt;br /&gt;
There are certain situations and business models where the user is required to obtain a Barion wallet before they are able to pay for goods or services in the shop. Automatically registering a Barion wallet for a user by third parties is strictly prohibited by law. However, Barion aids the third party in a way so they can supply specific values to pre-fill the registration form, so the process can be completed faster by the user.&lt;br /&gt;
By using the following query string parameters, the third party can redirect the user to the Barion registration form so some fields are already filled for them.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Important:&#039;&#039;&#039; this is just a convinience feature! By modifying the URL the user can remove these values whenever they want.&lt;br /&gt;
&lt;br /&gt;
==Registration Type Query String Parameter==&lt;br /&gt;
&lt;br /&gt;
The &amp;quot;mode&amp;quot; query string parameter is used to determine the type of registration being requested in the API. We distinguish two registration types: personal and business.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Query string parameter&lt;br /&gt;
! Parameter type&lt;br /&gt;
! Parameter description&lt;br /&gt;
|-&lt;br /&gt;
| mode&lt;br /&gt;
| string&lt;br /&gt;
| Indicates the registration type: &amp;lt;code&amp;gt;Personal&amp;lt;/code&amp;gt; or &amp;lt;code&amp;gt;Business&amp;lt;/code&amp;gt;.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; To accommodate legacy integrations, we support two additional values for the &amp;quot;mode&amp;quot; query string parameter: &amp;quot;NaturalPerson&amp;quot; for personal registration and &amp;quot;Organization&amp;quot; for business registration.&lt;br /&gt;
&lt;br /&gt;
==Personal Wallet Registration Query String Parameters==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Query string parameter&lt;br /&gt;
! Parameter type&lt;br /&gt;
! Parameter description&lt;br /&gt;
|-&lt;br /&gt;
| m&lt;br /&gt;
| string&lt;br /&gt;
| The E-mail address of the user.&lt;br /&gt;
|-&lt;br /&gt;
| isEmailLocked&lt;br /&gt;
| boolean&lt;br /&gt;
| Indicates wether the E-mail address field is locked or editable - &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; means locked, &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt; means editable.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example:&#039;&#039;&#039;&lt;br /&gt;
&amp;lt;source lang=&amp;quot;powershell&amp;quot;&amp;gt;&lt;br /&gt;
https://secure.barion.com/Registration?mode=Personal&amp;amp;m=user%40example.com&amp;amp;isEmailLocked=true&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==Business Wallet Registration Query String Parameters==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Query string parameter&lt;br /&gt;
! Parameter type&lt;br /&gt;
! Parameter description&lt;br /&gt;
|-&lt;br /&gt;
| m&lt;br /&gt;
| string&lt;br /&gt;
| The E-mail address of the user.&lt;br /&gt;
|-&lt;br /&gt;
| isEmailLocked&lt;br /&gt;
| boolean&lt;br /&gt;
| Indicates wether the E-mail address field is locked or editable - &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; means locked, &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt; means editable.&lt;br /&gt;
|-&lt;br /&gt;
| on&lt;br /&gt;
| string&lt;br /&gt;
| The name of the organization.&lt;br /&gt;
|-&lt;br /&gt;
| onm&lt;br /&gt;
| bool&lt;br /&gt;
| Indicates if the name and short name of the organization match.&lt;br /&gt;
|-&lt;br /&gt;
| osn&lt;br /&gt;
| string&lt;br /&gt;
| Short name of the organization.&lt;br /&gt;
|-&lt;br /&gt;
| oc&lt;br /&gt;
| string&lt;br /&gt;
| The 3-letter iso code of the headquarters address country  (eg. HUN for Hungary, CZE for Czechia).&lt;br /&gt;
|-&lt;br /&gt;
| ot&lt;br /&gt;
| string&lt;br /&gt;
| The city for the headquarters address.&lt;br /&gt;
|-&lt;br /&gt;
| opa&lt;br /&gt;
| string&lt;br /&gt;
| The postal/zip code for the headquarters address.&lt;br /&gt;
|-&lt;br /&gt;
| os&lt;br /&gt;
| string&lt;br /&gt;
| The street name for the headquarters address.&lt;br /&gt;
|-&lt;br /&gt;
| ohn&lt;br /&gt;
| string&lt;br /&gt;
| The house number for the headquarters address.&lt;br /&gt;
|-&lt;br /&gt;
| oam&lt;br /&gt;
| bool&lt;br /&gt;
| Indicates, whether the headquarters and the postal address match.&lt;br /&gt;
|-&lt;br /&gt;
| ocat&lt;br /&gt;
| string&lt;br /&gt;
| The category number of the organization (so called TEÁOR in hungarian). Only the numerical value (eg: &amp;lt;code&amp;gt;0520&amp;lt;/code&amp;gt;) is required.&lt;br /&gt;
|-&lt;br /&gt;
| orn&lt;br /&gt;
| string&lt;br /&gt;
| The registration number of the organization.&lt;br /&gt;
|-&lt;br /&gt;
| otn&lt;br /&gt;
| string&lt;br /&gt;
| The tax number of the organization.&lt;br /&gt;
|-&lt;br /&gt;
| pc&lt;br /&gt;
| string&lt;br /&gt;
| The postal country of the organization.&lt;br /&gt;
|-&lt;br /&gt;
| ppa&lt;br /&gt;
| string&lt;br /&gt;
| The postal zip code of the organization.&lt;br /&gt;
|-&lt;br /&gt;
| pt&lt;br /&gt;
| string&lt;br /&gt;
| The postal city of the organization.&lt;br /&gt;
|-&lt;br /&gt;
| phn&lt;br /&gt;
| string&lt;br /&gt;
| The postal house number of the organization.&lt;br /&gt;
|-&lt;br /&gt;
| rfn&lt;br /&gt;
| string&lt;br /&gt;
| The organization representative&#039;s first name.&lt;br /&gt;
|-&lt;br /&gt;
| rln&lt;br /&gt;
| string&lt;br /&gt;
| The organization representative&#039;s last name.&lt;br /&gt;
|-&lt;br /&gt;
| rmfn&lt;br /&gt;
| string&lt;br /&gt;
| The organization representative mother&#039;s first name.&lt;br /&gt;
|-&lt;br /&gt;
| rmln&lt;br /&gt;
| string&lt;br /&gt;
| The organization representative mother&#039;s last name.&lt;br /&gt;
|-&lt;br /&gt;
| rn&lt;br /&gt;
| string&lt;br /&gt;
| The 3-letter country code of the organization representative&#039;s nationality (eg. HUN for Hungary, CZE for Czechia).&lt;br /&gt;
|-&lt;br /&gt;
| rbp&lt;br /&gt;
| string&lt;br /&gt;
| The organization representative&#039;s birth place.&lt;br /&gt;
|-&lt;br /&gt;
| rbd&lt;br /&gt;
| string&lt;br /&gt;
| The organization representative&#039;s birth date (eg: 1990-01-01).&lt;br /&gt;
|-&lt;br /&gt;
| rbp&lt;br /&gt;
| string&lt;br /&gt;
| The organization representative&#039;s position (eg. CEO).&lt;br /&gt;
|-&lt;br /&gt;
| rc&lt;br /&gt;
| string&lt;br /&gt;
| The 3-letter iso country code of the organization representative&#039;s address (eg. HUN for Hungary, CZE for Czechia).&lt;br /&gt;
|-&lt;br /&gt;
| rpa&lt;br /&gt;
| string&lt;br /&gt;
| The zip code of the organization representative&#039;s address.&lt;br /&gt;
|-&lt;br /&gt;
| rt&lt;br /&gt;
| string&lt;br /&gt;
| The city of the organization representative&#039;s address.&lt;br /&gt;
|-&lt;br /&gt;
| rs&lt;br /&gt;
| string&lt;br /&gt;
| The street of the organization representative&#039;s address.&lt;br /&gt;
|-&lt;br /&gt;
| rhn&lt;br /&gt;
| string&lt;br /&gt;
| The house number of the organization representative&#039;s address.&lt;br /&gt;
|-&lt;br /&gt;
| rpcc&lt;br /&gt;
| string&lt;br /&gt;
| The prefix country code of the organization representative&#039;s phone number (eg. 36 for Hungary, 420 for Czechia).&lt;br /&gt;
|-&lt;br /&gt;
| rpn&lt;br /&gt;
| string&lt;br /&gt;
| The phone number of the organization representative without the country code (eg. 205555555 for a valid hungarian phone number).&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example:&#039;&#039;&#039;&lt;br /&gt;
&amp;lt;source lang=&amp;quot;powershell&amp;quot;&amp;gt;&lt;br /&gt;
https://secure.barion.com/Registration?mode=Business&amp;amp;m=user@example.com&amp;amp;on=Testdata+Company+Ltd&amp;amp;opa=98332&amp;amp;ot=San+José&amp;amp;os=Rockwood+Creek&amp;amp;ohn=32&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==Other query string parameters==&lt;br /&gt;
These extra parameters can be used on both the individual and the organization registration page.&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Query string parameter&lt;br /&gt;
! Parameter type&lt;br /&gt;
! Parameter description&lt;br /&gt;
|-&lt;br /&gt;
| r&lt;br /&gt;
| string&lt;br /&gt;
| The E-mail address OR topup code of the referring user, if applicable.&lt;br /&gt;
|-&lt;br /&gt;
| url&lt;br /&gt;
| string&lt;br /&gt;
| The URL where the user should be redirected upon successful registration. The e-mail address entered at the registration is appended to the URL as a query string parameter.&lt;br /&gt;
&#039;&#039;&#039;Warning:&#039;&#039;&#039; this feature is under development and is subject to change without notice!&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example:&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
Individual registration with referrer and redirect URL:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;powershell&amp;quot;&amp;gt;&lt;br /&gt;
https://secure.barion.com/Registration?mode=Personal&amp;amp;m=user%40example.com&amp;amp;isEmailLocked=true&amp;amp;r=123456789&amp;amp;url=https://www.example.com/successfulregistration&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Pos-Get-v1&amp;diff=3974</id>
		<title>Pos-Get-v1</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Pos-Get-v1&amp;diff=3974"/>
		<updated>2023-05-02T13:40:39Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change url to indicate that the input parameter is a query string&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;__NOTOC__&lt;br /&gt;
{{PageTitle|title=Barion API: Request the current state of a POS}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=GET&lt;br /&gt;
|uri=/v1/Pos?PublicKey&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
Use the &amp;lt;code&amp;gt;Pos?PublicKey&amp;lt;/code&amp;gt; API endpoint to query the details and current state of a point of sale (POS).&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[POS_create_v1|Creating a POS in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v1&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v1&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Query string parameters for getting a shop&#039;s state ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Query string parameter&lt;br /&gt;
! Parameter type&lt;br /&gt;
! Parameter description&lt;br /&gt;
|-&lt;br /&gt;
| PublicKey &lt;br /&gt;
| string&lt;br /&gt;
| The public key of the POS.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Query string parameter&lt;br /&gt;
! Parameter type&lt;br /&gt;
! Parameter description&lt;br /&gt;
|-&lt;br /&gt;
| Name&lt;br /&gt;
| string&lt;br /&gt;
| The unique name of the shop.&lt;br /&gt;
|-&lt;br /&gt;
| PublicKey &lt;br /&gt;
| Guid &lt;br /&gt;
| The public key of the shop.&lt;br /&gt;
|-&lt;br /&gt;
| SecretKey &lt;br /&gt;
| Guid&lt;br /&gt;
| The secret POS key of the shop.&lt;br /&gt;
|-&lt;br /&gt;
| Status &lt;br /&gt;
| [[ShopStatus]] &lt;br /&gt;
| The status of the shop.&lt;br /&gt;
|-&lt;br /&gt;
| IsOpen &lt;br /&gt;
| bool &lt;br /&gt;
| Information on whether the shop is open.&lt;br /&gt;
|-&lt;br /&gt;
| Description&lt;br /&gt;
| string &lt;br /&gt;
| The short description of the shop.&lt;br /&gt;
|-&lt;br /&gt;
| Logo &lt;br /&gt;
| string&lt;br /&gt;
| The logo of the shop, is sent as a URL.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| BusinessContact &lt;br /&gt;
| [[BusinessContact]]&lt;br /&gt;
| The business contact details of the shop.&lt;br /&gt;
|-&lt;br /&gt;
| TechnicalContact &lt;br /&gt;
| [[TechnicalContact]]&lt;br /&gt;
| The technical contact details of the shop.&lt;br /&gt;
|-&lt;br /&gt;
| CustomerServiceContact &lt;br /&gt;
| [[CustomerServiceContact]]&lt;br /&gt;
| The contact details of your customer service desk, where your customers can contact you.&lt;br /&gt;
|-&lt;br /&gt;
| CallBackUrl  &lt;br /&gt;
| string &lt;br /&gt;
| The URL where the Barion system sends a request whenever there is a change in the state of the shop.&lt;br /&gt;
|-&lt;br /&gt;
| ReferenceId &lt;br /&gt;
| string &lt;br /&gt;
| The top-up code of the wallet. Used to distinguish shops arriving through different channels.&lt;br /&gt;
|-&lt;br /&gt;
| CustomTemplate &lt;br /&gt;
| string &lt;br /&gt;
| The custom template you used to modify the displayed data.&lt;br /&gt;
|-&lt;br /&gt;
| CustomCSS &lt;br /&gt;
| string &lt;br /&gt;
| The custom CSS you used to modify the gateway design.&lt;br /&gt;
&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Account&amp;diff=3765</id>
		<title>Account</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Account&amp;diff=3765"/>
		<updated>2022-12-06T09:07:13Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: Change TopUpInfo to AccountInfo&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Account structure}}&lt;br /&gt;
&lt;br /&gt;
The &#039;&#039;&#039;Account&#039;&#039;&#039; structure represents an account in a Barion wallet.&lt;br /&gt;
&lt;br /&gt;
= API usage =&lt;br /&gt;
&lt;br /&gt;
This structure is used by the following API endpoints:&lt;br /&gt;
* [[Accounts-Get-v2|/Accounts]]&lt;br /&gt;
&lt;br /&gt;
= Properties =&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| AccountId || Guid || &lt;br /&gt;
|| The unique identifier of the account&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| Balance || [[Balance]] || &lt;br /&gt;
|| The current balance of the account&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| Currency || string || &lt;br /&gt;
|| The currency of the account in 3-letter ISO country code format&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| AccountInfo || [[TopUpInfo|AccountInfo]] ||&lt;br /&gt;
|| Information about how to topup the account.&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=TopUpInfo&amp;diff=3764</id>
		<title>TopUpInfo</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=TopUpInfo&amp;diff=3764"/>
		<updated>2022-12-06T09:07:00Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change to accountinfo&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=AccountInfo structure}}&lt;br /&gt;
&lt;br /&gt;
The &#039;&#039;&#039;AccountInfo&#039;&#039;&#039; structure contains information about how to topup an account.&lt;br /&gt;
&lt;br /&gt;
= API usage =&lt;br /&gt;
&lt;br /&gt;
This structure is used by the following API endpoints:&lt;br /&gt;
* [[Accounts-Get-v2|/Accounts]]&lt;br /&gt;
&lt;br /&gt;
= Properties =&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| BBANCountry || string || ISO-3 country code || The code of the country which counts as domestic for the currency of the account. This is currently &amp;quot;HUN&amp;quot; for HUF accounts, &amp;quot;CZE&amp;quot; for CZK accounts, and null for everything else.&lt;br /&gt;
|-&lt;br /&gt;
| BBAN || string || Format depends on currency || The BBAN (local bank account number) of the account to which wire transfer topups should be sent. Currently only available for HUF and CZK accounts. For HUF accounts, this is unique to the wallet, for CZK, this is Barion&#039;s CZK deposit bank account number.&lt;br /&gt;
|-&lt;br /&gt;
| IBAN || string || Valid IBAN format || The IBAN (international bank account number) of the account to which wire transfer topups should be sent. Available for all currencies. For HUF, EUR, and USD this is unique to the wallet, for CZK, this is Barion&#039;s CZK deposit bank account number. &lt;br /&gt;
|-&lt;br /&gt;
| Reference || string || || For topups to a Barion deposit account, this code must be used in conjunction with the bank account number to identify the target of the topup.&lt;br /&gt;
|-&lt;br /&gt;
| SwiftCode || string || || The swift code of the bank at which the topup&#039;s target account is open.&lt;br /&gt;
|-&lt;br /&gt;
| Beneficiary || [[Beneficiary]] || || Name and location information about the beneficiary of the wire transfer.&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Beneficiary&amp;diff=3763</id>
		<title>Beneficiary</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Beneficiary&amp;diff=3763"/>
		<updated>2022-12-06T09:06:44Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: create page initial version&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Beneficiary structure}}&lt;br /&gt;
&lt;br /&gt;
The &#039;&#039;&#039;Beneficiary&#039;&#039;&#039; structure contains information about the beneficiary of a wire transfer including name and location.&lt;br /&gt;
&lt;br /&gt;
= API usage =&lt;br /&gt;
&lt;br /&gt;
This structure is used by the following API endpoints:&lt;br /&gt;
* [[Accounts-Get-v2|/Accounts]]&lt;br /&gt;
&lt;br /&gt;
= Properties =&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| Name || string || || The displayed name of the wallet that will be the target of the wire transfer, postfixed with Barion&#039;s name. If not available, the text &amp;quot;Barion&amp;quot; is used.&lt;br /&gt;
|-&lt;br /&gt;
| Country || string || ISO-3 country code || The country of the wire transfer target&#039;s address.&lt;br /&gt;
|-&lt;br /&gt;
| City || string || || The city of the wire transfer target&#039;s address.&lt;br /&gt;
|-&lt;br /&gt;
| Zip || string || || The zip code of the wire transfer target&#039;s address.&lt;br /&gt;
|-&lt;br /&gt;
| Street || string || || The street and house number of the wire transfer target&#039;s address.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=The target address is &amp;lt;strong&amp;gt;NOT&amp;lt;/strong&amp;gt; the wallet&#039;s address, but the address of Barion headquarters.|color=#0097db}}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Calling_the_API&amp;diff=3755</id>
		<title>Calling the API</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Calling_the_API&amp;diff=3755"/>
		<updated>2022-11-22T09:12:39Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: remove &amp;quot;only in sandbox&amp;quot; paragraph&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;__NOTOC__&lt;br /&gt;
{{PageTitle|title=Calling the Barion API}}&lt;br /&gt;
&lt;br /&gt;
== The Barion API ==&lt;br /&gt;
&lt;br /&gt;
Barion offers you a RESTful API service to communicate with your web or mobile merchant services. Learn more about RESTful behavior [https://en.wikipedia.org/wiki/Representational_state_transfer|in the original Wikipedia article].&lt;br /&gt;
&lt;br /&gt;
== Protocols and communication ==&lt;br /&gt;
&lt;br /&gt;
The Barion API communicates via standard &#039;&#039;&#039;HTTP1.1&#039;&#039;&#039; GET or POST requests. A given API endpoint accepts only GET or only POST requests - there are no universal endpoints available.&lt;br /&gt;
On each API endpoint reference page, you can find the path of the API endpoint and the HTTP method it accepts.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/Start&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=IMPORTANT|text=All communication must be done over HTTPS. The Barion system only supports TLS v1.1 / v1.2|color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
If the caller uses an incorrect method, the system responds with a JSON error message.&lt;br /&gt;
&lt;br /&gt;
Example: calling a POST endpoint with a GET request&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;json&amp;quot;&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;Message&amp;quot;: &amp;quot;The requested resource does not support http method &#039;GET&#039;.&amp;quot;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Data and content types ==&lt;br /&gt;
&lt;br /&gt;
The API sends and receives all content in standard &#039;&#039;&#039;JSON&#039;&#039;&#039; (JavaScript Object Notation) string format.&lt;br /&gt;
&lt;br /&gt;
Some things you must ensure when creating an API request:&lt;br /&gt;
* JSON strings are UTF-8 encoded.&lt;br /&gt;
* The MIME type of the request sent to the API is defined as &amp;lt;code&amp;gt;application/json&amp;lt;/code&amp;gt;.&lt;br /&gt;
* &amp;lt;code&amp;gt;Content-length&amp;lt;/code&amp;gt; should also be specified explicitly in all HTTP request headers.&lt;br /&gt;
&lt;br /&gt;
The data types used in the API communication are the following:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Data type&lt;br /&gt;
! Type description&lt;br /&gt;
|-&lt;br /&gt;
| string&lt;br /&gt;
| Standard character string. The Barion API uses UTF-8 encoding.&lt;br /&gt;
|-&lt;br /&gt;
| int&lt;br /&gt;
| 32-bit signed integer format&lt;br /&gt;
|-&lt;br /&gt;
| GUID (Global Unique Identifier)&lt;br /&gt;
| A 128-bit long hexadecimal identifier with 32 character string representation, like this: &#039;&#039;21EC2020-3AEA-4069-A2DD-08002B30309D&#039;&#039;. Its value is always unique in the Barion system. This is used e.g. to identify payments. For security and compatibility reason the GUID is used without hyphens for most of our API.&lt;br /&gt;
|-&lt;br /&gt;
| DateTime&lt;br /&gt;
| Date and time values, represented in a string format of the &#039;&#039;&#039;ISO-8601&#039;&#039;&#039; standard, like this: &#039;&#039;2014-12-06T08:35:46Z&#039;&#039;. All API call responses contain datetimes as strings.&lt;br /&gt;
|-&lt;br /&gt;
| TimeSpan&lt;br /&gt;
| A time range value represented in a string format of the &#039;&#039;&#039;ISO-8601&#039;&#039;&#039; standard, like this: &#039;&#039;3.14:15:28&#039;&#039; (three days, fourteen hours, fifteen minutes, twenty-eight seconds). All API call responses contain datetimes as strings.&lt;br /&gt;
|-&lt;br /&gt;
| bool&lt;br /&gt;
| Boolean &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; or &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt; values. &lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; avoid integer or byte evaluation when constructing the request JSON!&lt;br /&gt;
|-&lt;br /&gt;
| byte&lt;br /&gt;
| Byte representation of an enumeration value. This is only for internal use in the Barion system, API call responses always contain the string representation.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== API URLs ==&lt;br /&gt;
&lt;br /&gt;
The base URL for the Barion API depends on the environment you are connecting to.&lt;br /&gt;
&lt;br /&gt;
Base URL for API requests in the &#039;&#039;&#039;Live (production)&#039;&#039;&#039; environment: &amp;lt;code&amp;gt;https://api.barion.com&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Base URL for API requests in the &#039;&#039;&#039;Sandbox (test)&#039;&#039;&#039; environment: &amp;lt;code&amp;gt;https://api.test.barion.com&amp;lt;/code&amp;gt; (learn more about the Sandbox environment [[Sandbox|here]])&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; Always double check that you are connecting to the proper environment to avoid unnecessary hassle and troubleshooting!&lt;br /&gt;
&lt;br /&gt;
== API versioning ==&lt;br /&gt;
&lt;br /&gt;
To avoid breaking changes, whenever there is a major update to an API endpoint, it is moved to a higher level of API version. At the moment, the Barion API offers two different API versions (noted &amp;lt;code&amp;gt;v1&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;v2&amp;lt;/code&amp;gt;). Some API endpoints are only available in v1 or v2. See the reference page of a given API endpoint to see which versions are available.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; Though version numbers can be omitted from the endpoint path (such requests always fall back to &amp;lt;code&amp;gt;v1&amp;lt;/code&amp;gt;), it is recommended to always specify the API version when sending requests to the Barion API to avoid confusion.&lt;br /&gt;
&lt;br /&gt;
Example paths:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;https://api.barion.com/Transaction/List&amp;lt;/nowiki&amp;gt;&amp;lt;/code&amp;gt; - implicit call to a &amp;lt;code&amp;gt;v1&amp;lt;/code&amp;gt; endpoint (version number is omitted from path)&lt;br /&gt;
* &amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;https://api.barion.com/v1/Transfer/Send&amp;lt;/nowiki&amp;gt;&amp;lt;/code&amp;gt; - explicit call to a &amp;lt;code&amp;gt;v1&amp;lt;/code&amp;gt; endpoint&lt;br /&gt;
* &amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;https://api.barion.com/v2/Payment/Start&amp;lt;/nowiki&amp;gt;&amp;lt;/code&amp;gt; - explicit call to a &amp;lt;code&amp;gt;v2&amp;lt;/code&amp;gt; endpoint&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
For every request sent to the Barion API you have to authenticate yourself. Depending on the type of endpoint you should use a different type of authentication.&lt;br /&gt;
&lt;br /&gt;
==== Shop-level endpoints ====&lt;br /&gt;
&lt;br /&gt;
Shop-level endpoints can be authenticated using the shop&#039;s unique &amp;lt;tt&amp;gt;POSKey&amp;lt;/tt&amp;gt;. For more details on using and obtaining the POS key, see the [[Barion Shop Authentication]] page.&lt;br /&gt;
&lt;br /&gt;
==== Wallet-level endpoints ====&lt;br /&gt;
&lt;br /&gt;
You can authenticate yourself to endpoints requiring wallet-level authentication via an API key called a &amp;lt;tt&amp;gt;Wallet key&amp;lt;/tt&amp;gt;. For more information on using this API key, see [[Barion Wallet Authentication]].&lt;br /&gt;
&lt;br /&gt;
== Handling the response ==&lt;br /&gt;
The structure of the response varies from endpoint to endpoint however on property can found in all of them. Every API response contains an &amp;lt;code&amp;gt;Errors&amp;lt;/code&amp;gt; array. If this array is empty then the request was processed successfully. This array can contain multiple errors so make sure that the integration is prepared for this. The errors have the following fields&amp;gt;&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! FieldName || Description&lt;br /&gt;
|-&lt;br /&gt;
| ErrorCode || The error code of the payment, this can be interpreted as an error Id.&lt;br /&gt;
|-&lt;br /&gt;
| Title|| The title of the error, this is a more readable form of the error.&lt;br /&gt;
|-&lt;br /&gt;
| Description|| The description of the error, more information about the error.&lt;br /&gt;
|-&lt;br /&gt;
| EndPoint || The URL of the API endpoint to help the reproduction of the error scenario.&lt;br /&gt;
|-&lt;br /&gt;
| AuthData || The e-mail address of the caller to help the reproduction of the error scenario. &lt;br /&gt;
|-&lt;br /&gt;
| HappenedAt || The timestamp of the response.&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId ||  If the error is related to a business process that involves a given payment, the public identifier of the payment is supplied here. This property is not present on all errors.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example error response&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
The following example shows an error case where the shop does not have an account with the currency it specified when trying to create a payment.&lt;br /&gt;
This is a validation error, so the payment identifier is not applicable.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=json&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;Errors&amp;quot;: [&lt;br /&gt;
    {&lt;br /&gt;
      &amp;quot;ErrorCode&amp;quot;: &amp;quot;NotExistingCurrency&amp;quot;,&lt;br /&gt;
      &amp;quot;Title&amp;quot;: &amp;quot;Payment is not supported&amp;quot;,&lt;br /&gt;
      &amp;quot;Description&amp;quot;: &amp;quot;Payment is not supported. The POS doesn’t have an account that supports EUR!&amp;quot;,&lt;br /&gt;
      &amp;quot;EndPoint&amp;quot;: &amp;quot;https://api.barion.com/v2/Payment/Start&amp;quot;,&lt;br /&gt;
      &amp;quot;AuthData&amp;quot;: &amp;quot;shop@example.com&amp;quot;,&lt;br /&gt;
      &amp;quot;HappenedAt&amp;quot;: &amp;quot;2017-02-06T09:48:13.7694921Z&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  ]&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The following example shows a case where after several successful token charges, the customer deleted their payment card from the Barion system, so the subsequent attempt failed.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=json&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;Errors&amp;quot;: [&lt;br /&gt;
    {&lt;br /&gt;
      &amp;quot;ErrorCode&amp;quot;: &amp;quot;OriginalPaymentCardDoesNotExist&amp;quot;,&lt;br /&gt;
      &amp;quot;Title&amp;quot;: &amp;quot;The original payment card does not exist!&amp;quot;,&lt;br /&gt;
      &amp;quot;Description&amp;quot;: &amp;quot;The payment card that was used for the original payment with recurrence ID &#039;TEST-01&#039; no longer exists in the system!&amp;quot;,&lt;br /&gt;
      &amp;quot;EndPoint&amp;quot;: &amp;quot;https://api.barion.com/v2/Payment/Start&amp;quot;,&lt;br /&gt;
      &amp;quot;AuthData&amp;quot;: &amp;quot;shop@example.com&amp;quot;,&lt;br /&gt;
      &amp;quot;HappenedAt&amp;quot;: &amp;quot;2017-02-06T09:48:13.7694921Z&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  ]&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==Security==&lt;br /&gt;
Please refer to the [[Security Measures]] page for more information on IT security before staring to code.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=UserHistory-GetHistory-v2&amp;diff=3741</id>
		<title>UserHistory-GetHistory-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=UserHistory-GetHistory-v2&amp;diff=3741"/>
		<updated>2022-11-15T10:54:54Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: transaction history}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=GET&lt;br /&gt;
|uri=/v2/UserHistory/GetHistory&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/v2/UserHistory/GetHistory&amp;lt;/code&amp;gt; API endpoint is used to query the transaction history from the Barion system for the authenticated wallet.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=IMPORTANT|text=This API should not be used for reconciliation, use the [[Statement-Download-v2 | statement API]] instead.|color=#FF7A3D}}&lt;br /&gt;
{{NotificationBox|title=IMPORTANT|text=The item type of history elements does not correlate with the type of transactions exported through GUI or downloaded with[[Statement-Download-v2 | statement API]].|color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
The input properties should be defined in the query string.&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| LastVisibleItemId || Guid ||&lt;br /&gt;
* Optional&lt;br /&gt;
 || &lt;br /&gt;
The identifier of the most recent transaction. Only transactions after the defined transaction will be included in the response.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| LastRequestTime || DateTime || &lt;br /&gt;
* Optional&lt;br /&gt;
*Universal Time Coordinated (UTC)&lt;br /&gt;
|| &lt;br /&gt;
The exact time of the last request. Only transactions after the defined request time will be included in the response.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Limit || int || &lt;br /&gt;
* Optional&lt;br /&gt;
* If not defined the default value is 20&lt;br /&gt;
* If the defined value is greater than 20 the default value will be used&lt;br /&gt;
|| &lt;br /&gt;
The expected number of transactions in the response.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
* Must be supplied in ISO 4217 format&lt;br /&gt;
Accepted values: &lt;br /&gt;
{{CurrencyList}}&lt;br /&gt;
|| The currency of the transaction. If the currency is defined, then only transactions in the same currency will be included in the response.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Id || Guid || The identifier of the transaction.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Type || [[HistoryItemType]] || The type of the transaction.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| HappenedAtUtc || DateTime || The exact time when the transaction happened.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ConcurrencyOrder || int || The order of the transaction when more than one transaction happened at the same time. The default value is 0.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| SourceAccount || [[UserHistoryParticipant]] || The user who initiated the transaction or from whom the money originated.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TargetAccount || [[UserHistoryParticipant]] || The user who will receive the amount of the transaction.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || The amount of the transaction.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || The 3-character ISO 4217 currency code of the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Description || string || Description of the transaction. Max: 640 characters.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| IsInProgress || bool || This flag indicates that the transaction is not in the final state.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Transfer-Send-v1&amp;diff=3740</id>
		<title>Transfer-Send-v1</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Transfer-Send-v1&amp;diff=3740"/>
		<updated>2022-11-15T10:53:52Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: send money instantly}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v1/Transfer/Send&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/transfer/send&amp;lt;/code&amp;gt; API endpoint is used to send e-money between Barion users or outside Barion.&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=WARNING|text=This API endpoint is deprecated.|color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v1&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v1&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
* Accepted values: &lt;br /&gt;
** &amp;quot;CZK&amp;quot; (Czech crown)&lt;br /&gt;
** &amp;quot;EUR&amp;quot; (Euro)&lt;br /&gt;
** &amp;quot;HUF&amp;quot; (Hungarian forint)&lt;br /&gt;
** &amp;quot;USD&amp;quot; (U.S. dollar)&lt;br /&gt;
|| The currency of the money transfer. &lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; Barion does not do currency rate conversion. The caller must have an active account with the selected currency. If the recipient does not have an active account with the selected currecy, the system automatically creates one for them.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || &lt;br /&gt;
* Required&lt;br /&gt;
* Must be greater than zero&lt;br /&gt;
|| The total amount to transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Recipient || string || &lt;br /&gt;
* Required&lt;br /&gt;
|| The e-mail address of the recipient of the transfer. If they are an active Barion user, they receive the money instantly. If the e-mail address is not registered in Barion, they must register in 7 days in order to claim the money. If the money is not claimed, it gets transferred back to the sender.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment || string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Maximum length: 1000 characters&lt;br /&gt;
|| The comment of the money transfer.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TransactionId || Guid || The unique identifier of the transfer, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || The currency of the money transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || The total amount transferred.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FromBalance || decimal || The remaining balance of the sender.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FromName || string || The name of the sender of the transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ToName || string || The name of the recipient of the transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment || string || The comment of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TransactionType || [[TransactionType]] || The type of the transaction in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Direction || int || The direction of the transfer.&lt;br /&gt;
* 1 = incoming&lt;br /&gt;
* 0 = outgoing&lt;br /&gt;
&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Transfer-Email-v2&amp;diff=3739</id>
		<title>Transfer-Email-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Transfer-Email-v2&amp;diff=3739"/>
		<updated>2022-11-15T10:53:35Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: send money to an e-mail address}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Transfer/Email&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/transfer/email&amp;lt;/code&amp;gt; API endpoint is used to send money to another Barion Wallet.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| SourceAccountId || GUID || &lt;br /&gt;
* Required&lt;br /&gt;
* Must be an account of the authenticating user, in the same currency as the transfer itself&lt;br /&gt;
|| The identifier of the Barion wallet. This can be determined using the [[Accounts-Get-v2]] API endpoint.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || [[Money]] || &lt;br /&gt;
* Required&lt;br /&gt;
* Must be greater than zero&lt;br /&gt;
|| The total amount to transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TargetEmail|| string || &lt;br /&gt;
* Required&lt;br /&gt;
|| The e-mail address of the recipient of the transfer. If they are an active Barion user, they receive the money instantly. If the e-mail address is not registered in Barion, they must register in 7 days in order to claim the money. If the money is not claimed, it gets transferred back to the sender.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment || string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Maximum length: 1000 characters&lt;br /&gt;
|| The comment of the money transfer.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| IsTransferSuccessful || bool || Indicates wether the e-money transfer was successfuly finished.&lt;br /&gt;
&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Statement-Download-v2&amp;diff=3738</id>
		<title>Statement-Download-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Statement-Download-v2&amp;diff=3738"/>
		<updated>2022-11-15T10:53:18Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Download statement file}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=GET&lt;br /&gt;
|uri=/v2/Statement/Download&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/statement/download&amp;lt;/code&amp;gt; API endpoint is used to download monthly or daily statement files generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Year || int || &lt;br /&gt;
* Required&lt;br /&gt;
|| The statement year.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Month || int || &lt;br /&gt;
* Required&lt;br /&gt;
|| The statement month.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Day || int || &lt;br /&gt;
* Optional&lt;br /&gt;
|| The statement day. If specified, the system will serve a daily statement file.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
Accepted values:&lt;br /&gt;
{{CurrencyList}}&lt;br /&gt;
|| The currency of the statement&#039;s account. Accounts with separate currencies have separate statement files.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output and response ==&lt;br /&gt;
&lt;br /&gt;
Depending on the given input parameters the endpoint will produce the following outputs:&lt;br /&gt;
&lt;br /&gt;
* If the caller fails to authenticate, the API will produce an empty output with an &amp;lt;code&amp;gt;HTTP 401 Unauthorized&amp;lt;/code&amp;gt; status code.&lt;br /&gt;
&lt;br /&gt;
* If only &#039;&#039;&#039;year&#039;&#039;&#039; and &#039;&#039;&#039;month&#039;&#039;&#039; were specified for the statement, the endpoint will try to serve the &amp;lt;u&amp;gt;monthly statement&amp;lt;/u&amp;gt; for the corresponding year and month as a PDF (Printable Document Format) document.&lt;br /&gt;
&lt;br /&gt;
* If &#039;&#039;&#039;year&#039;&#039;&#039;, &#039;&#039;&#039;month&#039;&#039;&#039;, and &#039;&#039;&#039;day&#039;&#039;&#039; were specified for the statement, the endpoint will try to serve the &amp;lt;u&amp;gt;daily statement&amp;lt;/u&amp;gt; for the corresponding date as a signed XLSX (Microsoft Excel) document.&lt;br /&gt;
&lt;br /&gt;
* If the requested statement file is not available, the API returns an error message with an &amp;lt;code&amp;gt;HTTP 404 Not found&amp;lt;/code&amp;gt; status code. This can happen if the requested statement file has not been generated yet.&lt;br /&gt;
&lt;br /&gt;
* If generation of the given statement type is disabled for the user, the API returns an error message with an &amp;lt;code&amp;gt;HTTP 403 Forbidden&amp;lt;/code&amp;gt; status code.&lt;br /&gt;
&lt;br /&gt;
* If the user does not have an account in the specified currency, the API returns an error message with an &amp;lt;code&amp;gt;HTTP 400 Bad request&amp;lt;/code&amp;gt; status code.&lt;br /&gt;
&lt;br /&gt;
== Things to know ==&lt;br /&gt;
* To get daily statement files please contact Barion from the Customer Center in your Barion wallet. &lt;br /&gt;
* Daily statement files will &amp;lt;u&amp;gt;not show&amp;lt;/u&amp;gt; up on the secure.barion.com site for download. They can only be downloaded via this API endpoint.&lt;br /&gt;
* Once the statement files have been generated, they are available to download for an indefinite time.&lt;br /&gt;
&lt;br /&gt;
== Examples ==&lt;br /&gt;
&lt;br /&gt;
Downloading the daily statement of an &#039;&#039;&#039;EUR&#039;&#039;&#039; account for &#039;&#039;&#039;October 6th 2019&#039;&#039;&#039;:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;https://&amp;lt;nowiki /&amp;gt;api.barion.com/v2/statement/download?username=customer@example.com&amp;amp;password=my5Tr0ngP4ssW0rd&amp;amp;year=2019&amp;amp;month=10&amp;amp;day=6&amp;amp;currency=EUR&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Downloading the monthly statement of an &#039;&#039;&#039;HUF&#039;&#039;&#039; account for &#039;&#039;&#039;April 2019&#039;&#039;&#039;:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;https://&amp;lt;nowiki /&amp;gt;api.barion.com/v2/statement/download?username=customer@example.com&amp;amp;password=my5Tr0ngP4ssW0rd&amp;amp;year=2019&amp;amp;month=4&amp;amp;currency=HUF&amp;lt;/code&amp;gt;&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Withdraw-BankTransfer-v2&amp;diff=3737</id>
		<title>Withdraw-BankTransfer-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Withdraw-BankTransfer-v2&amp;diff=3737"/>
		<updated>2022-11-15T10:53:00Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Initiate a bank transfer}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Withdraw/BankTransfer&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/withdraw/banktransfer&amp;lt;/code&amp;gt; API endpoint is used to send money out of the Barion system via bank (wire) transfer.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=WARNING|text=This API endpoint is obsolete as of August 2022. Please implement or migrate to [[Withdraw-BankTransfer-v3|/v3/Withdraw/BankTransfer]]|color=#FF7A3D}}&lt;br /&gt;
{{NotificationBox|title=IMPORTANT|text=Starting September 2022 this API endpoint does NOT accept withdrawal requests in CZK currency that are targeted &amp;lt;u&amp;gt;outside of Czechia&amp;lt;/u&amp;gt;.|color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
* Accepted values: &lt;br /&gt;
** &amp;quot;CZK&amp;quot; (Czech crown)&lt;br /&gt;
** &amp;quot;EUR&amp;quot; (Euro)&lt;br /&gt;
** &amp;quot;HUF&amp;quot; (Hungarian forint)&lt;br /&gt;
** &amp;quot;USD&amp;quot; (U.S. dollar)&lt;br /&gt;
|| The currency of the bank transfer. &lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; Barion does not do currency rate conversion. The caller must have an active account with the selected currency, and must ensure that the target bank accepts the selected currency.&lt;br /&gt;
&amp;lt;span style=&amp;quot;color:#920000;&amp;quot;&amp;gt;&#039;&#039;&#039;Note:&#039;&#039;&#039; Withdraws in CZK currency that are targeted outside of Czechia are not supported on this endpoint starting September 2022.&amp;lt;/span&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || &lt;br /&gt;
* Required&lt;br /&gt;
* Must be greater than zero&lt;br /&gt;
|| The total amount to withdraw, excluding fees.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecipientName || string || &lt;br /&gt;
* Required&lt;br /&gt;
|| The name of the recipient of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment|| string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Maximum length: 90 characters&lt;br /&gt;
|| The comment of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| BankAccount|| [[BankAccount]] || &lt;br /&gt;
* Required&lt;br /&gt;
|| Information about the recipient&#039;s bank account.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TransactionId || Guid || The unique identifier of the bank transfer, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || The currency of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || The total amount transferred.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecipientName || string || The name of the recipient of the transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment || string || The comment of the bank transfer&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| BankAccount|| [[BankAccount]] || The bank account data.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Possible error responses  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Error code || Description&lt;br /&gt;
|-&lt;br /&gt;
| ModelValidationError || This happens when some of the input properties fail the basic validation. For example a string property exceeds its allowed length.&lt;br /&gt;
|-&lt;br /&gt;
| AuthenticationFailed || The provided authentication is not correct.&lt;br /&gt;
|-&lt;br /&gt;
| MinimumWithdrawAmountNotReached || The amount specified does not reach the minimum bank transfer amount. &#039;&#039;&#039;This is not in production yet&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCharacter || One of the characters is invalid for the bank transfer process&lt;br /&gt;
|-&lt;br /&gt;
| InvalidAccount || There is no account belonging to the user with the specified currency.&lt;br /&gt;
|-&lt;br /&gt;
| InappropriateVerificationLevel || The user does not have the verification level to be able to transfer.&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCurrency || The system does not support the specified currency&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCountry || The Country specified in the BankAccount field is invalid.&lt;br /&gt;
|-&lt;br /&gt;
| LowBalance || There are not enough funds to cover the withdraw amount and the fee.&lt;br /&gt;
|-&lt;br /&gt;
| BankAccountNumberBlackListed || The target bankaccount number is on blacklist, the withdraw process is terminated and the customer gets suspended. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsOverWithdrawLimit|| The withdraw amount exceeded the allowed limit for non-verified customers, the withdraw process is terminated and the customer gets suspended. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsDeleted || The user is deleted from the system, the withdraw is not possible. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsSuspended || The user is suspended until the suspension is lifted no withdraws are allowed.&lt;br /&gt;
|-&lt;br /&gt;
| WithdrawFromCustomerAccountToSystemAccount || Withdraw to the specified target account is not allowed.&lt;br /&gt;
|-&lt;br /&gt;
| BankAccountNumberNotAllowed|| Target Bank account number not in the list of allowed bank account numbers for this account.&lt;br /&gt;
|-&lt;br /&gt;
| InternalServerError || Something unexpected happened&lt;br /&gt;
|-&lt;br /&gt;
| UnsupportedWithdraw || In the case of foreign CZK transfers (targeted outside of Czechia) this endpoint is not suitable to start the transfer. Please upgrade to the [[Withdraw-BankTransfer-v3|v3 version]].&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Bank transfer amount limitations  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Currency || Target country || Amount limitation&lt;br /&gt;
|-&lt;br /&gt;
| HUF || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| EUR || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| USD || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Czechia || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;s&amp;gt;CZK&amp;lt;/s&amp;gt; || &amp;lt;s&amp;gt;Not Czechia&amp;lt;/s&amp;gt; || &amp;lt;s&amp;gt;Minimum 100 CZK&amp;lt;/s&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Bank transfer character limitations  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Currency || Target country || Character limitation&lt;br /&gt;
|-&lt;br /&gt;
| HUF || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| EUR || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| USD || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Czechia || Allowed characters:&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, á, ä, č, ď, é, ě, í, ľ, ň, ó, ô, ö, ř, ŕ, š, ť, ú, ů, ü, ý, ž, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Á, Ä, Č, Ď, É, Ě, Í, Ľ, Ň, Ó, Ô, Ö, Ř, Ŕ, Š, Ť, Ú, Ů, Ü, Ý, Ž, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, &#039;, +, !, &amp;quot;, #, $, %, &amp;amp;, *, ;, &amp;lt;, =, &amp;gt;, @, [, ], ^, `, {, |, }, ~, §, SPACE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;s&amp;gt;CZK || &amp;lt;s&amp;gt;Not Czechia&amp;lt;/s&amp;gt; || &amp;lt;s&amp;gt;Allowed characters: &lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, &#039;, +, SPACE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&amp;lt;/s&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Withdraw-BankTransfer-v3&amp;diff=3736</id>
		<title>Withdraw-BankTransfer-v3</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Withdraw-BankTransfer-v3&amp;diff=3736"/>
		<updated>2022-11-15T10:52:39Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Initiate a bank transfer}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v3/Withdraw/BankTransfer&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/withdraw/banktransfer&amp;lt;/code&amp;gt; API endpoint is used to send money out of the Barion Wallet via bank (wire) transfer.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v3&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v3&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
* Accepted values: &lt;br /&gt;
** &amp;quot;CZK&amp;quot; (Czech crown)&lt;br /&gt;
** &amp;quot;EUR&amp;quot; (Euro)&lt;br /&gt;
** &amp;quot;HUF&amp;quot; (Hungarian forint)&lt;br /&gt;
** &amp;quot;USD&amp;quot; (U.S. dollar)&lt;br /&gt;
|| The currency of the bank transfer. &lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; Barion does not do currency rate conversion. The caller must have an active account with the selected currency, and must ensure that the target bank accepts the selected currency.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || &lt;br /&gt;
* Required&lt;br /&gt;
* Must be greater than zero&lt;br /&gt;
|| The total amount to withdraw, excluding fees.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment|| string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Maximum length: 90 characters&lt;br /&gt;
|| The comment of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| BankAccount|| [[BankAccountDetails]] || &lt;br /&gt;
* Required&lt;br /&gt;
|| Information about the recipient&#039;s bank account.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Bank|| [[BankDetails]] || &lt;br /&gt;
* Required for foreign withdrawals&lt;br /&gt;
|| Information about the recipient&#039;s bank.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Recipient|| [[RecipientDetails]] || &lt;br /&gt;
* Required&lt;br /&gt;
|| Information about the recipient.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
== Example requests ==&lt;br /&gt;
[[Withdraw-BankTransfer-v3-examples]]&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TransactionId || Guid || The unique identifier of the bank transfer, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || The currency of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || The total amount transferred.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment || string || The comment of the bank transfer&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| BankAccount|| [[BankAccountDetails]] || Information about the recipient&#039;s bank account.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Bank|| [[BankDetails]] || Information about the recipient&#039;s bank.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Recipient|| [[RecipientDetails]] || Information about the recipient.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Possible error responses  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Error code || Description&lt;br /&gt;
|-&lt;br /&gt;
| ModelValidationError || This happens when some of the input properties fail the basic validation. For example a string property exceeds its allowed length.&lt;br /&gt;
|-&lt;br /&gt;
| AuthenticationFailed || The provided authentication is not correct.&lt;br /&gt;
|-&lt;br /&gt;
| MinimumWithdrawAmountNotReached || The amount specified does not reach the minimum bank transfer amount. &#039;&#039;&#039;This is not in production yet&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCharacter || One of the characters is invalid for the bank transfer process&lt;br /&gt;
|-&lt;br /&gt;
| InvalidAccount || There is no account belonging to the user with the specified currency.&lt;br /&gt;
|-&lt;br /&gt;
| InappropriateVerificationLevel || The user does not have the verification level to be able to transfer.&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCurrency || The system does not support the specified currency&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCountry || The Country specified in the BankAccount field is invalid.&lt;br /&gt;
|-&lt;br /&gt;
| LowBalance || There are not enough funds to cover the withdraw amount and the fee.&lt;br /&gt;
|-&lt;br /&gt;
| BankAccountNumberBlackListed || The target bankaccount number is on blacklist, the withdraw process is terminated and the customer gets suspended. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsOverWithdrawLimit|| The withdraw amount exceeded the allowed limit for non-verified customers, the withdraw process is terminated and the customer gets suspended. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsDeleted || The user is deleted from the system, the withdraw is not possible. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsSuspended || The user is suspended until the suspension is lifted no withdraws are allowed.&lt;br /&gt;
|-&lt;br /&gt;
| WithdrawFromCustomerAccountToSystemAccount || Withdraw to the specified target account is not allowed.&lt;br /&gt;
|-&lt;br /&gt;
| BankAccountNumberNotAllowed|| Target Bank account number not in the list of allowed bank account numbers for this account.&lt;br /&gt;
|-&lt;br /&gt;
| InternalServerError || Something unexpected happened&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Bank transfer amount limitations  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Currency || Target country || Amount limitation&lt;br /&gt;
|-&lt;br /&gt;
| HUF || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| EUR || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| USD || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Czechia || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Not Czechia || Minimum 100 CZK&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Bank transfer character limitations  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Currency || Target country || Character limitation&lt;br /&gt;
|-&lt;br /&gt;
| HUF || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| EUR || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| USD || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Czechia || Allowed characters: &lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, á, ä, č, ď, é, ě, í, ľ, ň, ó, ô, ö, ř, ŕ, š, ť, ú, ů, ü, ý, ž, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Á, Ä, Č, Ď, É, Ě, Í, Ľ, Ň, Ó, Ô, Ö, Ř, Ŕ, Š, Ť, Ú, Ů, Ü, Ý, Ž, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, &#039;, +, !, &amp;quot;, #, $, %, &amp;amp;, *, ;, &amp;lt;, =, &amp;gt;, @, [, ], ^, `, {, |, }, ~, §, SPACE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Not Czechia || Allowed characters: &lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, &#039;, +, SPACE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Accounts-Get-v2&amp;diff=3735</id>
		<title>Accounts-Get-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Accounts-Get-v2&amp;diff=3735"/>
		<updated>2022-11-15T10:52:23Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Get existing accounts of the user}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=GET&lt;br /&gt;
|uri=/v2/Accounts&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/accounts&amp;lt;/code&amp;gt; API endpoint is used to query the existing accounts of the calling user.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* API: [[Transfer-Email-v2 | /Transfer/Email]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| Accounts || [[Account]][] || The list of accounts in the user&#039;s Barion wallet&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-Refund-v2&amp;diff=3734</id>
		<title>Payment-Refund-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-Refund-v2&amp;diff=3734"/>
		<updated>2022-11-15T10:51:36Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Execute the refund of a payment}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/Refund&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/refund&amp;lt;/code&amp;gt; API endpoint is used to execute a refund of an existing, completed payment.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* API: [[Payment-Start-v2 | /Payment/Start]]&lt;br /&gt;
* API: [[Payment-GetPaymentState-v2 | /Payment/GetPaymentState]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Shop Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Responsive_web_payment|Responsive Web Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentId || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TransactionsToRefund || [[TransactionToRefund]][] || &lt;br /&gt;
* Required&lt;br /&gt;
|| An array containing the payment transactions to refund.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RefundedTransactions || [[RefundedTransaction]][] || An array containing information about the refunded transactions.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Possible error responses  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Error code || Description&lt;br /&gt;
|-&lt;br /&gt;
| ModelValidationError || This happens when some of the input properties fail the basic validation. For example a string property exceeds its allowed length.&lt;br /&gt;
|-&lt;br /&gt;
| NotExistingPaymentId || The specified payment id is invalid.&lt;br /&gt;
|-&lt;br /&gt;
| SuspendedUserTriedToRefund || You are not allowed to refund a payment if you are suspended.&lt;br /&gt;
|-&lt;br /&gt;
| TheSourceAndDestinationAccountsAreMatched || Very rare error, this happens in case the payment was payed by the shop owner.&lt;br /&gt;
|-&lt;br /&gt;
| PaymentStatusNotValid || Only payments in &amp;lt;code&amp;gt;Succeeded&amp;lt;/code&amp;gt; [[PaymentStatus|status]] can be refunded.&lt;br /&gt;
|-&lt;br /&gt;
| TransactionDoesNotBelongToPayment || The transaction specified in the request body does not belong to a payment.&lt;br /&gt;
|- &lt;br /&gt;
| InvalidTransactionType || The transaction specified is not a refundable [[TransactionType|transaction type]]. Only &amp;lt;code&amp;gt;CardPayment&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;Shop&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;BankTransferPayment&amp;lt;/code&amp;gt; types are refundable.&lt;br /&gt;
|-&lt;br /&gt;
| InvalidAccount || The account is not eligable for refund.&lt;br /&gt;
|- &lt;br /&gt;
| TooLowBalanceToMakeRefund || There is not enough funds to fulfill the refund request.&lt;br /&gt;
|-&lt;br /&gt;
| AmountToRefundIsGreaterThanTransactionAmount || The amount specified to refund is greater than the original payment transaction itself.&lt;br /&gt;
|- &lt;br /&gt;
| InternalServerError || Something unexpected happened.&lt;br /&gt;
|- &lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-CancelAuthorization-v2&amp;diff=3733</id>
		<title>Payment-CancelAuthorization-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-CancelAuthorization-v2&amp;diff=3733"/>
		<updated>2022-11-15T10:51:19Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Cancel an authorized payment}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/CancelAuthorization&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/cancelauthorization&amp;lt;/code&amp;gt; API endpoint is used to cancel an existing, previously authorized payment. All transactions are reversed, and the payment is finished with 0 amount. The blocking of the amount on the payment card is lifted.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* API: [[Payment-Start-v2 | /Payment/Start]]&lt;br /&gt;
* API: [[Payment-GetPaymentState-v2 | /Payment/GetPaymentState]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=In some cases, the card issuers do not release the authorized amount immediately after the Barion sends the appropriate message to them. In these cases, the transaction amount will be released automatically by the issuer bank within a few days after the merchant canceled the payment.|color=#1993C7}}&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=&lt;br /&gt;
The cancelation called within one day after the authorization request can be much faster than the release completed later. In most cases, the intraday cancelation immediately releases the amount on the cardholder&#039;s account.|color=#1993C7}}&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Shop Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Responsive_web_payment|Responsive Web Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentId || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
|IsSuccessful || bool || Result of the transaction&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the payment, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Status || [[PaymentStatus]]|| The status of the payment in the Barion system. &lt;br /&gt;
&lt;br /&gt;
|- &lt;br /&gt;
|Transactions|| [[ProcessedTransaction]][] || Related transactions&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-Capture-v2&amp;diff=3732</id>
		<title>Payment-Capture-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-Capture-v2&amp;diff=3732"/>
		<updated>2022-11-15T10:50:53Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Capture of a payment}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/Capture&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/capure&amp;lt;/code&amp;gt; API endpoint is used to capture (finish) an existing, previously authorized payment. All transactions are finished with the amount specified in this request, regardless of the amount specified in the StartPayment.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* API: [[Payment-Start-v2 | /Payment/Start]]&lt;br /&gt;
* API: [[Payment-GetPaymentState-v2 | /Payment/GetPaymentState]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Shop Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Responsive_web_payment|Responsive Web Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentId || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Transactions || [[TransactionToFinish]][] || &lt;br /&gt;
* Required&lt;br /&gt;
|| An array containing the payment transactions to capture. All transactions must be supplied. &lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
|IsSuccessful || bool || Result of the transaction&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the payment, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Status || [[PaymentStatus]]|| The status of the payment in the Barion system. &lt;br /&gt;
&lt;br /&gt;
|- &lt;br /&gt;
|Transactions|| [[ProcessedTransaction]][] || Related transactions&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-FinishReservation-v2&amp;diff=3731</id>
		<title>Payment-FinishReservation-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-FinishReservation-v2&amp;diff=3731"/>
		<updated>2022-11-15T10:50:12Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Finish a pending reservation}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/FinishReservation&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/finishreservation&amp;lt;/code&amp;gt; API endpoint is used to finalize a pending reservation in the Barion system.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API| Start a payment]]&lt;br /&gt;
* API: [[Payment-Start-v2 | /Payment/Start]]&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Shop Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Reservation_payment|Payments with reservation]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
|PaymentId || Guid || &lt;br /&gt;
* Required &lt;br /&gt;
|| The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
|Transactions || [[TransactionToFinish]][] || &lt;br /&gt;
* Required &lt;br /&gt;
|| The &amp;lt;u&amp;gt;payment transactions&amp;lt;/u&amp;gt; that the shop would like to finish.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Important things about the transaction structure ===&lt;br /&gt;
* The Transactions[] array should only contain the &amp;lt;u&amp;gt;initial&amp;lt;/u&amp;gt; payment transactions. The additional transactions generated by the Barion system (e.g. fees) must not be included in the call.&lt;br /&gt;
* Each payment transaction can only be finished once.&lt;br /&gt;
* It is not neccessary to finish all transactions in the same API call, but one call must contain at least one transaction to finish.&lt;br /&gt;
* If a transaction is finished with a &#039;&#039;&#039;Total&#039;&#039;&#039; amount lesser than its initial value, the remaining amount is refunded to the payer.&lt;br /&gt;
* If the reservation period passes, all unfinished transactions are finished with zero amount.&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
|IsSuccessful || bool || Result of the transaction&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the newly initialized payment, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Status || [[PaymentStatus]]|| The status of the payment in the Barion system. &lt;br /&gt;
&lt;br /&gt;
|- &lt;br /&gt;
|Transactions|| [[ProcessedTransaction]][] || Related transactions&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-Complete-v2&amp;diff=3730</id>
		<title>Payment-Complete-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-Complete-v2&amp;diff=3730"/>
		<updated>2022-11-15T10:49:00Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Complete a payment}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod | method=POST |uri=/v2/Payment/Complete }}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/CompletePayment&amp;lt;/code&amp;gt; API endpoint is used to complete a formerly prepared and 3DS authenticated payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Shop Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Token_payment_3D_Secure|Token Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || * Required|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || * Required|| The identifier of the formerly initialized and authenticated payment, generated by the Barion system.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the payment, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentStatus || [[PaymentStatus]]|| The status of the payment in the Barion system. &lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| IsSuccessful || bool || Indicates whether the charge was successful&lt;br /&gt;
|-&lt;br /&gt;
| TraceId || string || Identifies the nature of the token payment. &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-GetPaymentState-v2&amp;diff=3729</id>
		<title>Payment-GetPaymentState-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-GetPaymentState-v2&amp;diff=3729"/>
		<updated>2022-11-15T10:47:33Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Request the current state of a payment}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=GET&lt;br /&gt;
|uri=/v2/Payment/GetPaymentState&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/getpaymentstate&amp;lt;/code&amp;gt; API endpoint is used to query the details and current state of a given payment.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* API: [[Payment-Start-v2 | /Payment/Start]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Shop Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Responsive_web_payment|Responsive Web Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentId || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The identifier of the payment in the shop&#039;s system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| POSId || Guid || The public identifier of the shop that created the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| POSName || string || The name of the shop that created the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| POSOwnerEmail || string || The e-mail address of the owner of the shop that created the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| POSOwnerCountry || string || ISO2 country code of the owner of the shop that created the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Status || [[PaymentStatus]] || The current status of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentType || string || The type of the payment. Can be &amp;lt;code&amp;gt;Immediate&amp;lt;/code&amp;gt; or &amp;lt;code&amp;gt;Reservation&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| AllowedFundingSources || string[] || The allowed funding sources that were defined when creating the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FundingSource || string || The funding source that was used to complete the payment. If the payment is not yet completed, this is empty. Can be &amp;lt;code&amp;gt;Balance&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;BankCard&amp;lt;/code&amp;gt; or &amp;lt;code&amp;gt;BankTransfer&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FundingInformation || [[FundingInformation]] || Detailed information about the funding source that was used to complete the payment. If the payment is not yet completed, this is empty.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecurrenceType || [[RecurrenceType]] || The RecurrenceType that was defined in the payment/start request for the recurring scenario.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TraceId || string || The Trace Id that identifies that recurring scenario. Read more about this [[Token_payment_3D_Secure|here]]&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| GuestCheckout || bool || Indicates whether the payment allows guest checkout.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| CreatedAt || DateTime || The timestamp showing when the payment was created.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| StartedAt || DateTime || The timestamp showing when a reservation payment was started. If the payment type is not reservation, this is empty.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| CompletedAt || DateTime || The timestamp showing when the payment was completed. If the payment is not yet completed, this is empty.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ValidUntil || DateTime || Timestamp showing the expiration time of the payment time window. The payment must be completed before this elapses.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ReservedUntil || DateTime || Timestamp showing the expiration time of the reservation time window. The reserved payment must be finished before this elapses. If the payment type is not reservation, this is empty.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| DelayedCaptureUntil || DateTime || Timestamp showing the expiration time of the authorization time window. The authorized payment must be finished before this elapses. If the payment type is not DelayedCapture, this is empty.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Transactions || [[DetailedPaymentTransaction]][] || An array containing a detailed structure of all transactions associated with the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Total || decimal || The total amount of the payment &amp;lt;u&amp;gt;at the time of the request&amp;lt;/u&amp;gt;. If a reservation was finished with a lower amount, or a previously completed payment was refunded, this can be less than at the time of creation.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || The 3 character ISO 4217 currency code of the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| SuggestedLocale || string || Indicates in which language the Barion Smart Gateway should be shown for the payer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FraudRiskScore || int || A risk score computed by the anti-fraud analysis, between a range of 0 (completely legit) to 100 (certain fraud). Transactions under 10 are usually safe. Transactions with 10 an more, but less than 30 are risky, caution is advised. Transactions with 30 and over are blocked automatically for being almost certainly fraudulent.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| CallbackUrl || string || The URL (including the payment identifier) where the Barion system will send (or already sent) a request to whenever there is a change in the state of the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RedirectUrl || string|| The URL (including the payment identifier) where the payer gets (or already got) redirected to after the payment is or was completed or cancelled.&lt;br /&gt;
&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-Start-v2&amp;diff=3728</id>
		<title>Payment-Start-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-Start-v2&amp;diff=3728"/>
		<updated>2022-11-15T10:47:04Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Initialize a new payment}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/Start&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/start&amp;lt;/code&amp;gt; API endpoint is used to create a new payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
[[Barion Shop Authentication]]&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Responsive_web_payment|Responsive Web Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{|&lt;br /&gt;
|-&lt;br /&gt;
|{{3dsfield}} || Properties marked with this must be provided to comply with 3D Secure authentication. The more attributes you provide the more chance you have to avoid the challenge flow.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&#039;&#039;&#039;Important:&#039;&#039;&#039; if the merchant does not provide 3DS-related properties, it doesn&#039;t mean that the payment will fail. It means that the payer will have a higher chance of getting a challenge during payment.&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentType || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Accepted values: &lt;br /&gt;
** &amp;quot;Immediate&amp;quot;&lt;br /&gt;
** &amp;quot;Reservation&amp;quot;&lt;br /&gt;
** &amp;quot;DelayedCapture&amp;quot; &lt;br /&gt;
|| The type of payment, which can be either immediate or a money reservation. Reservation means that the shop has a time window to finish the payment (even though the money transaction still takes place immediately). Reservation amounts can be modified during this time window unless the new amount is lower than the original. &lt;br /&gt;
Click here to learn more about reservation payments: [[Reservation_payment|Reservation payments]], and delayed capture: [[Delayed_Capture|Delayed capture]].&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ReservationPeriod || TimeSpan (d.hh:mm:ss) || &lt;br /&gt;
* Required only if PaymentType is &amp;quot;Reservation&amp;quot;&lt;br /&gt;
* Minimum value: one minute&lt;br /&gt;
* Maximum value: one year&lt;br /&gt;
* Default value: 30 minutes&lt;br /&gt;
|| Only makes sense at reservation payments. This is the time window that allows the shop to finish (finalize) the payment. If this does not happen within the time window, the system refunds the payment amount to the payer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| DelayedCapturePeriod || TimeSpan (d.hh:mm:ss) || &lt;br /&gt;
* Required only if PaymentType is &amp;quot;DelayedCapture&amp;quot;&lt;br /&gt;
* Minimum value: one minute&lt;br /&gt;
* Maximum value: 7 days (21 days in case of a Hungarian shop)&lt;br /&gt;
* Default value: seven days&lt;br /&gt;
|| This is the time window that allows the shop to complete (finalize) the payment. If this does not happen within the time window, the system releases the payment amount.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentWindow || TimeSpan (d.hh:mm:ss) || &lt;br /&gt;
* Optional&lt;br /&gt;
* Minimum value: one minute&lt;br /&gt;
* Maximum value: one week&lt;br /&gt;
* Default value: 30 minutes&lt;br /&gt;
|| Time window for the payment to be completed. The payer must execute the payment before this elapses, or else the payment will expire and can no longer be completed.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| GuestCheckOut || bool || &lt;br /&gt;
* Required&lt;br /&gt;
* Value must be &amp;quot;true&amp;quot; or &amp;quot;false&amp;quot;, integer evaluation is not supported&lt;br /&gt;
|| Flag indicating whether the payment can be completed without a registered Barion wallet. Guest checkout can only be done with bank cards, and the payer must supply a valid e-mail address - this is necessary for fraud control.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| InitiateRecurrence || bool || &lt;br /&gt;
* Optional&lt;br /&gt;
|| This flag indicates that the shop would like to initialize a token payment. This means that the shop is authorized to charge the funding source of the payer in the future without redirecting her/him to the Barion Smart Gateway. It can be used for one-click and subscription payment scenarios. &lt;br /&gt;
Click here to learn more about token payments: [[Token_payment]]&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecurrenceId || string || &lt;br /&gt;
* Required when executing token payments&lt;br /&gt;
* Maximum length: 100 characters&lt;br /&gt;
* Must be unique per shop and per user&lt;br /&gt;
* [https://docs.barion.com/Token_payment#Creating_the_token Generated by the shop]&lt;br /&gt;
|| A string used to identify a given token payment. Its purpose is determined by the value of the &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; property.&lt;br /&gt;
* If &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; is &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt;, this property must contain a &amp;lt;u&amp;gt;new&amp;lt;/u&amp;gt; desired identifier for a new token payment. This should be generated and stored by the shop before calling the API. Also, the shop must ensure that this is unique per user in its own system.&lt;br /&gt;
* If &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; is &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt;, this property must contain an &amp;lt;u&amp;gt;existing&amp;lt;/u&amp;gt; identifier for a token payment. This should be used to charge a payer&#039;s funding source (either bank card or Barion wallet) that was already used successfully for a payment in the shop.&lt;br /&gt;
* multiple shops can use the same RecurrenceId. Should you be interested, please contact merchanthelpdesk@barion.com&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
| FundingSources || [[FundingSources|string[]]] || &lt;br /&gt;
* Required&lt;br /&gt;
|| An array of strings containing the allowed funding sources that can be used to complete the payment.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Maximum length: 100 characters&lt;br /&gt;
|| The unique identifier for the payment generated by the shop. This is so the shop can track its own payment identifiers. It is also useful for bookkeeping purposes since this shows up in the monthly account statement and the transaction history export, making identification of payments easier for the shop.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
| PayerHint || string || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
* Optional, but recommended. &lt;br /&gt;
* If provided, must be a valid email format&lt;br /&gt;
* Maximum length: 256 characters&lt;br /&gt;
|| The shop can supply an e-mail address as a hint on who should complete the payment. This can be used if the shop is certain about that the payer has an active Barion wallet or the shop would like to help the guest payer with filling in the email field for her/him. If provided, the Barion Smart Gateway automatically fills out the e-mail address field in the Barion wallet login form and the guest payer form, speeding up the payment process.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| CardHolderNameHint || string || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
* Optional, but recommended&lt;br /&gt;
* Between 2 and 45 characters&lt;br /&gt;
|| The shop can provide a hint for the customer&#039;s name on the card to speed up the payment flow. If a value is provided, the cardholder name input will be pre-filled with it and the customer can use the pre-filled value instead of typing it out on its own, which speeds up the payment process.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecurrenceType || [[RecurrenceType]] || &lt;br /&gt;
* Required for {{3dsfield}}, when executing token payments&lt;br /&gt;
|| Describes the nature of the token payment.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TraceId || string || &lt;br /&gt;
* Required for {{3dsfield}}, when executing token payments&lt;br /&gt;
* Maximum length: 100 characters&lt;br /&gt;
|| Identifies the nature of the token payment. &lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RedirectUrl || string || &lt;br /&gt;
* Required &lt;br /&gt;
* Maximum length: 2000 characters&lt;br /&gt;
|| The URL where the payer should be redirected after the payment is completed or canceled. The payment identifier is added to the query string part of this URL in the &amp;lt;code&amp;gt;paymentId&amp;lt;/code&amp;gt; parameter. If not provided, the system will use the redirect URL assigned to the shop that started the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| CallbackUrl || string || &lt;br /&gt;
* Required &lt;br /&gt;
* Maximum length: 2000 characters&lt;br /&gt;
|| The URL where the Barion system sends a request whenever there is a change in the state of the payment. The payment identifier is added to the query string part of this URL in the &amp;lt;code&amp;gt;paymentId&amp;lt;/code&amp;gt; parameter. Click here to learn more about the callback mechanism: [[Callback_mechanism|Payment callback mechanism (IPN)]]&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Transactions || [[PaymentTransaction]][] || &lt;br /&gt;
* Required&lt;br /&gt;
|| An array of payment transactions contained in the payment. A payment must contain at least one such transaction. See the [[PaymentTransaction]] page for the appropriate structure and syntax.&lt;br /&gt;
Defining multiple transactions allow the payment initiator to distribute the payment amount between multiple shops. See the following page to learn more: [[Facilitated payments]]&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| OrderNumber || string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Maximum length: 100 characters&lt;br /&gt;
|| The order number generated by the shop. This is to aid the shop in identifying a given payment in its own system. This also shows up in generated monthly account statements and transaction history exports, so it also helps with bookkeeping.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ShippingAddress || [[ShippingAddress]] || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
|| The shipping address associated with the payment, if applicable. Providing this is recommended because it helps the automatic anti-fraud analysis get more accurate results. See the [[ShippingAddress]] page for the appropriate structure and syntax.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Locale || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Maximum length: 10 characters&lt;br /&gt;
* Accepted values: &lt;br /&gt;
** &amp;quot;cs-CZ&amp;quot; (Czech)&lt;br /&gt;
** &amp;quot;de-DE&amp;quot; (German)&lt;br /&gt;
** &amp;quot;en-US&amp;quot; (English)&lt;br /&gt;
** &amp;quot;es-ES&amp;quot; (Spanish)&lt;br /&gt;
** &amp;quot;fr-FR&amp;quot; (French)&lt;br /&gt;
** &amp;quot;hu-HU&amp;quot; (Hungarian)&lt;br /&gt;
** &amp;quot;sk-SK&amp;quot; (Slovak)&lt;br /&gt;
** &amp;quot;sl-SI&amp;quot; (Slovenian)&lt;br /&gt;
|| This indicates in which language the Barion Smart Gateway should display for the payer upon redirect. &lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
Accepted values: &lt;br /&gt;
{{CurrencyList}}&lt;br /&gt;
|| The currency of the payment. Must be supplied in ISO 4217 format. This affects all transactions included in the payment; it is not possible to define multiple transactions in different currencies.&lt;br /&gt;
|-&lt;br /&gt;
| PayerPhoneNumber || string || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
* Max length: 30 characters&lt;br /&gt;
* Expected format: 36701231234 (where 36 is the country code)&lt;br /&gt;
|| The number must be sent in the expected format, without + sign or leading zero(s).&lt;br /&gt;
|-&lt;br /&gt;
| PayerWorkPhoneNumber || string || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
* Max length: 30 characters&lt;br /&gt;
* Expected format: 36701231234 (where 36 is the country code)&lt;br /&gt;
|| The work phone of the payer. The number must be sent in the expected format, without + sign or leading zero(s).&lt;br /&gt;
|-&lt;br /&gt;
| PayerHomeNumber || string || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
* Max length: 30 characters&lt;br /&gt;
* Expected format: 36701231234 (where 36 is the country code)&lt;br /&gt;
|| The home phone number of the payer. The number must be sent in the expected format, without + sign or leading zero(s).&lt;br /&gt;
|-&lt;br /&gt;
| BillingAddress || [[BillingAddress]] || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
|| The billing address associated with the payment, if applicable.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PayerAccountInformation|| [[PayerAccountInformation]] || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
|| Information about the account of the payer in the merchant&#039;s system.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PurchaseInformation|| [[PurchaseInformation]] || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
|| Information about current purchase.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ChallengePreference || [[ChallengePreference]] || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
|| The merchant&#039;s preference of the 3DS challenge. Here you can specify what 3DS authentication should be utilized.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the newly initialized payment, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Status || [[PaymentStatus]]|| The status of the payment in the Barion system. &lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| QRUrl || string || URL for a QR code representing the payment. This is useful in physical real life situations where the payer uses a mobile device.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecurrenceResult || RecurrenceResult || Indicates the result of an authorized payment scenario. The result depends on the values of the &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; and &#039;&#039;&#039;RecurrenceId&#039;&#039;&#039; properties supplied in the request.&lt;br /&gt;
&lt;br /&gt;
* If &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; was &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt;, and a new authorized payment was successfully created, this will be &amp;lt;code&amp;gt;None&amp;lt;/code&amp;gt; (because no actual token charge took place yet)&lt;br /&gt;
&lt;br /&gt;
* If &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; was &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt;, but a previously authorized payment identifier was supplied in &#039;&#039;&#039;RecurrenceId&#039;&#039;&#039;, the system will try to charge the funding source associated with the authorized payment. If this charge is successful, the result is &amp;lt;code&amp;gt;Successful&amp;lt;/code&amp;gt;. If the system could not charge the funding source, the result is &amp;lt;code&amp;gt;Failed&amp;lt;/code&amp;gt;. If the given identifier is invalid or does not exist, the result is &amp;lt;code&amp;gt;NotFound&amp;lt;/code&amp;gt;. In case the payment can not be processed due to lack of 3DS v2 information &amp;lt;code&amp;gt;ThreeDSAuthenticationRequired&amp;lt;/code&amp;gt; is returned. In this case, either offsite 3DS v2 authentication should be performed or the TraceId of the initial payment should be sent as well.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Transactions || [[ProcessedTransaction]][] || An array containing all transactions associated with the payment. If the Barion system deducts fees from the shop after payments, this also contains these additional fee transactions beside the payment transactions that were sent in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| GatewayUrl || string || The URL of the Barion Smart Gateway (including the payment identifier), where the API caller should redirect the payer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| CallbackUrl || string || The URL (including the payment identifier) where the Barion system will send a request to whenever there is a change in the state of the payment. If an explicit URL was not supplied, this will be the callback URL associated with the shop that started the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RedirectUrl || string || The URL (including the payment identifier) where the payer gets redirected to after the payment is completed or cancelled. If an explicit URL was not supplied, this will be the redirect URL associated with the shop that started the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ThreeDSAuthClientData|| string || Encrypted client authentication data required for 3D Secure processing. This value can be used when the webshop first tried to complete the payment without user interaction, but the charge failed due to a 3D Secure challenge being mandatory.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TraceId || string || A unique value generated by the card issuer to track a chain of [[Token_payment_3D_Secure|recurring or token payments that require 3D Secure authentication]]. This shall be used in such scenarios, otherwise it can be ignored.&lt;br /&gt;
&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3726</id>
		<title>Barion Wallet Authentication</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3726"/>
		<updated>2022-11-15T10:27:19Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{NotificationBox|title=IMPORTANT|text=This feature is currently only available in the sandbox environment, it will be active in production by 21. November 2022. Until it becomes active, you can use [[Basic authentication]] for wallet-level endpoints in the production environment. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= What is wallet authentication? =&lt;br /&gt;
&lt;br /&gt;
Some API endpoints can only be reached using wallet-level authentication (for a full list see [[List_of_API_endpoints|List of Barion API endpoints]]). This is achieved through the usage of API keys tied to each wallet.&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=This feature is only available to organizations registered to Barion. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= Using API keys =&lt;br /&gt;
&lt;br /&gt;
To use an endpoint which requires wallet-level authentication, simply send your API key in the &amp;lt;code&amp;gt;x-api-key&amp;lt;/code&amp;gt; header of your request.&lt;br /&gt;
&lt;br /&gt;
The format of the key should be with lower case letters and &amp;lt;strong&amp;gt;without dashes&amp;lt;/strong&amp;gt;. You can directly use values copied from the secure site&#039;s access page.&lt;br /&gt;
&lt;br /&gt;
= Managing API keys =&lt;br /&gt;
&lt;br /&gt;
The management interface of wallet-level API keys can be found on the [https://secure.barion.com Barion secure site] under the &amp;lt;tt&amp;gt;Wallet -&amp;gt; Access&amp;lt;/tt&amp;gt; menu item.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page.png|The wallet key management page with only one active API key]]&lt;br /&gt;
&lt;br /&gt;
You can view your currently active API key or place it onto the clipboard via clicking the icons on the right side of the screen.&lt;br /&gt;
&lt;br /&gt;
== Rotating keys ==&lt;br /&gt;
&lt;br /&gt;
In case a key&#039;s secrecy is compromised it is important to change it to avoid unauthorized parties from using Barion in your name.&lt;br /&gt;
&lt;br /&gt;
You can add a new API key to your wallet by clicking the &amp;quot;rotate&amp;quot; icon to the right of the key. &amp;lt;strong&amp;gt;This does not deactivate the old API key&amp;lt;/strong&amp;gt;, it just adds a new one. After changing all usages of the old key to the new one, the old one can be safely deleted.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page_-_under_rotation.png|The wallet key management page with two active API keys]]&lt;br /&gt;
&lt;br /&gt;
As there can only be at most two active API keys tied to a wallet at all times, it is not possible to rotate one of two active keys. You&#039;ll have to delete one of them to start rotating the other one.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3725</id>
		<title>Barion Wallet Authentication</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3725"/>
		<updated>2022-11-15T10:26:46Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: add exact prod date&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{NotificationBox|title=IMPORTANT|text=This feature is currently only available in the sandbox environment, it will be active in production by 21. November 2022. Until it becomes active, you can use [[Basic authentication]] for wallet-level endpoints. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= What is wallet authentication? =&lt;br /&gt;
&lt;br /&gt;
Some API endpoints can only be reached using wallet-level authentication (for a full list see [[List_of_API_endpoints|List of Barion API endpoints]]). This is achieved through the usage of API keys tied to each wallet.&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=This feature is only available to organizations registered to Barion. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= Using API keys =&lt;br /&gt;
&lt;br /&gt;
To use an endpoint which requires wallet-level authentication, simply send your API key in the &amp;lt;code&amp;gt;x-api-key&amp;lt;/code&amp;gt; header of your request.&lt;br /&gt;
&lt;br /&gt;
The format of the key should be with lower case letters and &amp;lt;strong&amp;gt;without dashes&amp;lt;/strong&amp;gt;. You can directly use values copied from the secure site&#039;s access page.&lt;br /&gt;
&lt;br /&gt;
= Managing API keys =&lt;br /&gt;
&lt;br /&gt;
The management interface of wallet-level API keys can be found on the [https://secure.barion.com Barion secure site] under the &amp;lt;tt&amp;gt;Wallet -&amp;gt; Access&amp;lt;/tt&amp;gt; menu item.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page.png|The wallet key management page with only one active API key]]&lt;br /&gt;
&lt;br /&gt;
You can view your currently active API key or place it onto the clipboard via clicking the icons on the right side of the screen.&lt;br /&gt;
&lt;br /&gt;
== Rotating keys ==&lt;br /&gt;
&lt;br /&gt;
In case a key&#039;s secrecy is compromised it is important to change it to avoid unauthorized parties from using Barion in your name.&lt;br /&gt;
&lt;br /&gt;
You can add a new API key to your wallet by clicking the &amp;quot;rotate&amp;quot; icon to the right of the key. &amp;lt;strong&amp;gt;This does not deactivate the old API key&amp;lt;/strong&amp;gt;, it just adds a new one. After changing all usages of the old key to the new one, the old one can be safely deleted.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page_-_under_rotation.png|The wallet key management page with two active API keys]]&lt;br /&gt;
&lt;br /&gt;
As there can only be at most two active API keys tied to a wallet at all times, it is not possible to rotate one of two active keys. You&#039;ll have to delete one of them to start rotating the other one.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=BankAccountInfo&amp;diff=3724</id>
		<title>BankAccountInfo</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=BankAccountInfo&amp;diff=3724"/>
		<updated>2022-11-15T10:24:47Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: create page initial version&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=BankAccountInfo structure}}&lt;br /&gt;
&lt;br /&gt;
The &#039;&#039;&#039;BankAccountInfo&#039;&#039;&#039; structure contains information about a bank account during the topup process.&lt;br /&gt;
&lt;br /&gt;
= API usage =&lt;br /&gt;
&lt;br /&gt;
This structure is used by the following API endpoints:&lt;br /&gt;
* [[Accounts-Get-v2|/Accounts]]&lt;br /&gt;
&lt;br /&gt;
= Properties =&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| BBAN || string || || The bank account number of the account in local format&lt;br /&gt;
|-&lt;br /&gt;
| BankAddress || string || || The street address of the bank&lt;br /&gt;
|-&lt;br /&gt;
| BankName || string || || The name of the bank&lt;br /&gt;
|-&lt;br /&gt;
| Comment || string || || The comment you must add to the transfer to connect it with the topup&lt;br /&gt;
|-&lt;br /&gt;
| IBAN || string || Valid IBAN format || The bank account number of the account in IBAN format&lt;br /&gt;
|-&lt;br /&gt;
| Recipient || string || || The name of the transfer&#039;s recipient&lt;br /&gt;
|-&lt;br /&gt;
| SwiftCode || string || || The swift code of the bank at which the account is opened&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=TopUpInfo&amp;diff=3723</id>
		<title>TopUpInfo</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=TopUpInfo&amp;diff=3723"/>
		<updated>2022-11-15T10:24:02Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: create page initial version&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=TopUpInfo structure}}&lt;br /&gt;
&lt;br /&gt;
The &#039;&#039;&#039;TopUpInfo&#039;&#039;&#039; structure contains information about ow to topup an account.&lt;br /&gt;
&lt;br /&gt;
= API usage =&lt;br /&gt;
&lt;br /&gt;
This structure is used by the following API endpoints:&lt;br /&gt;
* [[Accounts-Get-v2|/Accounts]]&lt;br /&gt;
&lt;br /&gt;
= Properties =&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| DomesticCountry || string || Two letter country code || The code of the country which counts as domestic for the topup&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FromDomesticCountry || [[BankAccountInfo]] || || Information about the bank account to use for the topup from the domestic country&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FromNonDomesticCountry || [[BankAccountInfo]] || || Information about the bank account to use for the topup from any othe than the domestic country&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Account&amp;diff=3722</id>
		<title>Account</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Account&amp;diff=3722"/>
		<updated>2022-11-15T10:23:37Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: add topupinfo data&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Account structure}}&lt;br /&gt;
&lt;br /&gt;
The &#039;&#039;&#039;Account&#039;&#039;&#039; structure represents an account in a Barion wallet.&lt;br /&gt;
&lt;br /&gt;
= API usage =&lt;br /&gt;
&lt;br /&gt;
This structure is used by the following API endpoints:&lt;br /&gt;
* [[Accounts-Get-v2|/Accounts]]&lt;br /&gt;
&lt;br /&gt;
= Properties =&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| AccountId || Guid || &lt;br /&gt;
|| The unique identifier of the account&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| Balance || [[Balance]] || &lt;br /&gt;
|| The current balance of the account&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| Currency || string || &lt;br /&gt;
|| The currency of the account in 3-letter ISO country code format&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| TopUpInfo || [[TopUpInfo]] ||&lt;br /&gt;
|| Information about how to topup the account.&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-Refund-v2&amp;diff=3721</id>
		<title>Payment-Refund-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-Refund-v2&amp;diff=3721"/>
		<updated>2022-11-15T10:22:15Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Execute the refund of a payment}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/Refund&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/refund&amp;lt;/code&amp;gt; API endpoint is used to execute a refund of an existing, completed payment.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Shop Authentication]]&lt;br /&gt;
* API: [[Payment-Start-v2 | /Payment/Start]]&lt;br /&gt;
* API: [[Payment-GetPaymentState-v2 | /Payment/GetPaymentState]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Responsive_web_payment|Responsive Web Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentId || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TransactionsToRefund || [[TransactionToRefund]][] || &lt;br /&gt;
* Required&lt;br /&gt;
|| An array containing the payment transactions to refund.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RefundedTransactions || [[RefundedTransaction]][] || An array containing information about the refunded transactions.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Possible error responses  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Error code || Description&lt;br /&gt;
|-&lt;br /&gt;
| ModelValidationError || This happens when some of the input properties fail the basic validation. For example a string property exceeds its allowed length.&lt;br /&gt;
|-&lt;br /&gt;
| NotExistingPaymentId || The specified payment id is invalid.&lt;br /&gt;
|-&lt;br /&gt;
| SuspendedUserTriedToRefund || You are not allowed to refund a payment if you are suspended.&lt;br /&gt;
|-&lt;br /&gt;
| TheSourceAndDestinationAccountsAreMatched || Very rare error, this happens in case the payment was payed by the shop owner.&lt;br /&gt;
|-&lt;br /&gt;
| PaymentStatusNotValid || Only payments in &amp;lt;code&amp;gt;Succeeded&amp;lt;/code&amp;gt; [[PaymentStatus|status]] can be refunded.&lt;br /&gt;
|-&lt;br /&gt;
| TransactionDoesNotBelongToPayment || The transaction specified in the request body does not belong to a payment.&lt;br /&gt;
|- &lt;br /&gt;
| InvalidTransactionType || The transaction specified is not a refundable [[TransactionType|transaction type]]. Only &amp;lt;code&amp;gt;CardPayment&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;Shop&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;BankTransferPayment&amp;lt;/code&amp;gt; types are refundable.&lt;br /&gt;
|-&lt;br /&gt;
| InvalidAccount || The account is not eligable for refund.&lt;br /&gt;
|- &lt;br /&gt;
| TooLowBalanceToMakeRefund || There is not enough funds to fulfill the refund request.&lt;br /&gt;
|-&lt;br /&gt;
| AmountToRefundIsGreaterThanTransactionAmount || The amount specified to refund is greater than the original payment transaction itself.&lt;br /&gt;
|- &lt;br /&gt;
| InternalServerError || Something unexpected happened.&lt;br /&gt;
|- &lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-CancelAuthorization-v2&amp;diff=3720</id>
		<title>Payment-CancelAuthorization-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-CancelAuthorization-v2&amp;diff=3720"/>
		<updated>2022-11-15T10:21:56Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Cancel an authorized payment}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/CancelAuthorization&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/cancelauthorization&amp;lt;/code&amp;gt; API endpoint is used to cancel an existing, previously authorized payment. All transactions are reversed, and the payment is finished with 0 amount. The blocking of the amount on the payment card is lifted.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Shop Authentication]]&lt;br /&gt;
* API: [[Payment-Start-v2 | /Payment/Start]]&lt;br /&gt;
* API: [[Payment-GetPaymentState-v2 | /Payment/GetPaymentState]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=In some cases, the card issuers do not release the authorized amount immediately after the Barion sends the appropriate message to them. In these cases, the transaction amount will be released automatically by the issuer bank within a few days after the merchant canceled the payment.|color=#1993C7}}&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=&lt;br /&gt;
The cancelation called within one day after the authorization request can be much faster than the release completed later. In most cases, the intraday cancelation immediately releases the amount on the cardholder&#039;s account.|color=#1993C7}}&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Responsive_web_payment|Responsive Web Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentId || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
|IsSuccessful || bool || Result of the transaction&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the payment, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Status || [[PaymentStatus]]|| The status of the payment in the Barion system. &lt;br /&gt;
&lt;br /&gt;
|- &lt;br /&gt;
|Transactions|| [[ProcessedTransaction]][] || Related transactions&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-Capture-v2&amp;diff=3719</id>
		<title>Payment-Capture-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-Capture-v2&amp;diff=3719"/>
		<updated>2022-11-15T10:21:30Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Capture of a payment}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/Capture&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/capure&amp;lt;/code&amp;gt; API endpoint is used to capture (finish) an existing, previously authorized payment. All transactions are finished with the amount specified in this request, regardless of the amount specified in the StartPayment.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Shop Authentication]]&lt;br /&gt;
* API: [[Payment-Start-v2 | /Payment/Start]]&lt;br /&gt;
* API: [[Payment-GetPaymentState-v2 | /Payment/GetPaymentState]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Responsive_web_payment|Responsive Web Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentId || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Transactions || [[TransactionToFinish]][] || &lt;br /&gt;
* Required&lt;br /&gt;
|| An array containing the payment transactions to capture. All transactions must be supplied. &lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
|IsSuccessful || bool || Result of the transaction&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the payment, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Status || [[PaymentStatus]]|| The status of the payment in the Barion system. &lt;br /&gt;
&lt;br /&gt;
|- &lt;br /&gt;
|Transactions|| [[ProcessedTransaction]][] || Related transactions&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-FinishReservation-v2&amp;diff=3718</id>
		<title>Payment-FinishReservation-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-FinishReservation-v2&amp;diff=3718"/>
		<updated>2022-11-15T10:21:06Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Finish a pending reservation}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/FinishReservation&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/finishreservation&amp;lt;/code&amp;gt; API endpoint is used to finalize a pending reservation in the Barion system.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API| Start a payment]]&lt;br /&gt;
* [[Barion Shop Authentication]]&lt;br /&gt;
* API: [[Payment-Start-v2 | /Payment/Start]]&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Reservation_payment|Payments with reservation]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
|PaymentId || Guid || &lt;br /&gt;
* Required &lt;br /&gt;
|| The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
|Transactions || [[TransactionToFinish]][] || &lt;br /&gt;
* Required &lt;br /&gt;
|| The &amp;lt;u&amp;gt;payment transactions&amp;lt;/u&amp;gt; that the shop would like to finish.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
=== Important things about the transaction structure ===&lt;br /&gt;
* The Transactions[] array should only contain the &amp;lt;u&amp;gt;initial&amp;lt;/u&amp;gt; payment transactions. The additional transactions generated by the Barion system (e.g. fees) must not be included in the call.&lt;br /&gt;
* Each payment transaction can only be finished once.&lt;br /&gt;
* It is not neccessary to finish all transactions in the same API call, but one call must contain at least one transaction to finish.&lt;br /&gt;
* If a transaction is finished with a &#039;&#039;&#039;Total&#039;&#039;&#039; amount lesser than its initial value, the remaining amount is refunded to the payer.&lt;br /&gt;
* If the reservation period passes, all unfinished transactions are finished with zero amount.&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
|IsSuccessful || bool || Result of the transaction&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the newly initialized payment, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Status || [[PaymentStatus]]|| The status of the payment in the Barion system. &lt;br /&gt;
&lt;br /&gt;
|- &lt;br /&gt;
|Transactions|| [[ProcessedTransaction]][] || Related transactions&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-Complete-v2&amp;diff=3717</id>
		<title>Payment-Complete-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-Complete-v2&amp;diff=3717"/>
		<updated>2022-11-15T10:20:44Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Complete a payment}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod | method=POST |uri=/v2/Payment/Complete }}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/CompletePayment&amp;lt;/code&amp;gt; API endpoint is used to complete a formerly prepared and 3DS authenticated payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Shop Authentication]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Token_payment_3D_Secure|Token Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || * Required|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || * Required|| The identifier of the formerly initialized and authenticated payment, generated by the Barion system.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the payment, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentStatus || [[PaymentStatus]]|| The status of the payment in the Barion system. &lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| IsSuccessful || bool || Indicates whether the charge was successful&lt;br /&gt;
|-&lt;br /&gt;
| TraceId || string || Identifies the nature of the token payment. &lt;br /&gt;
|-&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-GetPaymentState-v2&amp;diff=3716</id>
		<title>Payment-GetPaymentState-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-GetPaymentState-v2&amp;diff=3716"/>
		<updated>2022-11-15T10:20:30Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Request the current state of a payment}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=GET&lt;br /&gt;
|uri=/v2/Payment/GetPaymentState&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/getpaymentstate&amp;lt;/code&amp;gt; API endpoint is used to query the details and current state of a given payment.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Shop Authentication]]&lt;br /&gt;
* API: [[Payment-Start-v2 | /Payment/Start]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Responsive_web_payment|Responsive Web Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentId || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The identifier of the payment in the shop&#039;s system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| POSId || Guid || The public identifier of the shop that created the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| POSName || string || The name of the shop that created the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| POSOwnerEmail || string || The e-mail address of the owner of the shop that created the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| POSOwnerCountry || string || ISO2 country code of the owner of the shop that created the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Status || [[PaymentStatus]] || The current status of the payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentType || string || The type of the payment. Can be &amp;lt;code&amp;gt;Immediate&amp;lt;/code&amp;gt; or &amp;lt;code&amp;gt;Reservation&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| AllowedFundingSources || string[] || The allowed funding sources that were defined when creating the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FundingSource || string || The funding source that was used to complete the payment. If the payment is not yet completed, this is empty. Can be &amp;lt;code&amp;gt;Balance&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;BankCard&amp;lt;/code&amp;gt; or &amp;lt;code&amp;gt;BankTransfer&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FundingInformation || [[FundingInformation]] || Detailed information about the funding source that was used to complete the payment. If the payment is not yet completed, this is empty.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecurrenceType || [[RecurrenceType]] || The RecurrenceType that was defined in the payment/start request for the recurring scenario.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TraceId || string || The Trace Id that identifies that recurring scenario. Read more about this [[Token_payment_3D_Secure|here]]&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| GuestCheckout || bool || Indicates whether the payment allows guest checkout.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| CreatedAt || DateTime || The timestamp showing when the payment was created.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| StartedAt || DateTime || The timestamp showing when a reservation payment was started. If the payment type is not reservation, this is empty.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| CompletedAt || DateTime || The timestamp showing when the payment was completed. If the payment is not yet completed, this is empty.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ValidUntil || DateTime || Timestamp showing the expiration time of the payment time window. The payment must be completed before this elapses.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ReservedUntil || DateTime || Timestamp showing the expiration time of the reservation time window. The reserved payment must be finished before this elapses. If the payment type is not reservation, this is empty.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| DelayedCaptureUntil || DateTime || Timestamp showing the expiration time of the authorization time window. The authorized payment must be finished before this elapses. If the payment type is not DelayedCapture, this is empty.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Transactions || [[DetailedPaymentTransaction]][] || An array containing a detailed structure of all transactions associated with the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Total || decimal || The total amount of the payment &amp;lt;u&amp;gt;at the time of the request&amp;lt;/u&amp;gt;. If a reservation was finished with a lower amount, or a previously completed payment was refunded, this can be less than at the time of creation.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || The 3 character ISO 4217 currency code of the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| SuggestedLocale || string || Indicates in which language the Barion Smart Gateway should be shown for the payer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FraudRiskScore || int || A risk score computed by the anti-fraud analysis, between a range of 0 (completely legit) to 100 (certain fraud). Transactions under 10 are usually safe. Transactions with 10 an more, but less than 30 are risky, caution is advised. Transactions with 30 and over are blocked automatically for being almost certainly fraudulent.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| CallbackUrl || string || The URL (including the payment identifier) where the Barion system will send (or already sent) a request to whenever there is a change in the state of the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RedirectUrl || string|| The URL (including the payment identifier) where the payer gets (or already got) redirected to after the payment is or was completed or cancelled.&lt;br /&gt;
&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Payment-Start-v2&amp;diff=3715</id>
		<title>Payment-Start-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Payment-Start-v2&amp;diff=3715"/>
		<updated>2022-11-15T10:19:54Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Initialize a new payment}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/Start&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/payment/start&amp;lt;/code&amp;gt; API endpoint is used to create a new payment in the Barion system.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Creating_a_shop|Creating a shop in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Shop Authentication]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Use cases ==&lt;br /&gt;
&lt;br /&gt;
This API endpoint is designed to be used in the following scenarios:&lt;br /&gt;
* [[Responsive_web_payment|Responsive Web Payment]]&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{|&lt;br /&gt;
|-&lt;br /&gt;
|{{3dsfield}} || Properties marked with this must be provided to comply with 3D Secure authentication. The more attributes you provide the more chance you have to avoid the challenge flow.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&#039;&#039;&#039;Important:&#039;&#039;&#039; if the merchant does not provide 3DS-related properties, it doesn&#039;t mean that the payment will fail. It means that the payer will have a higher chance of getting a challenge during payment.&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| POSKey || Guid || &lt;br /&gt;
* Required&lt;br /&gt;
|| The secret API key of the shop, generated by Barion. This lets the shop to authenticate through the Barion API, but does not provide access to the account owning the shop itself.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentType || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Accepted values: &lt;br /&gt;
** &amp;quot;Immediate&amp;quot;&lt;br /&gt;
** &amp;quot;Reservation&amp;quot;&lt;br /&gt;
** &amp;quot;DelayedCapture&amp;quot; &lt;br /&gt;
|| The type of payment, which can be either immediate or a money reservation. Reservation means that the shop has a time window to finish the payment (even though the money transaction still takes place immediately). Reservation amounts can be modified during this time window unless the new amount is lower than the original. &lt;br /&gt;
Click here to learn more about reservation payments: [[Reservation_payment|Reservation payments]], and delayed capture: [[Delayed_Capture|Delayed capture]].&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ReservationPeriod || TimeSpan (d.hh:mm:ss) || &lt;br /&gt;
* Required only if PaymentType is &amp;quot;Reservation&amp;quot;&lt;br /&gt;
* Minimum value: one minute&lt;br /&gt;
* Maximum value: one year&lt;br /&gt;
* Default value: 30 minutes&lt;br /&gt;
|| Only makes sense at reservation payments. This is the time window that allows the shop to finish (finalize) the payment. If this does not happen within the time window, the system refunds the payment amount to the payer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| DelayedCapturePeriod || TimeSpan (d.hh:mm:ss) || &lt;br /&gt;
* Required only if PaymentType is &amp;quot;DelayedCapture&amp;quot;&lt;br /&gt;
* Minimum value: one minute&lt;br /&gt;
* Maximum value: 7 days (21 days in case of a Hungarian shop)&lt;br /&gt;
* Default value: seven days&lt;br /&gt;
|| This is the time window that allows the shop to complete (finalize) the payment. If this does not happen within the time window, the system releases the payment amount.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentWindow || TimeSpan (d.hh:mm:ss) || &lt;br /&gt;
* Optional&lt;br /&gt;
* Minimum value: one minute&lt;br /&gt;
* Maximum value: one week&lt;br /&gt;
* Default value: 30 minutes&lt;br /&gt;
|| Time window for the payment to be completed. The payer must execute the payment before this elapses, or else the payment will expire and can no longer be completed.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| GuestCheckOut || bool || &lt;br /&gt;
* Required&lt;br /&gt;
* Value must be &amp;quot;true&amp;quot; or &amp;quot;false&amp;quot;, integer evaluation is not supported&lt;br /&gt;
|| Flag indicating whether the payment can be completed without a registered Barion wallet. Guest checkout can only be done with bank cards, and the payer must supply a valid e-mail address - this is necessary for fraud control.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| InitiateRecurrence || bool || &lt;br /&gt;
* Optional&lt;br /&gt;
|| This flag indicates that the shop would like to initialize a token payment. This means that the shop is authorized to charge the funding source of the payer in the future without redirecting her/him to the Barion Smart Gateway. It can be used for one-click and subscription payment scenarios. &lt;br /&gt;
Click here to learn more about token payments: [[Token_payment]]&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecurrenceId || string || &lt;br /&gt;
* Required when executing token payments&lt;br /&gt;
* Maximum length: 100 characters&lt;br /&gt;
* Must be unique per shop and per user&lt;br /&gt;
* [https://docs.barion.com/Token_payment#Creating_the_token Generated by the shop]&lt;br /&gt;
|| A string used to identify a given token payment. Its purpose is determined by the value of the &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; property.&lt;br /&gt;
* If &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; is &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt;, this property must contain a &amp;lt;u&amp;gt;new&amp;lt;/u&amp;gt; desired identifier for a new token payment. This should be generated and stored by the shop before calling the API. Also, the shop must ensure that this is unique per user in its own system.&lt;br /&gt;
* If &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; is &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt;, this property must contain an &amp;lt;u&amp;gt;existing&amp;lt;/u&amp;gt; identifier for a token payment. This should be used to charge a payer&#039;s funding source (either bank card or Barion wallet) that was already used successfully for a payment in the shop.&lt;br /&gt;
* multiple shops can use the same RecurrenceId. Should you be interested, please contact merchanthelpdesk@barion.com&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
| FundingSources || [[FundingSources|string[]]] || &lt;br /&gt;
* Required&lt;br /&gt;
|| An array of strings containing the allowed funding sources that can be used to complete the payment.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Maximum length: 100 characters&lt;br /&gt;
|| The unique identifier for the payment generated by the shop. This is so the shop can track its own payment identifiers. It is also useful for bookkeeping purposes since this shows up in the monthly account statement and the transaction history export, making identification of payments easier for the shop.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
| PayerHint || string || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
* Optional, but recommended. &lt;br /&gt;
* If provided, must be a valid email format&lt;br /&gt;
* Maximum length: 256 characters&lt;br /&gt;
|| The shop can supply an e-mail address as a hint on who should complete the payment. This can be used if the shop is certain about that the payer has an active Barion wallet or the shop would like to help the guest payer with filling in the email field for her/him. If provided, the Barion Smart Gateway automatically fills out the e-mail address field in the Barion wallet login form and the guest payer form, speeding up the payment process.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
| CardHolderNameHint || string || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
* Optional, but recommended&lt;br /&gt;
* Between 2 and 45 characters&lt;br /&gt;
|| The shop can provide a hint for the customer&#039;s name on the card to speed up the payment flow. If a value is provided, the cardholder name input will be pre-filled with it and the customer can use the pre-filled value instead of typing it out on its own, which speeds up the payment process.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecurrenceType || [[RecurrenceType]] || &lt;br /&gt;
* Required for {{3dsfield}}, when executing token payments&lt;br /&gt;
|| Describes the nature of the token payment.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TraceId || string || &lt;br /&gt;
* Required for {{3dsfield}}, when executing token payments&lt;br /&gt;
* Maximum length: 100 characters&lt;br /&gt;
|| Identifies the nature of the token payment. &lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RedirectUrl || string || &lt;br /&gt;
* Required &lt;br /&gt;
* Maximum length: 2000 characters&lt;br /&gt;
|| The URL where the payer should be redirected after the payment is completed or canceled. The payment identifier is added to the query string part of this URL in the &amp;lt;code&amp;gt;paymentId&amp;lt;/code&amp;gt; parameter. If not provided, the system will use the redirect URL assigned to the shop that started the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| CallbackUrl || string || &lt;br /&gt;
* Required &lt;br /&gt;
* Maximum length: 2000 characters&lt;br /&gt;
|| The URL where the Barion system sends a request whenever there is a change in the state of the payment. The payment identifier is added to the query string part of this URL in the &amp;lt;code&amp;gt;paymentId&amp;lt;/code&amp;gt; parameter. Click here to learn more about the callback mechanism: [[Callback_mechanism|Payment callback mechanism (IPN)]]&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Transactions || [[PaymentTransaction]][] || &lt;br /&gt;
* Required&lt;br /&gt;
|| An array of payment transactions contained in the payment. A payment must contain at least one such transaction. See the [[PaymentTransaction]] page for the appropriate structure and syntax.&lt;br /&gt;
Defining multiple transactions allow the payment initiator to distribute the payment amount between multiple shops. See the following page to learn more: [[Facilitated payments]]&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| OrderNumber || string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Maximum length: 100 characters&lt;br /&gt;
|| The order number generated by the shop. This is to aid the shop in identifying a given payment in its own system. This also shows up in generated monthly account statements and transaction history exports, so it also helps with bookkeeping.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ShippingAddress || [[ShippingAddress]] || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
|| The shipping address associated with the payment, if applicable. Providing this is recommended because it helps the automatic anti-fraud analysis get more accurate results. See the [[ShippingAddress]] page for the appropriate structure and syntax.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Locale || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Maximum length: 10 characters&lt;br /&gt;
* Accepted values: &lt;br /&gt;
** &amp;quot;cs-CZ&amp;quot; (Czech)&lt;br /&gt;
** &amp;quot;de-DE&amp;quot; (German)&lt;br /&gt;
** &amp;quot;en-US&amp;quot; (English)&lt;br /&gt;
** &amp;quot;es-ES&amp;quot; (Spanish)&lt;br /&gt;
** &amp;quot;fr-FR&amp;quot; (French)&lt;br /&gt;
** &amp;quot;hu-HU&amp;quot; (Hungarian)&lt;br /&gt;
** &amp;quot;sk-SK&amp;quot; (Slovak)&lt;br /&gt;
** &amp;quot;sl-SI&amp;quot; (Slovenian)&lt;br /&gt;
|| This indicates in which language the Barion Smart Gateway should display for the payer upon redirect. &lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
Accepted values: &lt;br /&gt;
{{CurrencyList}}&lt;br /&gt;
|| The currency of the payment. Must be supplied in ISO 4217 format. This affects all transactions included in the payment; it is not possible to define multiple transactions in different currencies.&lt;br /&gt;
|-&lt;br /&gt;
| PayerPhoneNumber || string || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
* Max length: 30 characters&lt;br /&gt;
* Expected format: 36701231234 (where 36 is the country code)&lt;br /&gt;
|| The number must be sent in the expected format, without + sign or leading zero(s).&lt;br /&gt;
|-&lt;br /&gt;
| PayerWorkPhoneNumber || string || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
* Max length: 30 characters&lt;br /&gt;
* Expected format: 36701231234 (where 36 is the country code)&lt;br /&gt;
|| The work phone of the payer. The number must be sent in the expected format, without + sign or leading zero(s).&lt;br /&gt;
|-&lt;br /&gt;
| PayerHomeNumber || string || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
* Max length: 30 characters&lt;br /&gt;
* Expected format: 36701231234 (where 36 is the country code)&lt;br /&gt;
|| The home phone number of the payer. The number must be sent in the expected format, without + sign or leading zero(s).&lt;br /&gt;
|-&lt;br /&gt;
| BillingAddress || [[BillingAddress]] || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
|| The billing address associated with the payment, if applicable.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PayerAccountInformation|| [[PayerAccountInformation]] || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
|| Information about the account of the payer in the merchant&#039;s system.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PurchaseInformation|| [[PurchaseInformation]] || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
|| Information about current purchase.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ChallengePreference || [[ChallengePreference]] || &lt;br /&gt;
* Required for {{3dsfield}}&lt;br /&gt;
|| The merchant&#039;s preference of the 3DS challenge. Here you can specify what 3DS authentication should be utilized.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId || Guid || The identifier of the newly initialized payment, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Status || [[PaymentStatus]]|| The status of the payment in the Barion system. &lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| QRUrl || string || URL for a QR code representing the payment. This is useful in physical real life situations where the payer uses a mobile device.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecurrenceResult || RecurrenceResult || Indicates the result of an authorized payment scenario. The result depends on the values of the &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; and &#039;&#039;&#039;RecurrenceId&#039;&#039;&#039; properties supplied in the request.&lt;br /&gt;
&lt;br /&gt;
* If &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; was &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt;, and a new authorized payment was successfully created, this will be &amp;lt;code&amp;gt;None&amp;lt;/code&amp;gt; (because no actual token charge took place yet)&lt;br /&gt;
&lt;br /&gt;
* If &#039;&#039;&#039;InitiateRecurrence&#039;&#039;&#039; was &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt;, but a previously authorized payment identifier was supplied in &#039;&#039;&#039;RecurrenceId&#039;&#039;&#039;, the system will try to charge the funding source associated with the authorized payment. If this charge is successful, the result is &amp;lt;code&amp;gt;Successful&amp;lt;/code&amp;gt;. If the system could not charge the funding source, the result is &amp;lt;code&amp;gt;Failed&amp;lt;/code&amp;gt;. If the given identifier is invalid or does not exist, the result is &amp;lt;code&amp;gt;NotFound&amp;lt;/code&amp;gt;. In case the payment can not be processed due to lack of 3DS v2 information &amp;lt;code&amp;gt;ThreeDSAuthenticationRequired&amp;lt;/code&amp;gt; is returned. In this case, either offsite 3DS v2 authentication should be performed or the TraceId of the initial payment should be sent as well.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Transactions || [[ProcessedTransaction]][] || An array containing all transactions associated with the payment. If the Barion system deducts fees from the shop after payments, this also contains these additional fee transactions beside the payment transactions that were sent in the request.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| GatewayUrl || string || The URL of the Barion Smart Gateway (including the payment identifier), where the API caller should redirect the payer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| CallbackUrl || string || The URL (including the payment identifier) where the Barion system will send a request to whenever there is a change in the state of the payment. If an explicit URL was not supplied, this will be the callback URL associated with the shop that started the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RedirectUrl || string || The URL (including the payment identifier) where the payer gets redirected to after the payment is completed or cancelled. If an explicit URL was not supplied, this will be the redirect URL associated with the shop that started the payment.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ThreeDSAuthClientData|| string || Encrypted client authentication data required for 3D Secure processing. This value can be used when the webshop first tried to complete the payment without user interaction, but the charge failed due to a 3D Secure challenge being mandatory.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TraceId || string || A unique value generated by the card issuer to track a chain of [[Token_payment_3D_Secure|recurring or token payments that require 3D Secure authentication]]. This shall be used in such scenarios, otherwise it can be ignored.&lt;br /&gt;
&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Transfer-Send-v1&amp;diff=3714</id>
		<title>Transfer-Send-v1</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Transfer-Send-v1&amp;diff=3714"/>
		<updated>2022-11-15T10:18:19Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: send money instantly}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v1/Transfer/Send&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/transfer/send&amp;lt;/code&amp;gt; API endpoint is used to send e-money between Barion users or outside Barion.&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=WARNING|text=This API endpoint is deprecated.|color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v1&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v1&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
* Accepted values: &lt;br /&gt;
** &amp;quot;CZK&amp;quot; (Czech crown)&lt;br /&gt;
** &amp;quot;EUR&amp;quot; (Euro)&lt;br /&gt;
** &amp;quot;HUF&amp;quot; (Hungarian forint)&lt;br /&gt;
** &amp;quot;USD&amp;quot; (U.S. dollar)&lt;br /&gt;
|| The currency of the money transfer. &lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; Barion does not do currency rate conversion. The caller must have an active account with the selected currency. If the recipient does not have an active account with the selected currecy, the system automatically creates one for them.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || &lt;br /&gt;
* Required&lt;br /&gt;
* Must be greater than zero&lt;br /&gt;
|| The total amount to transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Recipient || string || &lt;br /&gt;
* Required&lt;br /&gt;
|| The e-mail address of the recipient of the transfer. If they are an active Barion user, they receive the money instantly. If the e-mail address is not registered in Barion, they must register in 7 days in order to claim the money. If the money is not claimed, it gets transferred back to the sender.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment || string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Maximum length: 1000 characters&lt;br /&gt;
|| The comment of the money transfer.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TransactionId || Guid || The unique identifier of the transfer, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || The currency of the money transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || The total amount transferred.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FromBalance || decimal || The remaining balance of the sender.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| FromName || string || The name of the sender of the transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| ToName || string || The name of the recipient of the transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment || string || The comment of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TransactionType || [[TransactionType]] || The type of the transaction in the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Direction || int || The direction of the transfer.&lt;br /&gt;
* 1 = incoming&lt;br /&gt;
* 0 = outgoing&lt;br /&gt;
&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Transfer-Email-v2&amp;diff=3713</id>
		<title>Transfer-Email-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Transfer-Email-v2&amp;diff=3713"/>
		<updated>2022-11-15T10:17:52Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: send money to an e-mail address}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Transfer/Email&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/transfer/email&amp;lt;/code&amp;gt; API endpoint is used to send money to another Barion Wallet.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| SourceAccountId || GUID || &lt;br /&gt;
* Required&lt;br /&gt;
* Must be an account of the authenticating user, in the same currency as the transfer itself&lt;br /&gt;
|| The identifier of the Barion wallet. This can be determined using the [[Accounts-Get-v2]] API endpoint.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || [[Money]] || &lt;br /&gt;
* Required&lt;br /&gt;
* Must be greater than zero&lt;br /&gt;
|| The total amount to transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TargetEmail|| string || &lt;br /&gt;
* Required&lt;br /&gt;
|| The e-mail address of the recipient of the transfer. If they are an active Barion user, they receive the money instantly. If the e-mail address is not registered in Barion, they must register in 7 days in order to claim the money. If the money is not claimed, it gets transferred back to the sender.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment || string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Maximum length: 1000 characters&lt;br /&gt;
|| The comment of the money transfer.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| IsTransferSuccessful || bool || Indicates wether the e-money transfer was successfuly finished.&lt;br /&gt;
&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Statement-Download-v2&amp;diff=3712</id>
		<title>Statement-Download-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Statement-Download-v2&amp;diff=3712"/>
		<updated>2022-11-15T10:17:35Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Download statement file}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=GET&lt;br /&gt;
|uri=/v2/Statement/Download&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/statement/download&amp;lt;/code&amp;gt; API endpoint is used to download monthly or daily statement files generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Year || int || &lt;br /&gt;
* Required&lt;br /&gt;
|| The statement year.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Month || int || &lt;br /&gt;
* Required&lt;br /&gt;
|| The statement month.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Day || int || &lt;br /&gt;
* Optional&lt;br /&gt;
|| The statement day. If specified, the system will serve a daily statement file.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
Accepted values:&lt;br /&gt;
{{CurrencyList}}&lt;br /&gt;
|| The currency of the statement&#039;s account. Accounts with separate currencies have separate statement files.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output and response ==&lt;br /&gt;
&lt;br /&gt;
Depending on the given input parameters the endpoint will produce the following outputs:&lt;br /&gt;
&lt;br /&gt;
* If the caller fails to authenticate, the API will produce an empty output with an &amp;lt;code&amp;gt;HTTP 401 Unauthorized&amp;lt;/code&amp;gt; status code.&lt;br /&gt;
&lt;br /&gt;
* If only &#039;&#039;&#039;year&#039;&#039;&#039; and &#039;&#039;&#039;month&#039;&#039;&#039; were specified for the statement, the endpoint will try to serve the &amp;lt;u&amp;gt;monthly statement&amp;lt;/u&amp;gt; for the corresponding year and month as a PDF (Printable Document Format) document.&lt;br /&gt;
&lt;br /&gt;
* If &#039;&#039;&#039;year&#039;&#039;&#039;, &#039;&#039;&#039;month&#039;&#039;&#039;, and &#039;&#039;&#039;day&#039;&#039;&#039; were specified for the statement, the endpoint will try to serve the &amp;lt;u&amp;gt;daily statement&amp;lt;/u&amp;gt; for the corresponding date as a signed XLSX (Microsoft Excel) document.&lt;br /&gt;
&lt;br /&gt;
* If the requested statement file is not available, the API returns an error message with an &amp;lt;code&amp;gt;HTTP 404 Not found&amp;lt;/code&amp;gt; status code. This can happen if the requested statement file has not been generated yet.&lt;br /&gt;
&lt;br /&gt;
* If generation of the given statement type is disabled for the user, the API returns an error message with an &amp;lt;code&amp;gt;HTTP 403 Forbidden&amp;lt;/code&amp;gt; status code.&lt;br /&gt;
&lt;br /&gt;
* If the user does not have an account in the specified currency, the API returns an error message with an &amp;lt;code&amp;gt;HTTP 400 Bad request&amp;lt;/code&amp;gt; status code.&lt;br /&gt;
&lt;br /&gt;
== Things to know ==&lt;br /&gt;
* To get daily statement files please contact Barion from the Customer Center in your Barion wallet. &lt;br /&gt;
* Daily statement files will &amp;lt;u&amp;gt;not show&amp;lt;/u&amp;gt; up on the secure.barion.com site for download. They can only be downloaded via this API endpoint.&lt;br /&gt;
* Once the statement files have been generated, they are available to download for an indefinite time.&lt;br /&gt;
&lt;br /&gt;
== Examples ==&lt;br /&gt;
&lt;br /&gt;
Downloading the daily statement of an &#039;&#039;&#039;EUR&#039;&#039;&#039; account for &#039;&#039;&#039;October 6th 2019&#039;&#039;&#039;:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;https://&amp;lt;nowiki /&amp;gt;api.barion.com/v2/statement/download?username=customer@example.com&amp;amp;password=my5Tr0ngP4ssW0rd&amp;amp;year=2019&amp;amp;month=10&amp;amp;day=6&amp;amp;currency=EUR&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
Downloading the monthly statement of an &#039;&#039;&#039;HUF&#039;&#039;&#039; account for &#039;&#039;&#039;April 2019&#039;&#039;&#039;:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;https://&amp;lt;nowiki /&amp;gt;api.barion.com/v2/statement/download?username=customer@example.com&amp;amp;password=my5Tr0ngP4ssW0rd&amp;amp;year=2019&amp;amp;month=4&amp;amp;currency=HUF&amp;lt;/code&amp;gt;&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Withdraw-BankTransfer-v2&amp;diff=3711</id>
		<title>Withdraw-BankTransfer-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Withdraw-BankTransfer-v2&amp;diff=3711"/>
		<updated>2022-11-15T10:16:37Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Initiate a bank transfer}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Withdraw/BankTransfer&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/withdraw/banktransfer&amp;lt;/code&amp;gt; API endpoint is used to send money out of the Barion system via bank (wire) transfer.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=WARNING|text=This API endpoint is obsolete as of August 2022. Please implement or migrate to [[Withdraw-BankTransfer-v3|/v3/Withdraw/BankTransfer]]|color=#FF7A3D}}&lt;br /&gt;
{{NotificationBox|title=IMPORTANT|text=Starting September 2022 this API endpoint does NOT accept withdrawal requests in CZK currency that are targeted &amp;lt;u&amp;gt;outside of Czechia&amp;lt;/u&amp;gt;.|color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
* Accepted values: &lt;br /&gt;
** &amp;quot;CZK&amp;quot; (Czech crown)&lt;br /&gt;
** &amp;quot;EUR&amp;quot; (Euro)&lt;br /&gt;
** &amp;quot;HUF&amp;quot; (Hungarian forint)&lt;br /&gt;
** &amp;quot;USD&amp;quot; (U.S. dollar)&lt;br /&gt;
|| The currency of the bank transfer. &lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; Barion does not do currency rate conversion. The caller must have an active account with the selected currency, and must ensure that the target bank accepts the selected currency.&lt;br /&gt;
&amp;lt;span style=&amp;quot;color:#920000;&amp;quot;&amp;gt;&#039;&#039;&#039;Note:&#039;&#039;&#039; Withdraws in CZK currency that are targeted outside of Czechia are not supported on this endpoint starting September 2022.&amp;lt;/span&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || &lt;br /&gt;
* Required&lt;br /&gt;
* Must be greater than zero&lt;br /&gt;
|| The total amount to withdraw, excluding fees.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecipientName || string || &lt;br /&gt;
* Required&lt;br /&gt;
|| The name of the recipient of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment|| string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Maximum length: 90 characters&lt;br /&gt;
|| The comment of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| BankAccount|| [[BankAccount]] || &lt;br /&gt;
* Required&lt;br /&gt;
|| Information about the recipient&#039;s bank account.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TransactionId || Guid || The unique identifier of the bank transfer, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || The currency of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || The total amount transferred.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| RecipientName || string || The name of the recipient of the transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment || string || The comment of the bank transfer&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| BankAccount|| [[BankAccount]] || The bank account data.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Possible error responses  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Error code || Description&lt;br /&gt;
|-&lt;br /&gt;
| ModelValidationError || This happens when some of the input properties fail the basic validation. For example a string property exceeds its allowed length.&lt;br /&gt;
|-&lt;br /&gt;
| AuthenticationFailed || The provided authentication is not correct.&lt;br /&gt;
|-&lt;br /&gt;
| MinimumWithdrawAmountNotReached || The amount specified does not reach the minimum bank transfer amount. &#039;&#039;&#039;This is not in production yet&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCharacter || One of the characters is invalid for the bank transfer process&lt;br /&gt;
|-&lt;br /&gt;
| InvalidAccount || There is no account belonging to the user with the specified currency.&lt;br /&gt;
|-&lt;br /&gt;
| InappropriateVerificationLevel || The user does not have the verification level to be able to transfer.&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCurrency || The system does not support the specified currency&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCountry || The Country specified in the BankAccount field is invalid.&lt;br /&gt;
|-&lt;br /&gt;
| LowBalance || There are not enough funds to cover the withdraw amount and the fee.&lt;br /&gt;
|-&lt;br /&gt;
| BankAccountNumberBlackListed || The target bankaccount number is on blacklist, the withdraw process is terminated and the customer gets suspended. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsOverWithdrawLimit|| The withdraw amount exceeded the allowed limit for non-verified customers, the withdraw process is terminated and the customer gets suspended. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsDeleted || The user is deleted from the system, the withdraw is not possible. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsSuspended || The user is suspended until the suspension is lifted no withdraws are allowed.&lt;br /&gt;
|-&lt;br /&gt;
| WithdrawFromCustomerAccountToSystemAccount || Withdraw to the specified target account is not allowed.&lt;br /&gt;
|-&lt;br /&gt;
| BankAccountNumberNotAllowed|| Target Bank account number not in the list of allowed bank account numbers for this account.&lt;br /&gt;
|-&lt;br /&gt;
| InternalServerError || Something unexpected happened&lt;br /&gt;
|-&lt;br /&gt;
| UnsupportedWithdraw || In the case of foreign CZK transfers (targeted outside of Czechia) this endpoint is not suitable to start the transfer. Please upgrade to the [[Withdraw-BankTransfer-v3|v3 version]].&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Bank transfer amount limitations  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Currency || Target country || Amount limitation&lt;br /&gt;
|-&lt;br /&gt;
| HUF || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| EUR || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| USD || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Czechia || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;s&amp;gt;CZK&amp;lt;/s&amp;gt; || &amp;lt;s&amp;gt;Not Czechia&amp;lt;/s&amp;gt; || &amp;lt;s&amp;gt;Minimum 100 CZK&amp;lt;/s&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Bank transfer character limitations  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Currency || Target country || Character limitation&lt;br /&gt;
|-&lt;br /&gt;
| HUF || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| EUR || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| USD || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Czechia || Allowed characters:&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, á, ä, č, ď, é, ě, í, ľ, ň, ó, ô, ö, ř, ŕ, š, ť, ú, ů, ü, ý, ž, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Á, Ä, Č, Ď, É, Ě, Í, Ľ, Ň, Ó, Ô, Ö, Ř, Ŕ, Š, Ť, Ú, Ů, Ü, Ý, Ž, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, &#039;, +, !, &amp;quot;, #, $, %, &amp;amp;, *, ;, &amp;lt;, =, &amp;gt;, @, [, ], ^, `, {, |, }, ~, §, SPACE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| &amp;lt;s&amp;gt;CZK || &amp;lt;s&amp;gt;Not Czechia&amp;lt;/s&amp;gt; || &amp;lt;s&amp;gt;Allowed characters: &lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, &#039;, +, SPACE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&amp;lt;/s&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Withdraw-BankTransfer-v3&amp;diff=3710</id>
		<title>Withdraw-BankTransfer-v3</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Withdraw-BankTransfer-v3&amp;diff=3710"/>
		<updated>2022-11-15T10:15:32Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Initiate a bank transfer}}&lt;br /&gt;
&lt;br /&gt;
{{TableOfContents}}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v3/Withdraw/BankTransfer&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/withdraw/banktransfer&amp;lt;/code&amp;gt; API endpoint is used to send money out of the Barion Wallet via bank (wire) transfer.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v3&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v3&#039;&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
== Input properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Required length: 3 characters&lt;br /&gt;
* Accepted values: &lt;br /&gt;
** &amp;quot;CZK&amp;quot; (Czech crown)&lt;br /&gt;
** &amp;quot;EUR&amp;quot; (Euro)&lt;br /&gt;
** &amp;quot;HUF&amp;quot; (Hungarian forint)&lt;br /&gt;
** &amp;quot;USD&amp;quot; (U.S. dollar)&lt;br /&gt;
|| The currency of the bank transfer. &lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; Barion does not do currency rate conversion. The caller must have an active account with the selected currency, and must ensure that the target bank accepts the selected currency.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || &lt;br /&gt;
* Required&lt;br /&gt;
* Must be greater than zero&lt;br /&gt;
|| The total amount to withdraw, excluding fees.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment|| string || &lt;br /&gt;
* Optional&lt;br /&gt;
* Maximum length: 90 characters&lt;br /&gt;
|| The comment of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| BankAccount|| [[BankAccountDetails]] || &lt;br /&gt;
* Required&lt;br /&gt;
|| Information about the recipient&#039;s bank account.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Bank|| [[BankDetails]] || &lt;br /&gt;
* Required for foreign withdrawals&lt;br /&gt;
|| Information about the recipient&#039;s bank.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Recipient|| [[RecipientDetails]] || &lt;br /&gt;
* Required&lt;br /&gt;
|| Information about the recipient.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
== Example requests ==&lt;br /&gt;
[[Withdraw-BankTransfer-v3-examples]]&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| TransactionId || Guid || The unique identifier of the bank transfer, generated by the Barion system.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Currency || string || The currency of the bank transfer.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Amount || decimal || The total amount transferred.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Comment || string || The comment of the bank transfer&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| BankAccount|| [[BankAccountDetails]] || Information about the recipient&#039;s bank account.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Bank|| [[BankDetails]] || Information about the recipient&#039;s bank.&lt;br /&gt;
&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
| Recipient|| [[RecipientDetails]] || Information about the recipient.&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Possible error responses  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Error code || Description&lt;br /&gt;
|-&lt;br /&gt;
| ModelValidationError || This happens when some of the input properties fail the basic validation. For example a string property exceeds its allowed length.&lt;br /&gt;
|-&lt;br /&gt;
| AuthenticationFailed || The provided authentication is not correct.&lt;br /&gt;
|-&lt;br /&gt;
| MinimumWithdrawAmountNotReached || The amount specified does not reach the minimum bank transfer amount. &#039;&#039;&#039;This is not in production yet&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCharacter || One of the characters is invalid for the bank transfer process&lt;br /&gt;
|-&lt;br /&gt;
| InvalidAccount || There is no account belonging to the user with the specified currency.&lt;br /&gt;
|-&lt;br /&gt;
| InappropriateVerificationLevel || The user does not have the verification level to be able to transfer.&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCurrency || The system does not support the specified currency&lt;br /&gt;
|-&lt;br /&gt;
| InvalidCountry || The Country specified in the BankAccount field is invalid.&lt;br /&gt;
|-&lt;br /&gt;
| LowBalance || There are not enough funds to cover the withdraw amount and the fee.&lt;br /&gt;
|-&lt;br /&gt;
| BankAccountNumberBlackListed || The target bankaccount number is on blacklist, the withdraw process is terminated and the customer gets suspended. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsOverWithdrawLimit|| The withdraw amount exceeded the allowed limit for non-verified customers, the withdraw process is terminated and the customer gets suspended. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsDeleted || The user is deleted from the system, the withdraw is not possible. &lt;br /&gt;
|-&lt;br /&gt;
| UserIsSuspended || The user is suspended until the suspension is lifted no withdraws are allowed.&lt;br /&gt;
|-&lt;br /&gt;
| WithdrawFromCustomerAccountToSystemAccount || Withdraw to the specified target account is not allowed.&lt;br /&gt;
|-&lt;br /&gt;
| BankAccountNumberNotAllowed|| Target Bank account number not in the list of allowed bank account numbers for this account.&lt;br /&gt;
|-&lt;br /&gt;
| InternalServerError || Something unexpected happened&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Bank transfer amount limitations  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Currency || Target country || Amount limitation&lt;br /&gt;
|-&lt;br /&gt;
| HUF || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| EUR || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| USD || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Czechia || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Not Czechia || Minimum 100 CZK&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Bank transfer character limitations  ==&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! Currency || Target country || Character limitation&lt;br /&gt;
|-&lt;br /&gt;
| HUF || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| EUR || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| USD || Anywhere || No limitation&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Czechia || Allowed characters: &lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, á, ä, č, ď, é, ě, í, ľ, ň, ó, ô, ö, ř, ŕ, š, ť, ú, ů, ü, ý, ž, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Á, Ä, Č, Ď, É, Ě, Í, Ľ, Ň, Ó, Ô, Ö, Ř, Ŕ, Š, Ť, Ú, Ů, Ü, Ý, Ž, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, &#039;, +, !, &amp;quot;, #, $, %, &amp;amp;, *, ;, &amp;lt;, =, &amp;gt;, @, [, ], ^, `, {, |, }, ~, §, SPACE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| CZK || Not Czechia || Allowed characters: &lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, &#039;, +, SPACE&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Accounts-Get-v2&amp;diff=3709</id>
		<title>Accounts-Get-v2</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Accounts-Get-v2&amp;diff=3709"/>
		<updated>2022-11-15T10:12:03Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change auth description&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Barion API: Get existing accounts of the user}}&lt;br /&gt;
&lt;br /&gt;
{| style=&amp;quot;margin-left:2em;&amp;quot; align=&amp;quot;right&amp;quot;&lt;br /&gt;
| __TOC__&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=GET&lt;br /&gt;
|uri=/v2/Accounts&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;/accounts&amp;lt;/code&amp;gt; API endpoint is used to query the existing accounts of the calling user.&lt;br /&gt;
&lt;br /&gt;
Prerequisites before use:&lt;br /&gt;
* [[Creating_an_account|Creating an account in Barion]]&lt;br /&gt;
* [[Calling_the_API|Calling the Barion API]]&lt;br /&gt;
* [[Barion Wallet Authentication]]&lt;br /&gt;
* API: [[Transfer-Email-v2 | /Transfer/Email]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; This API endpoint is available in &#039;&#039;&#039;API v2&#039;&#039;&#039; only.&lt;br /&gt;
&lt;br /&gt;
== Output properties ==&lt;br /&gt;
&lt;br /&gt;
{{api_output_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| Accounts || [[Account]][] || The list of accounts in the user&#039;s Barion wallet&lt;br /&gt;
|}&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=List_of_API_endpoints&amp;diff=3708</id>
		<title>List of API endpoints</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=List_of_API_endpoints&amp;diff=3708"/>
		<updated>2022-11-15T10:10:28Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: add shop and wallet authentication page link&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;__NOTOC__&lt;br /&gt;
{{PageTitle|title=List of Barion API endpoints}}&lt;br /&gt;
&lt;br /&gt;
On this page you can find the currently available API endpoints in the Barion system. If you are new here, first please read the [[Getting_started|Getting started]] page.&lt;br /&gt;
&lt;br /&gt;
==API base URL==&lt;br /&gt;
&lt;br /&gt;
Base URL for API requests in the &#039;&#039;&#039;Live (production)&#039;&#039;&#039; environment: &amp;lt;code&amp;gt;https://api.barion.com&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Base URL for API requests in the &#039;&#039;&#039;Sandbox (test)&#039;&#039;&#039; environment: &amp;lt;code&amp;gt;https://api.test.barion.com&amp;lt;/code&amp;gt; (learn more about the Sandbox environment [[Sandbox|here]])&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=IMPORTANT|text=Always double check that you are connecting to the proper environment to avoid unnecessary troubleshooting!|color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
==Endpoint list==&lt;br /&gt;
&lt;br /&gt;
Currently the following endpoints are available in the Barion API.&lt;br /&gt;
&lt;br /&gt;
{| &lt;br /&gt;
|&#039;&#039;&#039;Barion Smart Gateway&#039;&#039;&#039;&lt;br /&gt;
|&#039;&#039;&#039;Barion Wallet&#039;&#039;&#039;&lt;br /&gt;
|-&lt;br /&gt;
| style=&amp;quot;padding-right: 100px;vertical-align: top&amp;quot; |&lt;br /&gt;
For authentication in these endpoints, see [[Barion Shop Authentication]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Payment-Start-v2|/Payment/Start]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Payment-GetPaymentState-v2|/Payment/GetPaymentState]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Payment-Complete-v2|/Payment/Complete]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Payment-FinishReservation-v2|/Payment/FinishReservation]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Payment-Capture-v2|/Payment/Capture]] &lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Payment-CancelAuthorization-v2|/Payment/CancelAuthorization]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Payment-Refund-v2|/Payment/Refund]]&lt;br /&gt;
| style=&amp;quot;vertical-align: top&amp;quot; |&lt;br /&gt;
For authentication in these endpoints, see [[Barion Wallet Authentication]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Accounts-Get-v2|/Accounts]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v3&amp;lt;/span&amp;gt; [[Withdraw-BankTransfer-v3|/Withdraw/BankTransfer]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Withdraw-BankTransfer-v2|/Withdraw/BankTransfer]] (deprecated)&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Statement-Download-v2|/Statement/Download]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v2&amp;lt;/span&amp;gt; [[Transfer-Email-v2|/Transfer/Email]]&lt;br /&gt;
&lt;br /&gt;
&amp;lt;span class=&amp;quot;api-ver&amp;quot;&amp;gt;v1&amp;lt;/span&amp;gt; [[Transfer-Send-v1|/Transfer/Send]] (deprecated)&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
{{NotificationBox|title=IMPORTANT|text=Endpoints must be prefixed with the corresponding API version.|color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
==Other interfaces==&lt;br /&gt;
[[Callback_mechanism|Barion callback mechanism - how to properly get notified about the results of Barion Smart Gateway payments]]&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Calling_the_API&amp;diff=3706</id>
		<title>Calling the API</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Calling_the_API&amp;diff=3706"/>
		<updated>2022-11-15T10:08:24Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: available in sandbox&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;__NOTOC__&lt;br /&gt;
{{PageTitle|title=Calling the Barion API}}&lt;br /&gt;
&lt;br /&gt;
== The Barion API ==&lt;br /&gt;
&lt;br /&gt;
Barion offers you a RESTful API service to communicate with your web or mobile merchant services. Learn more about RESTful behavior [https://en.wikipedia.org/wiki/Representational_state_transfer|in the original Wikipedia article].&lt;br /&gt;
&lt;br /&gt;
== Protocols and communication ==&lt;br /&gt;
&lt;br /&gt;
The Barion API communicates via standard &#039;&#039;&#039;HTTP1.1&#039;&#039;&#039; GET or POST requests. A given API endpoint accepts only GET or only POST requests - there are no universal endpoints available.&lt;br /&gt;
On each API endpoint reference page, you can find the path of the API endpoint and the HTTP method it accepts.&lt;br /&gt;
&lt;br /&gt;
Example:&lt;br /&gt;
&lt;br /&gt;
{{api_callmethod&lt;br /&gt;
|method=POST&lt;br /&gt;
|uri=/v2/Payment/Start&lt;br /&gt;
}}&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=IMPORTANT|text=All communication must be done over HTTPS. The Barion system only supports TLS v1.1 / v1.2|color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
If the caller uses an incorrect method, the system responds with a JSON error message.&lt;br /&gt;
&lt;br /&gt;
Example: calling a POST endpoint with a GET request&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=&amp;quot;json&amp;quot;&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;Message&amp;quot;: &amp;quot;The requested resource does not support http method &#039;GET&#039;.&amp;quot;&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
== Data and content types ==&lt;br /&gt;
&lt;br /&gt;
The API sends and receives all content in standard &#039;&#039;&#039;JSON&#039;&#039;&#039; (JavaScript Object Notation) string format.&lt;br /&gt;
&lt;br /&gt;
Some things you must ensure when creating an API request:&lt;br /&gt;
* JSON strings are UTF-8 encoded.&lt;br /&gt;
* The MIME type of the request sent to the API is defined as &amp;lt;code&amp;gt;application/json&amp;lt;/code&amp;gt;.&lt;br /&gt;
* &amp;lt;code&amp;gt;Content-length&amp;lt;/code&amp;gt; should also be specified explicitly in all HTTP request headers.&lt;br /&gt;
&lt;br /&gt;
The data types used in the API communication are the following:&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! Data type&lt;br /&gt;
! Type description&lt;br /&gt;
|-&lt;br /&gt;
| string&lt;br /&gt;
| Standard character string. The Barion API uses UTF-8 encoding.&lt;br /&gt;
|-&lt;br /&gt;
| int&lt;br /&gt;
| 32-bit signed integer format&lt;br /&gt;
|-&lt;br /&gt;
| GUID (Global Unique Identifier)&lt;br /&gt;
| A 128-bit long hexadecimal identifier with 32 character string representation, like this: &#039;&#039;21EC2020-3AEA-4069-A2DD-08002B30309D&#039;&#039;. Its value is always unique in the Barion system. This is used e.g. to identify payments. For security and compatibility reason the GUID is used without hyphens for most of our API.&lt;br /&gt;
|-&lt;br /&gt;
| DateTime&lt;br /&gt;
| Date and time values, represented in a string format of the &#039;&#039;&#039;ISO-8601&#039;&#039;&#039; standard, like this: &#039;&#039;2014-12-06T08:35:46Z&#039;&#039;. All API call responses contain datetimes as strings.&lt;br /&gt;
|-&lt;br /&gt;
| TimeSpan&lt;br /&gt;
| A time range value represented in a string format of the &#039;&#039;&#039;ISO-8601&#039;&#039;&#039; standard, like this: &#039;&#039;3.14:15:28&#039;&#039; (three days, fourteen hours, fifteen minutes, twenty-eight seconds). All API call responses contain datetimes as strings.&lt;br /&gt;
|-&lt;br /&gt;
| bool&lt;br /&gt;
| Boolean &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; or &amp;lt;code&amp;gt;false&amp;lt;/code&amp;gt; values. &lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; avoid integer or byte evaluation when constructing the request JSON!&lt;br /&gt;
|-&lt;br /&gt;
| byte&lt;br /&gt;
| Byte representation of an enumeration value. This is only for internal use in the Barion system, API call responses always contain the string representation.&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== API URLs ==&lt;br /&gt;
&lt;br /&gt;
The base URL for the Barion API depends on the environment you are connecting to.&lt;br /&gt;
&lt;br /&gt;
Base URL for API requests in the &#039;&#039;&#039;Live (production)&#039;&#039;&#039; environment: &amp;lt;code&amp;gt;https://api.barion.com&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Base URL for API requests in the &#039;&#039;&#039;Sandbox (test)&#039;&#039;&#039; environment: &amp;lt;code&amp;gt;https://api.test.barion.com&amp;lt;/code&amp;gt; (learn more about the Sandbox environment [[Sandbox|here]])&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; Always double check that you are connecting to the proper environment to avoid unnecessary hassle and troubleshooting!&lt;br /&gt;
&lt;br /&gt;
== API versioning ==&lt;br /&gt;
&lt;br /&gt;
To avoid breaking changes, whenever there is a major update to an API endpoint, it is moved to a higher level of API version. At the moment, the Barion API offers two different API versions (noted &amp;lt;code&amp;gt;v1&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;v2&amp;lt;/code&amp;gt;). Some API endpoints are only available in v1 or v2. See the reference page of a given API endpoint to see which versions are available.&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Note:&#039;&#039;&#039; Though version numbers can be omitted from the endpoint path (such requests always fall back to &amp;lt;code&amp;gt;v1&amp;lt;/code&amp;gt;), it is recommended to always specify the API version when sending requests to the Barion API to avoid confusion.&lt;br /&gt;
&lt;br /&gt;
Example paths:&lt;br /&gt;
&lt;br /&gt;
* &amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;https://api.barion.com/Transaction/List&amp;lt;/nowiki&amp;gt;&amp;lt;/code&amp;gt; - implicit call to a &amp;lt;code&amp;gt;v1&amp;lt;/code&amp;gt; endpoint (version number is omitted from path)&lt;br /&gt;
* &amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;https://api.barion.com/v1/Transfer/Send&amp;lt;/nowiki&amp;gt;&amp;lt;/code&amp;gt; - explicit call to a &amp;lt;code&amp;gt;v1&amp;lt;/code&amp;gt; endpoint&lt;br /&gt;
* &amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;https://api.barion.com/v2/Payment/Start&amp;lt;/nowiki&amp;gt;&amp;lt;/code&amp;gt; - explicit call to a &amp;lt;code&amp;gt;v2&amp;lt;/code&amp;gt; endpoint&lt;br /&gt;
&lt;br /&gt;
== Authentication ==&lt;br /&gt;
&lt;br /&gt;
For every request sent to the Barion API you have to authenticate yourself. Depending on the type of endpoint you should use a different type of authentication.&lt;br /&gt;
&lt;br /&gt;
==== Shop-level endpoints ====&lt;br /&gt;
&lt;br /&gt;
Shop-level endpoints can be authenticated using the shop&#039;s unique &amp;lt;tt&amp;gt;POSKey&amp;lt;/tt&amp;gt;. For more details on using and obtaining the POS key, see the [[Barion Shop Authentication]] page.&lt;br /&gt;
&lt;br /&gt;
==== Wallet-level endpoints ====&lt;br /&gt;
&lt;br /&gt;
You can authenticate yourself to endpoints requiring wallet-level authentication via an API key called a &amp;lt;tt&amp;gt;Wallet key&amp;lt;/tt&amp;gt;. For more information on using this API key, see [[Barion Wallet Authentication]].&lt;br /&gt;
&lt;br /&gt;
Note that wallet key authentication is currently only available in the sandbox environment - for production, use [[Basic authentication]].&lt;br /&gt;
&lt;br /&gt;
== Handling the response ==&lt;br /&gt;
The structure of the response varies from endpoint to endpoint however on property can found in all of them. Every API response contains an &amp;lt;code&amp;gt;Errors&amp;lt;/code&amp;gt; array. If this array is empty then the request was processed successfully. This array can contain multiple errors so make sure that the integration is prepared for this. The errors have the following fields&amp;gt;&lt;br /&gt;
&lt;br /&gt;
{| class=&amp;quot;wikitable api-table&amp;quot;&lt;br /&gt;
! FieldName || Description&lt;br /&gt;
|-&lt;br /&gt;
| ErrorCode || The error code of the payment, this can be interpreted as an error Id.&lt;br /&gt;
|-&lt;br /&gt;
| Title|| The title of the error, this is a more readable form of the error.&lt;br /&gt;
|-&lt;br /&gt;
| Description|| The description of the error, more information about the error.&lt;br /&gt;
|-&lt;br /&gt;
| EndPoint || The URL of the API endpoint to help the reproduction of the error scenario.&lt;br /&gt;
|-&lt;br /&gt;
| AuthData || The e-mail address of the caller to help the reproduction of the error scenario. &lt;br /&gt;
|-&lt;br /&gt;
| HappenedAt || The timestamp of the response.&lt;br /&gt;
|-&lt;br /&gt;
| PaymentId ||  If the error is related to a business process that involves a given payment, the public identifier of the payment is supplied here. This property is not present on all errors.&lt;br /&gt;
|-&lt;br /&gt;
&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
&#039;&#039;&#039;Example error response&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
The following example shows an error case where the shop does not have an account with the currency it specified when trying to create a payment.&lt;br /&gt;
This is a validation error, so the payment identifier is not applicable.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=json&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;Errors&amp;quot;: [&lt;br /&gt;
    {&lt;br /&gt;
      &amp;quot;ErrorCode&amp;quot;: &amp;quot;NotExistingCurrency&amp;quot;,&lt;br /&gt;
      &amp;quot;Title&amp;quot;: &amp;quot;Payment is not supported&amp;quot;,&lt;br /&gt;
      &amp;quot;Description&amp;quot;: &amp;quot;Payment is not supported. The POS doesn’t have an account that supports EUR!&amp;quot;,&lt;br /&gt;
      &amp;quot;EndPoint&amp;quot;: &amp;quot;https://api.barion.com/v2/Payment/Start&amp;quot;,&lt;br /&gt;
      &amp;quot;AuthData&amp;quot;: &amp;quot;shop@example.com&amp;quot;,&lt;br /&gt;
      &amp;quot;HappenedAt&amp;quot;: &amp;quot;2017-02-06T09:48:13.7694921Z&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  ]&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The following example shows a case where after several successful token charges, the customer deleted their payment card from the Barion system, so the subsequent attempt failed.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;source lang=json&amp;gt;&lt;br /&gt;
{&lt;br /&gt;
  &amp;quot;Errors&amp;quot;: [&lt;br /&gt;
    {&lt;br /&gt;
      &amp;quot;ErrorCode&amp;quot;: &amp;quot;OriginalPaymentCardDoesNotExist&amp;quot;,&lt;br /&gt;
      &amp;quot;Title&amp;quot;: &amp;quot;The original payment card does not exist!&amp;quot;,&lt;br /&gt;
      &amp;quot;Description&amp;quot;: &amp;quot;The payment card that was used for the original payment with recurrence ID &#039;TEST-01&#039; no longer exists in the system!&amp;quot;,&lt;br /&gt;
      &amp;quot;EndPoint&amp;quot;: &amp;quot;https://api.barion.com/v2/Payment/Start&amp;quot;,&lt;br /&gt;
      &amp;quot;AuthData&amp;quot;: &amp;quot;shop@example.com&amp;quot;,&lt;br /&gt;
      &amp;quot;HappenedAt&amp;quot;: &amp;quot;2017-02-06T09:48:13.7694921Z&amp;quot;&lt;br /&gt;
    }&lt;br /&gt;
  ]&lt;br /&gt;
}&lt;br /&gt;
&amp;lt;/source&amp;gt;&lt;br /&gt;
&lt;br /&gt;
==Security==&lt;br /&gt;
Please refer to the [[Security Measures]] page for more information on IT security before staring to code.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3705</id>
		<title>Barion Wallet Authentication</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3705"/>
		<updated>2022-11-15T10:03:21Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: change text to show that the feature is now available in sandbox&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{NotificationBox|title=IMPORTANT|text=This feature is currently only available in the sandbox environment, it will be active in production by the end of November 2022. Until it becomes active, you can use [[Basic authentication]] for wallet-level endpoints. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= What is wallet authentication? =&lt;br /&gt;
&lt;br /&gt;
Some API endpoints can only be reached using wallet-level authentication (for a full list see [[List_of_API_endpoints|List of Barion API endpoints]]). This is achieved through the usage of API keys tied to each wallet.&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=This feature is only available to organizations registered to Barion. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= Using API keys =&lt;br /&gt;
&lt;br /&gt;
To use an endpoint which requires wallet-level authentication, simply send your API key in the &amp;lt;code&amp;gt;x-api-key&amp;lt;/code&amp;gt; header of your request.&lt;br /&gt;
&lt;br /&gt;
The format of the key should be with lower case letters and &amp;lt;strong&amp;gt;without dashes&amp;lt;/strong&amp;gt;. You can directly use values copied from the secure site&#039;s access page.&lt;br /&gt;
&lt;br /&gt;
= Managing API keys =&lt;br /&gt;
&lt;br /&gt;
The management interface of wallet-level API keys can be found on the [https://secure.barion.com Barion secure site] under the &amp;lt;tt&amp;gt;Wallet -&amp;gt; Access&amp;lt;/tt&amp;gt; menu item.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page.png|The wallet key management page with only one active API key]]&lt;br /&gt;
&lt;br /&gt;
You can view your currently active API key or place it onto the clipboard via clicking the icons on the right side of the screen.&lt;br /&gt;
&lt;br /&gt;
== Rotating keys ==&lt;br /&gt;
&lt;br /&gt;
In case a key&#039;s secrecy is compromised it is important to change it to avoid unauthorized parties from using Barion in your name.&lt;br /&gt;
&lt;br /&gt;
You can add a new API key to your wallet by clicking the &amp;quot;rotate&amp;quot; icon to the right of the key. &amp;lt;strong&amp;gt;This does not deactivate the old API key&amp;lt;/strong&amp;gt;, it just adds a new one. After changing all usages of the old key to the new one, the old one can be safely deleted.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page_-_under_rotation.png|The wallet key management page with two active API keys]]&lt;br /&gt;
&lt;br /&gt;
As there can only be at most two active API keys tied to a wallet at all times, it is not possible to rotate one of two active keys. You&#039;ll have to delete one of them to start rotating the other one.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3681</id>
		<title>Barion Wallet Authentication</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3681"/>
		<updated>2022-11-14T11:34:09Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: &lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{NotificationBox|title=IMPORTANT|text=This feature is not yet available, it will be active by the end of November 2022. Until it becomes active, you can use [[Basic authentication]] for wallet-level endpoints. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= What is wallet authentication? =&lt;br /&gt;
&lt;br /&gt;
Some API endpoints can only be reached using wallet-level authentication (for a full list see [[List_of_API_endpoints|List of Barion API endpoints]]). This is achieved through the usage of API keys tied to each wallet.&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=This feature is only available to organizations registered to Barion. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= Using API keys =&lt;br /&gt;
&lt;br /&gt;
To use an endpoint which requires wallet-level authentication, simply send your API key in the &amp;lt;code&amp;gt;x-api-key&amp;lt;/code&amp;gt; header of your request.&lt;br /&gt;
&lt;br /&gt;
The format of the key should be with lower case letters and &amp;lt;strong&amp;gt;without dashes&amp;lt;/strong&amp;gt;. You can directly use values copied from the secure site&#039;s access page.&lt;br /&gt;
&lt;br /&gt;
= Managing API keys =&lt;br /&gt;
&lt;br /&gt;
The management interface of wallet-level API keys can be found on the [https://secure.barion.com Barion secure site] under the &amp;lt;tt&amp;gt;Wallet -&amp;gt; Access&amp;lt;/tt&amp;gt; menu item.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page.png|The wallet key management page with only one active API key]]&lt;br /&gt;
&lt;br /&gt;
You can view your currently active API key or place it onto the clipboard via clicking the icons on the right side of the screen.&lt;br /&gt;
&lt;br /&gt;
== Rotating keys ==&lt;br /&gt;
&lt;br /&gt;
In case a key&#039;s secrecy is compromised it is important to change it to avoid unauthorized parties from using Barion in your name.&lt;br /&gt;
&lt;br /&gt;
You can add a new API key to your wallet by clicking the &amp;quot;rotate&amp;quot; icon to the right of the key. &amp;lt;strong&amp;gt;This does not deactivate the old API key&amp;lt;/strong&amp;gt;, it just adds a new one. After changing all usages of the old key to the new one, the old one can be safely deleted.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page_-_under_rotation.png|The wallet key management page with two active API keys]]&lt;br /&gt;
&lt;br /&gt;
As there can only be at most two active API keys tied to a wallet at all times, it is not possible to rotate one of two active keys. You&#039;ll have to delete one of them to start rotating the other one.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3658</id>
		<title>Barion Wallet Authentication</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3658"/>
		<updated>2022-11-14T07:54:13Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: add &amp;quot;soon available&amp;quot;&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{NotificationBox|title=IMPORTANT|text=This feature will be active soon, but is not yet available. Until it becomes active, you can use [[Basic authentication]] for wallet-level endpoints. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= What is wallet authentication? =&lt;br /&gt;
&lt;br /&gt;
Some API endpoints can only be reached using wallet-level authentication (for a full list see [[List_of_API_endpoints|List of Barion API endpoints]]). This is achieved through the usage of API keys tied to each wallet.&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=This feature is only available to organizations registered to Barion. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= Using API keys =&lt;br /&gt;
&lt;br /&gt;
To use an endpoint which requires wallet-level authentication, simply send your API key in the &amp;lt;code&amp;gt;x-api-key&amp;lt;/code&amp;gt; header of your request.&lt;br /&gt;
&lt;br /&gt;
The format of the key should be with lower case letters and &amp;lt;strong&amp;gt;without dashes&amp;lt;/strong&amp;gt;. You can directly use values copied from the secure site&#039;s access page.&lt;br /&gt;
&lt;br /&gt;
= Managing API keys =&lt;br /&gt;
&lt;br /&gt;
The management interface of wallet-level API keys can be found on the [https://secure.barion.com Barion secure site] under the &amp;lt;tt&amp;gt;Wallet -&amp;gt; Access&amp;lt;/tt&amp;gt; menu item.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page.png|The wallet key management page with only one active API key]]&lt;br /&gt;
&lt;br /&gt;
You can view your currently active API key or place it onto the clipboard via clicking the icons on the right side of the screen.&lt;br /&gt;
&lt;br /&gt;
== Rotating keys ==&lt;br /&gt;
&lt;br /&gt;
In case a key&#039;s secrecy is compromised it is important to change it to avoid unauthorized parties from using Barion in your name.&lt;br /&gt;
&lt;br /&gt;
You can add a new API key to your wallet by clicking the &amp;quot;rotate&amp;quot; icon to the right of the key. &amp;lt;strong&amp;gt;This does not deactivate the old API key&amp;lt;/strong&amp;gt;, it just adds a new one. After changing all usages of the old key to the new one, the old one can be safely deleted.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page_-_under_rotation.png|The wallet key management page with two active API keys]]&lt;br /&gt;
&lt;br /&gt;
As there can only be at most two active API keys tied to a wallet at all times, it is not possible to rotate one of two active keys. You&#039;ll have to delete one of them to start rotating the other one.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Barion_Shop_Authentication&amp;diff=3645</id>
		<title>Barion Shop Authentication</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Barion_Shop_Authentication&amp;diff=3645"/>
		<updated>2022-11-10T07:55:19Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: create page initial version&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= What is shop authentication? =&lt;br /&gt;
&lt;br /&gt;
The API endpoints related to handling the payment flow of a shop are accessible using the shop&#039;s own unique API key, a so called &amp;lt;i&amp;gt;POS key&amp;lt;/i&amp;gt;. For a full list of such endpoints see [[List_of_API_endpoints|List of Barion API endpoints]].&lt;br /&gt;
&lt;br /&gt;
= Using POS keys =&lt;br /&gt;
&lt;br /&gt;
To use an endpoint which requires shop-level authentication, put your API key in the request&#039;s body in a property named &amp;lt;code&amp;gt;PosKey&amp;lt;/code&amp;gt;:&lt;br /&gt;
&lt;br /&gt;
    {&lt;br /&gt;
      ...,&lt;br /&gt;
      &amp;quot;PosKey&amp;quot;: &amp;quot;00000000-0000-0000-0000-000000000000&amp;quot;,&lt;br /&gt;
      ...&lt;br /&gt;
    }&lt;br /&gt;
&lt;br /&gt;
or in the case of a &amp;lt;tt&amp;gt;GET&amp;lt;/tt&amp;gt; request, in the url query string with the same key.&lt;br /&gt;
&lt;br /&gt;
== Errors ==&lt;br /&gt;
&lt;br /&gt;
If the key is invalid you will receive an &amp;lt;code&amp;gt;AuthenticationFailed&amp;lt;/code&amp;gt; error.&lt;br /&gt;
&lt;br /&gt;
= Managing POS keys =&lt;br /&gt;
&lt;br /&gt;
A POS key is automatically generated for your shop when you create it, and cannot be changed later. To obtain it, either&lt;br /&gt;
* get the key from the confirmation e-mail that was sent to you when you opened the shop, or&lt;br /&gt;
* go to the shop&#039;s detail page on the [https://secure.barion.com Barion secure site] and use the &amp;lt;i&amp;gt;Secret key&amp;lt;/i&amp;gt; value (secure.barion.com -&amp;gt; Manage my shops -&amp;gt; Details)&lt;br /&gt;
&lt;br /&gt;
Be aware that the test and live environment are completely separate environments, you need to create different shops. Make sure that you use the POSkey and not the public key:&lt;br /&gt;
&lt;br /&gt;
[[File:Poskey.jpg]]&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3644</id>
		<title>Barion Wallet Authentication</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=Barion_Wallet_Authentication&amp;diff=3644"/>
		<updated>2022-11-10T07:55:04Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: create page initial version&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;= What is wallet authentication? =&lt;br /&gt;
&lt;br /&gt;
Some API endpoints can only be reached using wallet-level authentication (for a full list see [[List_of_API_endpoints|List of Barion API endpoints]]). This is achieved through the usage of API keys tied to each wallet.&lt;br /&gt;
&lt;br /&gt;
{{NotificationBox|title=NOTE|text=This feature is only available to organizations registered to Barion. |color=#FF7A3D}}&lt;br /&gt;
&lt;br /&gt;
= Using API keys =&lt;br /&gt;
&lt;br /&gt;
To use an endpoint which requires wallet-level authentication, simply send your API key in the &amp;lt;code&amp;gt;x-api-key&amp;lt;/code&amp;gt; header of your request.&lt;br /&gt;
&lt;br /&gt;
The format of the key should be with lower case letters and &amp;lt;strong&amp;gt;without dashes&amp;lt;/strong&amp;gt;. You can directly use values copied from the secure site&#039;s access page.&lt;br /&gt;
&lt;br /&gt;
= Managing API keys =&lt;br /&gt;
&lt;br /&gt;
The management interface of wallet-level API keys can be found on the [https://secure.barion.com Barion secure site] under the &amp;lt;tt&amp;gt;Wallet -&amp;gt; Access&amp;lt;/tt&amp;gt; menu item.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page.png|The wallet key management page with only one active API key]]&lt;br /&gt;
&lt;br /&gt;
You can view your currently active API key or place it onto the clipboard via clicking the icons on the right side of the screen.&lt;br /&gt;
&lt;br /&gt;
== Rotating keys ==&lt;br /&gt;
&lt;br /&gt;
In case a key&#039;s secrecy is compromised it is important to change it to avoid unauthorized parties from using Barion in your name.&lt;br /&gt;
&lt;br /&gt;
You can add a new API key to your wallet by clicking the &amp;quot;rotate&amp;quot; icon to the right of the key. &amp;lt;strong&amp;gt;This does not deactivate the old API key&amp;lt;/strong&amp;gt;, it just adds a new one. After changing all usages of the old key to the new one, the old one can be safely deleted.&lt;br /&gt;
&lt;br /&gt;
[[File:Wallet_key_management_page_-_under_rotation.png|The wallet key management page with two active API keys]]&lt;br /&gt;
&lt;br /&gt;
As there can only be at most two active API keys tied to a wallet at all times, it is not possible to rotate one of two active keys. You&#039;ll have to delete one of them to start rotating the other one.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=File:Wallet_key_management_page_-_under_rotation.png&amp;diff=3643</id>
		<title>File:Wallet key management page - under rotation.png</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=File:Wallet_key_management_page_-_under_rotation.png&amp;diff=3643"/>
		<updated>2022-11-07T18:36:45Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: A cropped screenshot of the secure site&amp;#039;s access page of keys currently under rotation.&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Summary ==&lt;br /&gt;
A cropped screenshot of the secure site&#039;s access page of keys currently under rotation.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=File:Wallet_key_management_page.png&amp;diff=3642</id>
		<title>File:Wallet key management page.png</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=File:Wallet_key_management_page.png&amp;diff=3642"/>
		<updated>2022-11-07T18:24:06Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: A cropped screenshot of the secure site&amp;#039;s wallet key management interface.&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;== Summary ==&lt;br /&gt;
A cropped screenshot of the secure site&#039;s wallet key management interface.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
	<entry>
		<id>https://docs.barion.com/index.php?title=RecipientAddress&amp;diff=3530</id>
		<title>RecipientAddress</title>
		<link rel="alternate" type="text/html" href="https://docs.barion.com/index.php?title=RecipientAddress&amp;diff=3530"/>
		<updated>2022-08-08T06:03:38Z</updated>

		<summary type="html">&lt;p&gt;Adamsz: added examples, made length restrictions more clear&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;{{PageTitle|title=Recipient Address}}&lt;br /&gt;
&lt;br /&gt;
This structure represents recipient address that is used as the recipient of an outgoing bank (wire) transfer from the Barion system.&lt;br /&gt;
&lt;br /&gt;
= API usage =&lt;br /&gt;
&lt;br /&gt;
This structure is used by the following API endpoints:&lt;br /&gt;
* [[Withdraw-BankTransfer-v3]]&lt;br /&gt;
&lt;br /&gt;
= Property list =&lt;br /&gt;
&lt;br /&gt;
{{api_input_table_header}}&lt;br /&gt;
|-&lt;br /&gt;
| Country&lt;br /&gt;
| string&lt;br /&gt;
|&lt;br /&gt;
* Required&lt;br /&gt;
* Exactly 3 characters long&lt;br /&gt;
| The country of the recipient, in 3-letter country code (ISO 3166-1 Alpha-3) format&lt;br /&gt;
|-&lt;br /&gt;
| Street || string ||&lt;br /&gt;
* Required&lt;br /&gt;
||Street and street number part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF and for fraud analysis.&lt;br /&gt;
|-&lt;br /&gt;
| City || string || &lt;br /&gt;
* Required&lt;br /&gt;
|| City part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF.&lt;br /&gt;
|-&lt;br /&gt;
| Zip || string || &lt;br /&gt;
* Required&lt;br /&gt;
* Max. 16 characters long&lt;br /&gt;
|| Zip part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF and for fraud analysis.&lt;br /&gt;
|-&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
Additional length restrictions for this type apply based on currency:  &lt;br /&gt;
&lt;br /&gt;
* in the case of &amp;lt;strong&amp;gt;CZK&amp;lt;/strong&amp;gt; currency:&lt;br /&gt;
** &amp;lt;strong&amp;gt;Street&amp;lt;/strong&amp;gt;: max. 35 characters&lt;br /&gt;
** &amp;lt;strong&amp;gt;City&amp;lt;/strong&amp;gt;: max. 35 characters&lt;br /&gt;
* in the case of &amp;lt;strong&amp;gt;HUF&amp;lt;/strong&amp;gt;, &amp;lt;strong&amp;gt;EUR&amp;lt;/strong&amp;gt;, and &amp;lt;strong&amp;gt;USD&amp;lt;/strong&amp;gt; currencies:&lt;br /&gt;
** &amp;lt;strong&amp;gt;Sum of Street, City, And Zip&amp;lt;/strong&amp;gt;: max. 54 characters&lt;br /&gt;
&lt;br /&gt;
== Examples for recipient address ==&lt;br /&gt;
&lt;br /&gt;
=== Valid Czech foreign transfer ===&lt;br /&gt;
&lt;br /&gt;
Currency is &amp;lt;code&amp;gt;CZK&amp;lt;/code&amp;gt;, bank account number format is &amp;lt;code&amp;gt;IBAN&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
All components are shorter than their maximum lengths.&lt;br /&gt;
&lt;br /&gt;
  {&lt;br /&gt;
    &amp;quot;Country&amp;quot;: &amp;quot;Deu&amp;quot;,&lt;br /&gt;
    &amp;quot;Zip&amp;quot;: &amp;quot;80804&amp;quot;,&lt;br /&gt;
    &amp;quot;City&amp;quot;: &amp;quot;München&amp;quot;,&lt;br /&gt;
    &amp;quot;Street&amp;quot;: &amp;quot;Leopoldstraße 146.&amp;quot;&lt;br /&gt;
  }&lt;br /&gt;
&lt;br /&gt;
=== Inalid Czech foreign transfer ===&lt;br /&gt;
&lt;br /&gt;
Currency is &amp;lt;code&amp;gt;CZK&amp;lt;/code&amp;gt;, bank account number format is &amp;lt;code&amp;gt;IBAN&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Street&amp;lt;/code&amp;gt; is 36 characters long, making the address invalid for CZK transfers.&lt;br /&gt;
&lt;br /&gt;
  {&lt;br /&gt;
    &amp;quot;Country&amp;quot;: &amp;quot;Hun&amp;quot;,&lt;br /&gt;
    &amp;quot;Zip&amp;quot;: &amp;quot;1183&amp;quot;,&lt;br /&gt;
    &amp;quot;City&amp;quot;: &amp;quot;Budapest&amp;quot;,&lt;br /&gt;
    &amp;quot;Street&amp;quot;: &amp;quot;Ferihegyi repülőtérre vezető út 23/B&amp;quot;&lt;br /&gt;
  }&lt;br /&gt;
&lt;br /&gt;
=== Valid EUR transfer ===&lt;br /&gt;
&lt;br /&gt;
Currency is &amp;lt;code&amp;gt;EUR&amp;lt;/code&amp;gt; (note: same rules for &amp;lt;code&amp;gt;USD&amp;lt;/code&amp;gt; and foreign &amp;lt;code&amp;gt;HUF&amp;lt;/code&amp;gt;), bank account number format is &amp;lt;code&amp;gt;IBAN&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Street&amp;lt;/code&amp;gt; is 36 characters long, &amp;lt;code&amp;gt;City&amp;lt;/code&amp;gt; is 8 characters long, and &amp;lt;code&amp;gt;Zip&amp;lt;/code&amp;gt; is 4. The sum is 48, which is &amp;amp;lt;= 54 so this address is valid for this transfer.&lt;br /&gt;
&lt;br /&gt;
  {&lt;br /&gt;
    &amp;quot;Country&amp;quot;: &amp;quot;Hun&amp;quot;,&lt;br /&gt;
    &amp;quot;Zip&amp;quot;: &amp;quot;1183&amp;quot;,&lt;br /&gt;
    &amp;quot;City&amp;quot;: &amp;quot;Budapest&amp;quot;,&lt;br /&gt;
    &amp;quot;Street&amp;quot;: &amp;quot;Ferihegyi repülőtérre vezető út 23/B&amp;quot;&lt;br /&gt;
  }&lt;br /&gt;
&lt;br /&gt;
=== Invalid EUR transfer ===&lt;br /&gt;
&lt;br /&gt;
Currency is &amp;lt;code&amp;gt;EUR&amp;lt;/code&amp;gt;, bank account number format is &amp;lt;code&amp;gt;IBAN&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Street&amp;lt;/code&amp;gt; is 58 characters long, which is in itself longer than the total allowed 54 for &amp;lt;code&amp;gt;Street&amp;lt;/code&amp;gt;, &amp;lt;code&amp;gt;City&amp;lt;/code&amp;gt;, and &amp;lt;code&amp;gt;Zip&amp;lt;/code&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
  {&lt;br /&gt;
    &amp;quot;Country&amp;quot;: &amp;quot;Hun&amp;quot;,&lt;br /&gt;
    &amp;quot;Zip&amp;quot;: &amp;quot;1183&amp;quot;,&lt;br /&gt;
    &amp;quot;City&amp;quot;: &amp;quot;Budapest&amp;quot;,&lt;br /&gt;
    &amp;quot;Street&amp;quot;: &amp;quot;Ferihegyi repülőtérre vezető út 23/B 7. emelet 27-es lakás&amp;quot;&lt;br /&gt;
  }&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;Zip&amp;lt;/code&amp;gt; is more than 16 characters long, which makes the address invalid even if the total for the three components that are counted in the maximum 54 characters is short enough.&lt;br /&gt;
&lt;br /&gt;
  {&lt;br /&gt;
    &amp;quot;Country&amp;quot;: &amp;quot;Nar&amp;quot;,&lt;br /&gt;
    /* Narnia is a very big country, too many zip codes */&lt;br /&gt;
    &amp;quot;Zip&amp;quot;: &amp;quot;61248531479548248&amp;quot;,&lt;br /&gt;
    &amp;quot;City&amp;quot;: &amp;quot;Snowy Mountain&amp;quot;,&lt;br /&gt;
    &amp;quot;Street&amp;quot;: &amp;quot;Yak Street 35.&amp;quot;&lt;br /&gt;
  }&lt;br /&gt;
&lt;br /&gt;
&lt;br /&gt;
=== Valid domestic CZK and HUF transfers ===&lt;br /&gt;
&lt;br /&gt;
The same rules apply to domestic &amp;lt;code&amp;gt;CZK&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;HUF&amp;lt;/code&amp;gt; transfers as to foreign &amp;lt;code&amp;gt;CZK&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;HUF&amp;lt;/code&amp;gt; transfers, respectively. If the address is invalid, it can be omitted in the case of domestic transfers, making the whole transfer valid again.&lt;/div&gt;</summary>
		<author><name>Adamsz</name></author>
	</entry>
</feed>