Payment-CancelAuthorization-v2: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
(change auth description)
mNo edit summary
Line 16: Line 16:
* [[Creating_a_shop|Creating a shop in Barion]]
* [[Creating_a_shop|Creating a shop in Barion]]
* [[Calling_the_API|Calling the Barion API]]
* [[Calling_the_API|Calling the Barion API]]
* [[Barion Shop Authentication]]
* API: [[Payment-Start-v2 | /Payment/Start]]
* API: [[Payment-Start-v2 | /Payment/Start]]
* API: [[Payment-GetPaymentState-v2 | /Payment/GetPaymentState]]
* API: [[Payment-GetPaymentState-v2 | /Payment/GetPaymentState]]
Line 27: Line 26:
{{NotificationBox|title=NOTE|text=
{{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}}
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 ==

Revision as of 10:51, 15 November 2022

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:


v2 This API endpoint is available in API v2 only.

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

Barion Shop 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
  • 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
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