Payment-CancelAuthorization-v2: Difference between revisions
Jump to navigation
Jump to search
Stankovicsa (talk | contribs) No edit summary |
No edit summary |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 17: | Line 17: | ||
* [[Calling_the_API|Calling the Barion API]] | * [[Calling_the_API|Calling the Barion API]] | ||
* API: [[Payment-Start-v2 | /Payment/Start]] | * API: [[Payment-Start-v2 | /Payment/Start]] | ||
* API: [[Payment- | * API: [[Payment-PaymentState-v4|/v4/Payment/<PaymentId>/PaymentState]] | ||
<span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only. | <span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only. | ||
{{NotificationBox|title=IMPORTANT|text=This endpoint can only be used for "DelayedCapture" type payments.|color=#FF7A3D}} | |||
{{NotificationBox|title=NOTE|text=In some cases, the card issuers do not release the authorized amount immediately after the Barion sends the appropriate message to them. In these cases, the transaction amount will be released automatically by the issuer bank within a few days after the merchant canceled the payment.|color=#1993C7}} | |||
{{NotificationBox|title=NOTE|text= | |||
The cancelation called within one day after the authorization request can be much faster than the release completed later. In most cases, the intraday cancelation immediately releases the amount on the cardholder's account.|color=#1993C7}} | |||
== Authentication == | |||
[[Barion Shop Authentication]] | |||
== Use cases == | == Use cases == | ||
Latest revision as of 08:01, 30 July 2024
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 are 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: /v4/Payment/<PaymentId>/PaymentState
v2 This API endpoint is available in API v2 only.
IMPORTANT
This endpoint can only be used for "DelayedCapture" type payments.
NOTE
In some cases, the card issuers do not release the authorized amount immediately after the Barion sends the appropriate message to them. In these cases, the transaction amount will be released automatically by the issuer bank within a few days after the merchant canceled the payment.
NOTE
The cancelation called within one day after the authorization request can be much faster than the release completed later. In most cases, the intraday cancelation immediately releases the amount on the cardholder's account.
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. |
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 |