Difference between revisions of "Payment-FinishReservation-v2"

From Barion Documentation
Jump to navigation Jump to search
Line 30: Line 30:
  
 
|-
 
|-
|PaymentId || Guid || *Required || Payment identifier, generated by Barion
+
|PaymentId || Guid ||  
 +
* Required  
 +
|| The identifier of the payment in the Barion system.
  
 
|-
 
|-
|Transactions || [[PaymentTransaction]][] || *Required || Array of transactions
+
|Transactions || [[PaymentTransaction]][] ||  
 +
* Required  
 +
|| The <u>payment transactions</u> that the shop would like to finish.
 +
'''Note''': each payment transaction can be finished only once
 
|}
 
|}
  

Revision as of 08:17, 19 December 2017

Barion API: Finish a pending reservation

POST /v2/Payment/FinishReservation

The /payment/finishreservation API endpoint is used to finalize a pending reservation in the Barion system.

Prerequisites before use:

Use cases

This API endpoint is designed to be used in the following scenarios:

Input properties

Property name Property type Limitations and constraints Description
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.
PaymentId Guid
  • Required
The identifier of the payment in the Barion system.
Transactions PaymentTransaction[]
  • Required
The payment transactions that the shop would like to finish.

Note: each payment transaction can be finished only once

Output properties

Property name Property type Description
Isuccessful bool Result of the transaction
PaymentId Guid The identifier of the newly initialized payment, generated by the Barion system.
PaymentRequestId string The payment identifier supplied by the API caller in the request.
Status PaymentStatus The status of the payment in the Barion system.
Transactions ProcessedTransaction[] Related transactions