Payment-FinishReservation-v2: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 14: | Line 14: | ||
* [[Creating_a_shop|Creating a shop in Barion]] | * [[Creating_a_shop|Creating a shop in Barion]] | ||
* [[Calling_the_API| Start a payment]] | * [[Calling_the_API| Start a payment]] | ||
* API: [[Payment-Start-v2 | /Payment/Start]] | |||
== Authentication == | |||
[[Barion Shop Authentication]] | |||
== Use cases == | == Use cases == | ||
| Line 19: | Line 24: | ||
This API endpoint is designed to be used in the following scenarios: | This API endpoint is designed to be used in the following scenarios: | ||
* [[Reservation_payment|Payments with reservation]] | * [[Reservation_payment|Payments with reservation]] | ||
== Input properties == | == Input properties == | ||
| Line 35: | Line 39: | ||
|- | |- | ||
|Transactions || [[ | |Transactions || [[TransactionToFinish]][] || | ||
* Required | * Required | ||
|| The <u>payment transactions</u> that the shop would like to finish. | || The <u>payment transactions</u> that the shop would like to finish. | ||
| Line 44: | Line 48: | ||
* Each payment transaction can only be finished once. | * Each payment transaction can only be finished once. | ||
* It is not neccessary to finish all transactions in the same API call, but one call must contain at least one transaction to finish. | * It is not neccessary to finish all transactions in the same API call, but one call must contain at least one transaction to finish. | ||
* If a transaction is finished with a '''Total''' amount lesser than | * If a transaction is finished with a '''Total''' amount lesser than its initial value, the remaining amount is refunded to the payer. | ||
* If the reservation period passes, all unfinished transactions are finished with zero amount. | * If the reservation period passes, all unfinished transactions are finished with zero amount. | ||
| Line 52: | Line 56: | ||
|- | |- | ||
| | |IsSuccessful || bool || Result of the transaction | ||
|- | |- | ||
Latest revision as of 10:50, 15 November 2022
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:
Authentication
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 |
|
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 |
|
The identifier of the payment in the Barion system. |
| Transactions | TransactionToFinish[] |
|
The payment transactions that the shop would like to finish. |
Important things about the transaction structure
- The Transactions[] array should only contain the initial payment transactions. The additional transactions generated by the Barion system (e.g. fees) must not be included in the call.
- Each payment transaction can only be finished once.
- It is not neccessary to finish all transactions in the same API call, but one call must contain at least one transaction to finish.
- If a transaction is finished with a Total amount lesser than its initial value, the remaining amount is refunded to the payer.
- If the reservation period passes, all unfinished transactions are finished with zero amount.
Output properties
| Property name | Property type | Description |
|---|---|---|
| IsSuccessful | 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 |