Payment-FinishReservation-v2: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 40: | Line 40: | ||
{{api_output_table_header}} | {{api_output_table_header}} | ||
|- | |||
|Isuccessful || bool || Result of the transaction | |||
|- | |- | ||
| Line 52: | Line 55: | ||
| Status || [[PaymentStatus]]|| The status of the payment in the Barion system. | | Status || [[PaymentStatus]]|| The status of the payment in the Barion system. | ||
|- | |- | ||
|Transactions|| [[ProcessedTransaction]][] || Related transactions | |Transactions|| [[ProcessedTransaction]][] || Related transactions | ||
|} | |} | ||
Revision as of 10:41, 13 December 2017
Finish reservation
| POST | /v2/Payment/FinishReservation |
|---|
The /payment/FinishReservation API endpoint is used to finalize a reserved payment in the Barion system.
Prerequisites before use:
Use cases
This API endpoint is designed to be used in the following scenarios:
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
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| POSKey | Guid |
|
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 |
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 |