CancelOrRefund

Last changes: 09-04-2023

The API method CancelOrRefund cancels or fully refunds a transaction depending on the transaction status. See the API method Refund to perform a partial refund.

API Parameters

Field	Description	Type	Length	Mandatory
transactionId	Unique transaction identifier.	String	36	Yes
modificationId	Your unique reference for the requested modification. Used to distinguish between retry and new modification.	String	64	Yes
description	Description of the i.e. the reason for the cancel/refund.	String	127	No
merchantKey	Merchnat identifier.	String	36	Yes
customReferences	For external party usage	customReferences	Object	No

The request must have the following headers:

Content-Type: application/json

Accept-Language: en-US

Origin: { Origin }

Example

Request

Path:: POST {Base URL}/payment/cancelOrRefund
Header:: Content-Type: application/json
Accept-Language: en-US

{
  "transactionId": "933a0fab-80a0-42c5-b010-c71174f4ab32",
  "modificationID": "f7c55bb3-0002-4363-9a33-56af8d5e691e",
  "description": "SMP-CancelOrRefund-01",
  "merchantKey": "31928de9-1344-469f-b0eb-8e5d0fef3d21"
}

Response

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
"reconciliationReferenceId": "FJ9wbkRjJZsRYCrjgaGGY",
"description": "SMP-Transaction-01",
"paymentStatus": "CANCELED",
"creationDate": "2020-12-15T14:35:44.532Z",
"lastStatusDate": "2020-12-15T14:36:45.031Z",
"transactionOverview": {
    "amount": 35.99,
    "currencyCode": "EUR",
    "transactionId": "933a0fab-80a0-42c5-b010-c71174f4ab32",
    "paymentMethod": "IDEAL",
},
"modification": {
    "modificationData": {
        "type": "CANCELATION",
        "modificationId": "cancel-1234",
        "reconciliationReferenceId": "FJ9wbkRjJZsRYCrjgaGGY"
    },
    "modificationAmount": {
        "description": "SMP-CancelOrRefund-01",        
        "amount": 35.99,
        "currencyCode": "EUR"
    },
    "status": "CANCELED",
    "creationDate": "2020-12-15T14:35:44.532Z",
    "statusHistory": [
    {
        "status": "CANCELATION_PENDING",
        "statusDate": "2020-12-15T14:36:44.328Z",
        "modificationAmount": {
            "amount": 35.99,
            "currencyCode": "EUR"
        }
    },
    {
        "status": "CANCELED",
        "statusDate": "2020-12-15T14:36:44.852Z",
        "modificationAmount": {
            "amount": 35.99,
            "currencyCode": "EUR"
        }
    }
    ]
}
}

We unified the modification API responses. Please refer to the modification API response model for further details on API responses and error handling.

Document version 1.2 - Updated description of modification reference

Document version 1.1 - 2020-03-17

Previous

Next