Skip to main content
DELETE
/
payment-links
/
{link_id}
Revoke a payment link
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": "jsmith@example.com"
}
'
{
  "status": "success",
  "message": "<string>"
}

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

Body

application/json
​
email
string<email>

Revoke all active links for this email address.

Response

Payment link revoked

​
status
enum<string>
Available options:
success,
error
Example:

"success"

​
message
string