Cancel Payment Link

Update restrictions
  • Only a payment link with the Status active, viewed or attempted can be cancelled.

POST Cancel Payment Link

Creation of a payment link is achieved by sending a HTTP POST request to these URLs. The access_token will be the one received in the Authentication Response.

HTTP Headers

HTTP Header
Field NameStateData TypeDescription
Content-TypeMandatoryStringapplication/json
Content-TypeMandatoryStringBearer access_token

URL Parameters

HTTP Header
Field NameStateData TypeDescription
idMandatoryStringThe Payment Link ID from a previous response.

Cancel Payment Link Response

If the request is successful, you will receive a 200 OK response code, and the following response fields.

Field nameTypeDescription
idStringPayment link ID, the unique reference for this payment link assigned by the DNA Platform.
amountFloatThe amount of the payment, as a decmal.
currencyStringCurrency e.g. GBP.
invoiceIdStringThe InvoiceId supplied in the Request, if applicable.
terminalIdStringThe terminal ID supplied in the request.
customerNameStringThe Customer name.
descriptionStringThe description as supplied in the request.
createdDateStringThe date that the Payment Link was created.
expirationDateStringThe date that the Payment Link will expire.
viewedDateStringThe date that the Payment Link was viewed. Null if not applicable.
attemptedDateStringThe date that the Payment Link was attempted. Null if not applicable.
paidDateStringThe date that the Payment Link was viewed. Null if not applicable.
cancelledDateStringThe date that the Payment Link was viewed. Null if not applicable.
statusStringPayment link status. See Statuses for more details.
urlStringFull payment link URL

Example Request and Response

POST https://api.dnapayments.com/v1/payment-links/69lXLdv9w/cancellation
HTTP/1.1
Content-Type: application/json
Authorization: Bearer 6945595921271780
User-Agent: PostmanRuntime/7.26.8
Accept: */*
Host: 192.168.0.75:8080
Accept-Encoding: gzip, deflate, br
Connection: keep-alive