Integrate our products into your software. Let's make payment happen together!
Look at all the possibilitiesThe funds reserved with an authorisation can be released with a reversal. A transaction cannot be reversed a second time or when a previous reversal attempt is pending.
Notes:
authorise
can be reversed.card
, klarna
and terminal
can be reversed.Name | Description |
---|---|
type | Fixed value: reversal |
amount | Echo from the Payment |
currency | Echo from the Payment |
status | Possible values: Transaction Status |
merchantOrderReference | Echo from the Payment |
description | The description of the transaction |
language | Echo from the Payment |
method | Echo from the Payment |
brand | Echo from the Payment |
metadata | Echo from the Payment |
reference | A unique reference for the reversal transaction |
originalReference | The unique reference for the payment transaction this payment is attempting to reverse. |
methodTransactionId | A third party transaction ID which identifies the payment transaction in external systems. If empty no such id was available or no third party was employed |
created | The local server datetime the reversal was created, epoch timestamp |
lastUpdate | The local server datetime the reversal was updated, epoch timestamp |
statusFinalDate | The local server datetime the reversal reached a final status, epoch timestamp |
failureCode | An error code indication what caused the failure. Possible values: Failure Codes |
/api/v1/reversal
POST
application/json
Name | Required | Description | Max Length |
---|---|---|---|
reference | Yes | The unique reference of the payment to reverse | 255 |
description | No | The description of the reversal. If not provided we use the original payment description | 255 |
webhookUrl | No | The webhook URL invoked for transaction changes. This overrides the merchant webhook if one is present. We do not validate this url | 2000 |
Example
{
"reference": "C1505181754007360.1",
"description": "API Reversal Description"
}
These details are possible when reversing an authorisation which was made using the method terminal
.
Name | Required | Description |
---|---|---|
cardPresent | No | Specify whether the customer’s card has to be present to perform the reversal. Defaults to false . |
200
Example
{
"type" : "reversal",
"amount" : 316.35,
"currency" : "eur",
"status" : "PENDING",
"merchantOrderReference" : "8cdbb73f-6537-4b7f-a6de-6ddab6c283e1",
"description" : "API Reversal Description",
"language" : "eng",
"method" : "card",
"metadata" : "my custom metadata",
"reference" : "C1505181613078800.1",
"brand" : "visa",
"created" : 1431958387914,
"lastUpdate" : 1431958387914,
"statusFinalDate" : 1431958387914
}