Payment-CancelAuthorization-v2: Difference between revisions
Jump to navigation
Jump to search
Stankovicsa (talk | contribs) (Created page with "{{PageTitle|title=Barion API: Cancel an authorized payment}} {| style="margin-left:2em;" align="right" | __TOC__ |} {{api_callmethod |method=POST |uri=/v2/Payment/CancelAuth...") |
Stankovicsa (talk | contribs) No edit summary |
||
| Line 10: | Line 10: | ||
}} | }} | ||
The <code>/payment/cancelauthorization</code> API endpoint is used to cancel an existing, previously authorized payment. | The <code>/payment/cancelauthorization</code> API endpoint is used to cancel an existing, previously authorized payment. All transactions is reversed, and the payment is finished with 0 amount. The blocking of the amount on the payment card is lifted. | ||
Prerequisites before use: | Prerequisites before use: | ||
Revision as of 10:51, 23 July 2019
Barion API: Cancel an authorized payment
| POST | /v2/Payment/CancelAuthorization |
|---|
The /payment/cancelauthorization API endpoint is used to cancel an existing, previously authorized payment. All transactions is reversed, and the payment is finished with 0 amount. The blocking of the amount on the payment card is lifted.
Prerequisites before use:
- Creating an account in Barion
- Creating a shop in Barion
- Calling the Barion API
- API: /Payment/Start
- API: /Payment/GetPaymentState
v2 This API endpoint is available in API v2 only.
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. |
Output properties
| Property name | Property type | Description |
|---|---|---|
| IsSuccessful | bool | Result of the transaction |
| PaymentId | Guid | The identifier of the 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 |