PaymentTransaction: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (13 intermediate revisions by 6 users not shown) | |||
| Line 7: | Line 7: | ||
This structure is used by the following API endpoints: | This structure is used by the following API endpoints: | ||
* [[Payment-Start-v2]] | * [[Payment-Start-v2]] | ||
== Property list == | == Property list == | ||
| Line 20: | Line 19: | ||
* Required | * Required | ||
* Must be the e-mail address of a valid Barion wallet | * Must be the e-mail address of a valid Barion wallet | ||
|| The recipient user of the transaction. This Barion | || The recipient user of the transaction. This Barion Wallet receives the money when the payment is completed by the payer. | ||
|- | |- | ||
| Total || decimal || | | Total || decimal || | ||
* Required | * Required | ||
* Must be greater than | * Must be greater than [[Responsive_web_payment#Minimum_amounts|the minimum transaction amount in the given currency]] | ||
* Decimal precision depends on payment | * Decimal precision depends on payment currency | ||
|| The total amount of the transaction. This is the amount that is charged towards the payer when completing the payment. | || The total amount of the transaction. This is the amount that is charged towards the payer when completing the payment. The final amount of the transactiom. This will overwrite the original amount. | ||
The allowed number of decimal digits depends on the currency of the payment containing this transaction: | The allowed number of decimal digits depends on the currency of the payment containing this transaction: | ||
* CZK: two digits | |||
* EUR: two digits | |||
* HUF: zero digits | * HUF: zero digits | ||
* USD: two digits | * USD: two digits | ||
|- | |- | ||
| Comment || string || | | Comment || string || | ||
* Optional | * Optional | ||
|| A comment associated with the transaction. This is NOT shown to the payer. | || A comment associated with the transaction. This is NOT shown to the payer. Description of the transaction, this will overwrite the original description | ||
|- | |- | ||
| PayeeTransactions || [[PayeeTransaction]][] || | | PayeeTransactions || [[PayeeTransaction]][] || | ||
| Line 42: | Line 42: | ||
|- | |- | ||
| Items || [[Item]][] || | | Items || [[Item]][] || | ||
* | * Required | ||
|| An array containing the items (products or services) included in the transaction. See the [[Item]] page for structure and syntax. | || An array containing the items (products or services) included in the transaction. See the [[Item]] page for structure and syntax. Items of the transaction. These will overwrite the original items | ||
These are shown to the payer on the Barion Smart Gateway. | These are shown to the payer on the Barion Smart Gateway. | ||
|- | |- | ||
|} | |} | ||
Latest revision as of 06:11, 10 July 2024
Payment transaction structure
This structure represents a payment transaction related to a payment. One payment can contain multiple payment transactions.
API usage
This structure is used by the following API endpoints:
Property list
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| POSTransactionId | string |
|
The unique identifier of the transaction at the shop that started the payment. |
| Payee | string |
|
The recipient user of the transaction. This Barion Wallet receives the money when the payment is completed by the payer. |
| Total | decimal |
|
The total amount of the transaction. This is the amount that is charged towards the payer when completing the payment. The final amount of the transactiom. This will overwrite the original amount.
The allowed number of decimal digits depends on the currency of the payment containing this transaction:
|
| Comment | string |
|
A comment associated with the transaction. This is NOT shown to the payer. Description of the transaction, this will overwrite the original description |
| PayeeTransactions | PayeeTransaction[] |
|
An array containing possible sub-transactions, which are executed after the payment was completed. These are e-money transactions that always take place in the Barion system. See the PayeeTransaction page for structure and syntax.
These are NOT shown to the payer. |
| Items | Item[] |
|
An array containing the items (products or services) included in the transaction. See the Item page for structure and syntax. Items of the transaction. These will overwrite the original items
These are shown to the payer on the Barion Smart Gateway. |