Skip to main content
POST
/
pg
/
payment-links
/
{paymentLinkId}
/
share
/
Share Payment Link
curl --request POST \
  --url https://api-pacb-uat.eximpe.com/pg/payment-links/{paymentLinkId}/share/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "email": [
    "[email protected]"
  ],
  "phone": [
    "<string>"
  ]
}
'
{
  "success": true,
  "message": "<string>"
}

​
Overview

Trigger automated notifications to share the payment link with your customers via Email or SMS.

​
Path Parameters

  • paymentLinkId: The unique identifier of the payment link.

​
Request Body

  • email: A list of email addresses to send the link to.
  • phone: A list of phone numbers (with country code) to send the link to.

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', '2.X.X', or '3.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

Body

application/json
​
email
string<email>[]
​
phone
string[]

Response

200 - application/json

Payment link shared successfully

​
success
boolean
​
message
string