DocumentationAPI Reference

Reversal/Cancellation

Cancel the authorization on a payment that has not yet been captured.

Suggest Edits

A Reversal or Cancellation request is used when you need to free reserved funds on the customer's account, for example, because an item is out of stock and you need to cancel the payment.
If the transaction has not been captured, such a request can be used ONLY on successful pre-authorization.
Also, a reversal request will fail if pre-authorization expires.

Step 1. Make a reversal request

To cancel a payment, make a POST /pay/backoffice/payment_reversal request from your server.

POST https://sandbox.payabl.com/pay/backoffice/payment_reversal

In your request, include:

  • merchantid : Merchant Identification Number.
  • transactionid : The field transaction id contains the transaction’s identification in the payment gateway.
  • signature : The signature field contains a 40-figure hexadecimal value. This signature value is a checksum designed to protect the merchant account from unauthorized access.

Request example 

merchantid=api_test&signature=c4a68091fb40bd4e74556ff81d6deec3c9a7aa95&
transactionid=6905372

Step 2. Receive response notification

payabl. will send the outcome of the cancel request to you, in a notification that includes:

  • status : The status field contains the transaction’s status within the payment gateway.
  • errormessage : The error messages of the payment gateway. Empty or error message.
  • transactionid : The field transactionid contains the transaction’s identification in the payment gateway.
  • amount : The amount field contains the transaction’s total amount. This is the amount that will be transmitted to the autorizing system.
  • currency : The currency field contains the alphanumeric currency code for the transaction, according to ISO 4217, e.g. EUR, USD, AUD, CAD, NOK, SEK, CHF.
  • orderid : The field orderid is optional and exclusively for the merchants' convenience.

Response example 

transactionid=6905372&transid=6905372&status=0&errormessage=&errmsg=&amount=1.23&pric
e=1.23&currency=EUR&orderid=1234-123456789-4321

For more information about the included fields, see the Payment Reversal/Cancellation notification reference.

Our Technical Support team is there to help you:
Email: [email protected]
Available Monday – Friday between 09:00 and 17:00 CET/CEST

Updated 4 months ago