Revision as of 08:15, 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:

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

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	Payment identifier, generated by Barion
Transactions	PaymentTransaction[]	*Required	Array of transactions

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

@@ Line 1: / Line 1: @@
-__NOTOC__
+{{PageTitle|title=Barion API: Finish a pending reservation}}
-{{PageTitle|title=Finish reservation}}
+{{TableOfContents}}
 {{api_callmethod
@@ Line 7: / Line 8: @@
 }}
-The <code>/payment/FinishReservation</code> API endpoint is used to finalize a reserved payment in the Barion system.
+The <code>/payment/finishreservation</code> API endpoint is used to finalize a pending reservation in the Barion system.
 Prerequisites before use:
@@ Line 19: / Line 20: @@
 * [[Reservation_payment|Payments with reservation]]
 * [[Marketplace|Marketplace, sharing economy, and facilitated payments]]
-With this API call the shop can finalize  transactions approved by users. The users can approve their transaction via the Barion GUI. In case of reservation, the transaction can not be finished if the amount exceeds the one what user approved. If a transaction finished with 0 currency then the users gets back the full reserved amount. If the finalized  amount is lesser than the reserved amount, the margin will be refunded to the user’s wallet. For every
-finalization the shop’s owner must identify itself via Barion API.
 == Input properties ==