Skip to main content
DELETE
/
payment-links
/
{link_id}
Revoke payment link(s)
curl --request DELETE \
  --url https://prod-api.pcxpay.com/v1/payment-links/{link_id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "email": "customer@example.com",
  "link_id": "lnk_a1b2c3d4"
}
'
{
  "message": "Payment link revoked successfully"
}

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Path Parameters

​
link_id
string
required

The unique ID of the payment link to revoke.

Example:

"lnk_a1b2c3d4"

Body

application/json
​
email
string<email>

If provided, revokes all active links associated with this email address (in addition to the path link_id).

Example:

"customer@example.com"

​
link_id
string

Explicit link ID override in body (at least one of body link_id or email must be provided, or rely on path param).

Example:

"lnk_a1b2c3d4"

Response

Link(s) revoked successfully.

​
message
string
Example:

"Payment link revoked successfully"