Revoke an existing payment link

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

id

string <uuid>

required

Payment link ID (UUID)

Header Params

x-merchant-id

string <uuid>

Merchant ID

required

If acting on behalf of a merchant, you will need to specify their merchant ID.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

OK response

Body

id

string <uuid>

required

merchantId

string <uuid>

required

status

enum<string>

required

Allowed values:

pendingcancelledcompleted

link

string <uri>

required

amount

object

required

units

integer

required

currencyCode

enum<string>

required

Allowed values:

GBPUSDEURDKK

description

string

required

reference

string | null

required

dataCollection

array[string]

required

Allowed values:

namebusinessNamephoneNumberemailaddress

taxes

array [object {3}]

required

name

string

required

inclusive

boolean

required

amount

object

required

payments

array [object {9}]

required

id

string <uuid>

required

type

enum<string>

required

Allowed values:

cardbankTransfer

cardDetails

object

optional

tip

object

required

taxes

array [object {4}]

required

subtotal

object

required

total

object

required

createdAt

string

required

updatedAt

string

required

returnUrl

string <uri> | null

required

createdAt

string

required

updatedAt

string

required

Example

{
  "id": "dd82c9e8-63a2-45a2-9e74-6d82c5b22c65",
  "amount": {
    "units": 15000,
    "currencyCode": "GBP"
  },
  "link": "https://lopay.app/08adf/b9f0bc31-4209-4bbb-bf1d-2ea124031056",
  "reference": null,
  "description": "Payment for INV#1000 (Gary Smith)",
  "status": "cancelled",
  "dataCollection": [
    "name"
  ],
  "taxes": [],
  "payments": [],
  "createdAt": "2025-03-03T16:26:28.173Z",
  "updatedAt": "2025-03-03T16:26:28.173Z"
}

🟠401Unauthorized

🟠404Record Not Found

🟠422Parameter Error