Skip to main content
GET
/
pg
/
payment-links
/
{paymentLinkId}
Retrieve Payment Link
curl --request GET \
  --url https://api-pacb-uat.eximpe.com/pg/payment-links/{paymentLinkId}/ \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "payment_id": "<string>",
    "reference_id": "<string>",
    "amount": "<string>",
    "currency": "<string>",
    "payment_link": "<string>",
    "status": "<string>",
    "status_message": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "buyer": {
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "address": {
        "line_1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "line_2": "<string>"
      },
      "pan_number": "<string>",
      "dob": "<string>"
    },
    "product": {
      "name": "<string>",
      "description": "<string>",
      "hs_code": "<string>",
      "hs_code_description": "<string>",
      "type_of_goods": "<string>"
    },
    "invoice": {
      "number": "<string>",
      "date": "<string>",
      "file": "<string>"
    },
    "settlement": {
      "status": "<string>",
      "message": "<string>",
      "settlement_details": {
        "settlement_id": "<string>",
        "settlement_completed_at": "2023-11-07T05:31:56Z",
        "utr_number": "<string>",
        "merchant_net_amount": "<string>",
        "settlement_currency": "<string>"
      }
    }
  }
}

​
Overview

Fetch detailed information about a specific payment link using its unique ID. This includes the current status, buyer details, and associated order information.

​
Path Parameters

  • paymentLinkId: The unique identifier of the payment link (e.g., PR5106085554).

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

Payment link details retrieved successfully

​
success
boolean
​
message
string
​
data
object