Introduction

Payment Links allow you to collect payments from customers without a full website integration. You can generate a unique link, share it via email, SMS, or chat, and get paid instantly. This is ideal for:

Sending invoices to clients
Collecting payments for custom orders
Accepting payments without a website
Recovering abandoned carts

Easy Sharing

Share links via email or SMS

Customizable

Set custom expiry dates and pre-fill customer details

Secure

Secure hosted payment page handled entirely by EximPe

Prerequisites

Before you begin, ensure you have:

Merchant Account: An active EximPe merchant account
Credentials: Your Client ID and Client Secret
Domain Whitelist: Whitelisted your website domain for integration
Webhook URL: A secure endpoint to receive payment status updates

Integration Steps

Create Payment Link: Call the API to generate a link.
Share Link: Send the link to your customer.
Track Status: Monitor payment status via webhooks or API.

Step 1: Create Payment Link

To create a payment link, you need to provide the payment details such as amount, currency, and customer information.

cURL

curl -X POST https://api-pacb.eximpe.com/pg/payment-links/ \
  -H "Content-Type: application/json" \
  -H "X-Client-ID: YOUR_CLIENT_ID" \
  -H "X-Client-Secret: YOUR_CLIENT_SECRET" \
  -H "X-API-Version: 2.0.0" \
  -d '{
  "amount": "1500.00",
  "currency": "INR",
  "reference_id": "LINK_12345",
  "expiry_date": "2024-12-31T23:59:59Z",
  "buyer": {
    "name": "Alice Smith",
    "email": "[email protected]",
    "phone": "+919876543210",
    "address": {
      "line_1": "456 Park Avenue",
      "city": "New York",
      "state": "NY",
      "postal_code": "10022",
      "country_code": "US"
    }
  },
  "product": {
    "name": "Consulting Services",
    "description": "Professional consulting for Q4",
    "hs_code": "998311",
    "hs_code_description": "Management consulting services",
    "type_of_goods": "service"
  },
  "invoice": {
    "number": "INV-2024-001",
    "date": "2024-10-01"
  }
}'

Response

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

link_id is the payment link’s ID. It has the same value as payment_id, which is kept for compatibility.

Expiry Date: You can set an optional expiry_date for the link. If not provided, it defaults to 1 year.

📚 API Reference

Create Payment Link API - View complete documentation including all parameters.

Once you have the payment_link URL from the response, you can share it with your customer through any channel:

Email: Send it in an invoice email.
SMS / WhatsApp: Send it as a text message.
Social Media: Share it in DMs.
QR Code: Generate a QR code for the link.

When the customer clicks the link, they will be taken to a secure EximPe payment page where they can complete the payment using their preferred method (Card, UPI, Net Banking).

Step 3: Track Payment Status

Since the payment happens on a hosted page, you need to know when the payment is completed. You can do this via:

1. Webhooks (Recommended)

Listen for the PAYMENT_SUCCESSFUL webhook event to get real-time updates.

{
    "event_type": "PAYMENT_SUCCESSFUL",
    "event_time": "2024-02-15 16:53:15",
    "version": "1.0",
    "sequence_number": "e40552bf-ed12-4f35-9a97-162d97e6fa34",
    "data": {
        "utr": null,
        "amount": 1500,
        "status": "CAPTURED",
        "message": "Payment Captured",
        "mop_type": "UPI",
        "order_id": "OD3376378679",
        "link_id": "PR4829301756",
        "payment_id": "PR4829301756",
        "bank_ref_num": "OD3376378679-PR4829301756",
        "extended_status": "SUCCESS",
        "payment_message": null,
        "subscription_id": null,
        "virtual_account_id": null,
        "payment_completed_at": "2025-06-24T12:30:44.000000Z",
        "merchant_reference_id": "LINK_12345"
    }
}

2. Poll Status API

You can also periodically check the status of the payment link or the order associated with it.

📚 API Reference

Get Payment Link API - Check the current status of a payment link.

Tracking a payment link

A payment link and the payment made through it share one ID. Create Payment Link returns it as link_id, and as payment_id with the same value; the payment webhooks for the link’s payment carry it as both. Use it to manage the link (Retrieve Payment Link, Deactivate Link) and to refund and reconcile the payment (Create Refund).

Managing Payment Links

EximPe provides APIs to manage the lifecycle of your payment links:

List Links: View all your generated payment links.
Retrieve Link: Get details of a specific payment link.
Deactivate Link: Cancel a link before it expires.

Get Started

Payment Integration

Payment Links

Introduction

Easy Sharing

Customizable

Secure

Prerequisites

Integration Steps

Step 1: Create Payment Link

Response

📚 API Reference

Step 3: Track Payment Status

1. Webhooks (Recommended)

2. Poll Status API

📚 API Reference

Tracking a payment link

Managing Payment Links

​Introduction

Easy Sharing

Customizable

Secure

​Prerequisites

​Integration Steps

​Step 1: Create Payment Link

​Response

📚 API Reference

​Step 2: Share Payment Link

​Step 3: Track Payment Status

​1. Webhooks (Recommended)

​2. Poll Status API

📚 API Reference

​Tracking a payment link

​Managing Payment Links

Introduction

Prerequisites

Integration Steps

Step 1: Create Payment Link

Response

Step 2: Share Payment Link

Step 3: Track Payment Status

1. Webhooks (Recommended)

2. Poll Status API

Tracking a payment link

Managing Payment Links