Skip to main content
POST
/
pg
/
payment-links
/
{paymentLinkId}
/
deactivate
Deactivate Payment Link
curl --request POST \
  --url https://api-pacb-uat.eximpe.com/pg/payment-links/{paymentLinkId}/deactivate/ \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'
{
  "success": true,
  "message": "<string>"
}

​
Overview

Deactivate an active payment link to prevent any further payments from being made through it. Once deactivated, the link will show an “Expired” or “Inactive” message to the customer.

​
Path Parameters

  • paymentLinkId: The unique identifier of the payment link.

Authorizations

​
X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

​
X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

​
X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X' or '2.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Path Parameters

​
paymentLinkId
string
required

Response

200 - application/json

Payment link deactivated successfully

​
success
boolean
​
message
string