Developer docs
API reference
Create a payment link and fetch it by ID. Requests and responses are JSON, and every request is authorised with an API key.
Base URL
https://api.zozopay.in/api/v1
Send Content-Type: application/json on requests with a body, and authorise every request as described in Authentication.
Create a payment link
POST/developer/payment-links
Creates a payment link for a single payment and returns it with a checkoutUrl. Your merchant account must be active.
Request body
| Field | Type | Description |
|---|---|---|
| amountrequired | number | Amount in rupees, greater than 0 and at most 1,000,000. Decimals are allowed (499.00). |
| description | string | What the payment is for. Up to 300 characters. Shown on the checkout. |
| receiptId | string | Your own reference, such as an order number. Up to 100 characters. |
| customerName | string | Up to 150 characters. |
| customerEmail | string | A valid email address, or an empty string. |
| customerPhone | string | Up to 20 characters. |
Units differ between request and response. You send amount in rupees, and the response returns amount in paise.
Example request
curl -X POST "https://api.zozopay.in/api/v1/developer/payment-links" \
-H "Authorization: Bearer <KEY_ID>:<KEY_SECRET>" \
-H "Content-Type: application/json" \
-d '{
"amount": 499.00,
"description": "Order #1001",
"receiptId": "rcpt_1001",
"customerName": "Jane Doe",
"customerEmail": "jane@example.com"
}'Response · 201 Created
{
"id": "cmtl4x82ws0001abc",
"merchantId": "cmt...",
"amount": 49900,
"currency": "INR",
"status": "CREATED",
"paymentMethod": null,
"description": "Order #1001",
"receiptId": "rcpt_1001",
"customerName": "Jane Doe",
"customerEmail": "jane@example.com",
"customerPhone": null,
"gatewayReference": null,
"paidAt": null,
"refundedAt": null,
"settlementId": null,
"createdAt": "2026-09-19T08:30:00.000Z",
"updatedAt": "2026-09-19T08:30:00.000Z",
"checkoutUrl": "https://zozopay.in/pay/cmtl4x82ws0001abc"
}Errors
| Status | When |
|---|---|
| 400 | A field is missing or invalid, for example an amount above 1,000,000 or an invalid email. |
| 401 | The API key is missing, malformed, wrong or revoked. |
| 403 | Your merchant account is not active. |
Fetch a payment link
GET/developer/payment-links/:id
Returns a payment link you created, including its current status.
Path parameters
| Parameter | Description |
|---|---|
| id | The id returned when the link was created. |
Example request
curl "https://api.zozopay.in/api/v1/developer/payment-links/<PAYMENT_LINK_ID>" \
-H "Authorization: Bearer <KEY_ID>:<KEY_SECRET>"Response · 200 OK
The same object as above, without checkoutUrl. A link that belongs to another merchant, or does not exist, returns 404.
The payment link object
| Field | Type | Description |
|---|---|---|
| id | string | Unique ID of the payment link. Use it to fetch the link and in the checkout URL. |
| merchantId | string | The merchant account that owns the link. |
| amount | integer | Amount in paise (₹499.00 is 49900). |
| currency | string | Always INR. |
| status | string | Current status. See Payment statuses. |
| paymentMethod | string | null | UPI, CARD, NETBANKING or WALLET once the customer has attempted payment; otherwise null. |
| gatewayReference | string | null | Reference recorded when a payment attempt is made. |
| description | string | null | The description you supplied. |
| receiptId | string | null | Your own reference, as supplied. |
| customerName | string | null | Customer name, as supplied. |
| customerEmail | string | null | Customer email, as supplied. |
| customerPhone | string | null | Customer phone, as supplied. |
| paidAt | ISO 8601 | null | When the payment succeeded. |
| refundedAt | ISO 8601 | null | When the payment was refunded. |
| settlementId | string | null | The settlement batch this payment was included in, once settled. |
| createdAt / updatedAt | ISO 8601 | Timestamps. |
| checkoutUrl | string | Returned when you create a link. The hosted checkout URL to share with the customer. |
Next: Hosted checkout and Payment statuses.