Deactivate Payment Link

Version: 3.0.0

Generate an API Key for the Payment Link channel before making requests.

Deactivate an active payment link to stop accepting payments. Once deactivated, the link can no longer be used for transactions. You can reactivate it later using the activate endpoint if needed.

Deactivating a payment link does not affect any payments already in progress. Only the ability to start new payments from the link is removed.

Endpoint

Method	URL
POST	`https://api.payorc.com/payment-links/v1/deactivate`

Please use the test credentials for sandbox testing.

Authentication

Header	Type	Description
`merchant-key`	String	Your merchant key
`merchant-secret`	String	Your merchant secret

Request Body

Field	Type	Required	Description
`data_id`	String	Yes	Data ID of the payment link to deactivate

Response (200 OK)

Field	Type	Description
`status`	String	Response status
`message`	String	Response message
`code`	String	Response code

Code Examples

curl -X POST https://api.payorc.com/payment-links/v1/deactivate \
  -H "Content-Type: application/json" \
  -H "merchant-key: YOUR_MERCHANT_KEY" \
  -H "merchant-secret: YOUR_MERCHANT_SECRET" \
  -d '{
    "data_id": "lnk_8x7kP2mN4qR"
  }'

Example Response

{
  "message": "Payment link deactivated successfully",
  "status": "success",
  "code": "00"
}

Error Response

{
  "message": "Record not found or already deactivated.",
  "status": "fail",
  "code": "E0021"
}

Deactivated links can be reactivated using the activate endpoint. Expired links cannot be reactivated — create a new one instead.

Deactivate Payment Link

On this page