Endpoints
Payment Link Status
Poll the status of a previously created payment link.
GET
/api/v1/staging/payment-links/:idPoll the latest state of a payment link using the payment link ID returned at creation time. This endpoint is useful for back-office confirmation and reconciliation flows.
Base URL
https://cms-staging.challanwala.com
Authentication
Bearer YOUR_API_SECRET
Access gate
Requires the Payment Link Generation service to be enabled for your organization.
Request path parameter
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | uuid | Required | Payment link identifier returned by the create-payment-link endpoint. |
cURL request
curl --request GET 'https://cms-staging.challanwala.com/api/v1/staging/payment-links/17de2557-58d6-4f8d-aa2b-fb60074c6a6d' \ --header 'Authorization: Bearer YOUR_API_SECRET'JavaScript request
const response = await fetch('https://cms-staging.challanwala.com/api/v1/staging/payment-links/17de2557-58d6-4f8d-aa2b-fb60074c6a6d', { method: 'GET', headers: { Authorization: 'Bearer YOUR_API_SECRET', },});const data = await response.json();console.log(data);Example response
{"success": true,"data": { "id": "17de2557-58d6-4f8d-aa2b-fb60074c6a6d", "status": "PAID", "organization": { "id": "bf4cc07b-d395-456a-8aac-e419d9ef10ff", "name": "North Fleet Operations" }, "paymentUrl": "https://cms.challanwala.com/prepaid-payment/ppl_6e1f65f4f7a04ebd9d8cbff62853d4f3", "expiresAt": "2026-05-15T14:20:00.000Z", "paidAt": "2026-05-13T11:42:08.000Z", "amount": { "baseAmount": 1500, "legalFee": 100, "gst": 18, "convenienceFee": 0, "totalAmount": 1618 }, "paymentModeOptions": [ { "baseAmount": 1500, "legalFee": 100, "gst": 18, "convenienceFee": 0, "totalAmount": 1618, "paymentMode": "UPI" } ], "challans": [ { "id": "8cb4fb9a-88eb-4d5c-b484-e857a90a8b71", "challanNo": "DL-TRF-101299", "rcNumber": "DL01AB1234", "status": "PENDING", "challanType": "ONLINE", "state": "Delhi", "challanAmount": 500, "legalFee": 50, "totalAmount": 550 } ]}}Status values you should handle
| Status | Meaning | Notes |
|---|---|---|
| ACTIVE | The payment link can still be used. | Share the paymentUrl with the payer or keep polling for updates. |
| PAID | Payment has completed successfully. | The response includes paidAt once available. |
| EXPIRED | The payment link is no longer usable. | Create a new payment link if payment still needs to be collected. |
| FAILED | A payment attempt failed. | You may choose to create a fresh payment link based on your business flow. |
| CANCELLED | The payment link is no longer valid. | Treat this as closed and create a new link if you still need payment. |
404
Payment link not found
The supplied payment link ID does not belong to the authenticated organization or does not exist.
403
Service disabled
The authenticated secret is valid, but payment-link generation access is not enabled for the organization.