Difference between revisions of "TransactionToFinish"

From Barion Documentation
Jump to navigation Jump to search
(PayeeTransactions description)
m (Property list)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{PageTitle|title=Payment transaction structure when finishing reservations}}
+
{{PageTitle|title=Payment transaction structure when finishing reservations or delayed captures}}
  
This structure represents a [[PaymentTransaction|payment transaction]] related to a payment, when used for finishing pending reservations.
+
This structure represents a [[PaymentTransaction|payment transaction]] related to a payment, when used for finishing pending reservations or delayed captures.
  
 
== API usage ==  
 
== API usage ==  
Line 7: Line 7:
 
This structure is used by the following API endpoints:
 
This structure is used by the following API endpoints:
 
* [[Payment-FinishReservation-v2]]
 
* [[Payment-FinishReservation-v2]]
 +
* [[Payment-Capture-v2]]
  
 
== Property list ==
 
== Property list ==
Line 18: Line 19:
 
| Total || decimal ||  
 
| Total || decimal ||  
 
* Required
 
* Required
* Must be greater than zero
+
* Must be greater than or equal to zero
 
* Decimal precision depends on payment curreny
 
* Decimal precision depends on payment curreny
 
|| 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 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.  

Latest revision as of 12:46, 9 June 2020

Payment transaction structure when finishing reservations or delayed captures

This structure represents a payment transaction related to a payment, when used for finishing pending reservations or delayed captures.

API usage

This structure is used by the following API endpoints:

Property list

Property name Property type Limitations and constraints Description
TransactionId guid
  • Required
The unique identifier of the transaction in the Barion system.
Total decimal
  • Required
  • Must be greater than or equal to zero
  • Decimal precision depends on payment curreny
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:

  • CZK: two digits
  • EUR: two digits
  • HUF: zero digits
  • USD: two digits
Comment string
  • Optional
A comment associated with the transaction. This is NOT shown to the payer. Description of the transaction, this will overwrite the original description
PayeeTransactions PayeeTransactionToFinish[]
  • Optional
An array containing the sub-transactions. You have to add all payee transaction which was in the original payment start request . See the PayeeTransactionToFinish page for structure and syntax.

These are NOT shown to the payer.

Items Item[]
  • Optional
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.