Create Payment Link

​

Overview

​

Request Parameters

​

Required Parameters

• amount: The amount to collect, in rupees
• reference_id: Your unique reference for this payment
• buyer: Buyer details — name, email, phone and address
• product: What the payment is for
• invoice: The invoice number

​

Optional Parameters

• expiry_date: When the link stops accepting payment. Defaults to one year from today
• preferred_payment_method: The payment method the buyer should pay with
• buyer.send_sms / buyer.send_email: Send the link to the buyer as soon as it is created
• business_model: Whether the buyer is a business (B2B) or a consumer (B2C)
• purpose_code: The FEMA/FETERS purpose code the payment settles under (e.g. S0802)

​

Parameter Definitions

​

Top-level

​

Buyer

​

Address (Buyer.address)

​

Product

​

Invoice

​

Expiry

• Send expiry_date in ISO 8601. An offset is honoured — 2026-12-31T23:59:59+05:30 reads back as 2026-12-31T18:29:59.000000Z — and a value without one is read as UTC.
• It must be in the future and no more than 365 days away. Otherwise the create is refused with Expiry date cannot be older than the current UTC time. or Expiry date cannot be beyond 1 year from now.
• Omit it, or send null, and the link expires 365 days from today.
• The create response does not echo the expiry. Read it back with Retrieve Payment Link.

​

Preferred payment method

{
  "success": false,
  "error": {
    "code": "ERR_ORDER_002",
    "message": "Validation error",
    "details": {
      "preferred_payment_method": "Credit card is not supported for payment links on this account"
    }
  }
}

​

Response

• link_id: The link’s ID — PR followed by 10 digits. Retrieve and Deactivate take it, and every payment made through the link carries it. See Tracking a payment link
• payment_id: The same value as link_id, kept for compatibility. Read link_id
• payment_link: The URL to send to the buyer. Treat it as opaque
• amount: The amount as a decimal string. A whole amount comes back without decimals ("1500"), any other with two ("1500.50")
• currency: Always INR

​

Tracking a payment link

• Manage the link by link_id. Retrieve Payment Link and Deactivate Payment Link take it.
• Match payments to the link on link_id. A buyer may try more than once before a payment goes through. The payment webhooks — PAYMENT_SUCCESSFUL when a payment goes through — carry that payment’s own payment_id and the link’s link_id.
• Refund and reconcile by that payment’s payment_id, not by link_id. Create Refund takes it, and Retrieve Payment Link names the payment that paid the link in paid_payment_id.

​

Errors

​

Examples

{
  "amount": "1500.00",
  "reference_id": "ORD-2026-000123",
  "expiry_date": "2026-12-31T18:29:59Z",
  "preferred_payment_method": "UPI",
  "buyer": {
    "name": "Rahul Sharma",
    "email": "[email protected]",
    "phone": "+919876543210",
    "send_sms": true,
    "send_email": true,
    "address": {
      "line_1": "221B MG Road",
      "line_2": "Indiranagar",
      "city": "Bengaluru",
      "state": "Karnataka",
      "postal_code": "560038"
    }
  },
  "product": {
    "name": "Annual subscription",
    "description": "12-month premium plan",
    "type_of_goods": "service"
  },
  "invoice": {
    "number": "INV2026000123"
  }
}

{
  "amount": "2499.50",
  "reference_id": "ORD-2026-000124",
  "buyer": {
    "name": "Priya Nair",
    "email": "[email protected]",
    "phone": "+919812345678",
    "address": {
      "line_1": "14 Marine Drive",
      "city": "Mumbai",
      "state": "Maharashtra",
      "postal_code": "400001"
    }
  },
  "product": {
    "name": "Wireless Headphones",
    "description": "Noise-cancelling wireless headphones",
    "type_of_goods": "physical_goods",
    "hs_code": "85183000"
  },
  "invoice": {
    "number": "INV2026000124"
  }
}

​

Response Examples

{
  "success": true,
  "message": "Payment Link created successfully",
  "data": {
    "payment_id": "PR4829301756",
    "link_id": "PR4829301756",
    "payment_link": "https://api-pacb-uat.eximpe.com/p/Xk3nQ7bT2mWp9vLc4R/",
    "amount": "1500",
    "currency": "INR"
  }
}

{
  "success": false,
  "error": {
    "code": "ERR_ORDER_002",
    "message": "Validation error",
    "details": {
      "invoice": {
        "number": "Invoice number must contain only alphanumeric characters."
      },
      "buyer": {
        "phone": "Enter a valid phone number."
      }
    }
  }
}

​

Implementation Notes

• Create links from your backend. The call carries your client secret, so never make it from a browser or a mobile app.
• A reference_id is spent once the request passes validation. It must be unique across all your orders, not only payment links. A create refused after validation — over the payment method, say, or by the payment network — still records a failed order that holds the reference_id, and the link may appear in List Payment Links as failed. Retry with a fresh reference_id; the invoice number is free to reuse.
• PSPs send X-Merchant-ID naming the sub-merchant the link is for. Without it the call is refused with a 401.
• Keep link_id and amount. link_id is what Retrieve and Deactivate take, and Retrieve does not return the link’s amount.