Cancel Payment Link

Merchants are allowed to cancel payment links at any time. This action can be simply performed by sending a POST request to PaymentLink endpoint /v3/paymentlinks/{linkId}/cancel. To read more information please check the /links/:id/cancel page.

The following code example shows the minimum data required to cancel a PaymentLink:

{
  "header": {
    "businessId": "{BusinessId}"
  }
}
{
    "result": 0,
    "description": "Ok",
    "header": {
        "requestTimestamp": "2019-01-01T12:00:00Z"
    },
    "body": {
        "link": {
            "linkId": "{linkId}",
            "status": "CANCELLED",
            "redirect": {
                "method": "GET",
                "url": "https://stagconnect.acehubpaymentservices.com/gateway/v3/web/paymentlinks/{linkId}"
            },
            "brandIds": [
                1010,
                1011,
                1013,
                1020,
                1023,
                1030,
                1040,
                1050,
                1060,
                1090,
                1210,
                3010,
                3020,
                3025,
                4010,
                6010,
                5020,
                8010
            ],
            "expirationTime": "2019-01-08T12:00:00Z",
            "tokenize": "FALSE",
            "threeDSecure": false
        },
        "transaction": {
            "amount": 10,
            "currencyCode": "EUR",
            "authorizationMode": "PAYMENT",
            "trackingCode": "{UniqueTrackingCode}"
        }
    }
}

As a response, you will receive a PaymentLink updated with status CANCELLED.

Once a PaymentLink is cancelled, it cannot be consumed anymore.


What's next