Payment links

Razorpay / Cashfree payment links for a deal’s token or brokerage, sent or copied, with automatic receipts.

GET/v1/deals/{id}/payment-links

A deal’s payment links

Newest first, with payments and their receipts. Brokerage links only for roles that see commission.

Access: API key with deals:read, or a member session. Permission deals.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of PaymentLink
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/deals/{id}/payment-links' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "deal_id": "cmusrceel0000q7kaafxqi1om",
      "invoice_id": "cmusrceel0000q7kaafxqi1om",
      "provider": "razorpay",
      "purpose": "token",
      "amount": 850000000,
      "amount_paid": 850000000,
      "accept_partial": true,
      "min_partial_amount": 850000000,
      "description": "string",
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "phone": "string"
      },
      "status": "creating",
      "short_url": "string",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "paid_at": "2026-10-06T05:30:00.000Z",
      "cancelled_at": "2026-10-06T05:30:00.000Z",
      "expired_at": "2026-10-06T05:30:00.000Z",
      "error": "string",
      "payments": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "amount": 850000000,
          "method": "string",
          "paid_at": "2026-10-06T05:30:00.000Z",
          "receipt": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "number": "string"
          }
        }
      ],
      "created_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/deals/{id}/payment-links

For the deal’s token (at most the agreed token) or brokerage (at most the commission still due, minus open links). Expires in 7 days by default (15 minutes to 180 days). `send` also sends it to the payer through the messaging pipeline (`payment_link` template).

Access: API key with deals:write, or a member session. Permission deals.edit.

Parameters

idpathrequired: Id
Opaque record id.
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

purposerequired: "token" | "brokerage"
invoice_id: Id or null
Brokerage only: the invoice it collects — at most its balance; payments settle it (I-01).
amountrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
description: string or null
expires_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
accept_partial: boolean
min_partial_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
payer_contact_id: Id or null
Default: the deal’s client.
connection_id: Id or null
Default: the most recently connected gateway.
send: object or null
send.channel: "auto" | "whatsapp_cloud" | "sms" | "email"

Response · 201

datarequired: object
data.linkrequired: PaymentLink
data.sentrequired: PaymentLinkSendResult or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/deals/{id}/payment-links' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"purpose":"token","invoice_id":"cmusrceel0000q7kaafxqi1om","amount":0,"description":"string","expires_at":"2026-10-06T05:30:00.000Z","accept_partial":false,"min_partial_amount":0,"payer_contact_id":"cmusrceel0000q7kaafxqi1om","connection_id":"cmusrceel0000q7kaafxqi1om","send":{"channel":"auto"}}'

Response example

{
  "data": {
    "link": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "deal_id": "cmusrceel0000q7kaafxqi1om",
      "invoice_id": "cmusrceel0000q7kaafxqi1om",
      "provider": "razorpay",
      "purpose": "token",
      "amount": 850000000,
      "amount_paid": 850000000,
      "accept_partial": true,
      "min_partial_amount": 850000000,
      "description": "string",
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "phone": "string"
      },
      "status": "creating",
      "short_url": "string",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "paid_at": "2026-10-06T05:30:00.000Z",
      "cancelled_at": "2026-10-06T05:30:00.000Z",
      "expired_at": "2026-10-06T05:30:00.000Z",
      "error": "string",
      "payments": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "amount": 850000000,
          "method": "string",
          "paid_at": "2026-10-06T05:30:00.000Z",
          "receipt": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "number": "string"
          }
        }
      ],
      "created_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "sent": {
      "status": "queued",
      "channel": "string",
      "message_id": "cmusrceel0000q7kaafxqi1om",
      "reasons": [
        "string"
      ]
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/payment-links/{id}/cancel

Cancel a payment link

Cancelled at the provider too; payments already received keep their receipts.

Access: API key with deals:write, or a member session. Permission deals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: PaymentLink
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/payment-links/{id}/cancel' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deal_id": "cmusrceel0000q7kaafxqi1om",
    "invoice_id": "cmusrceel0000q7kaafxqi1om",
    "provider": "razorpay",
    "purpose": "token",
    "amount": 850000000,
    "amount_paid": 850000000,
    "accept_partial": true,
    "min_partial_amount": 850000000,
    "description": "string",
    "contact": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "phone": "string"
    },
    "status": "creating",
    "short_url": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "paid_at": "2026-10-06T05:30:00.000Z",
    "cancelled_at": "2026-10-06T05:30:00.000Z",
    "expired_at": "2026-10-06T05:30:00.000Z",
    "error": "string",
    "payments": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "method": "string",
        "paid_at": "2026-10-06T05:30:00.000Z",
        "receipt": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "number": "string"
        }
      }
    ],
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/payment-links/{id}/send

Send a payment link to the payer

Through the compliance-gated pipeline (consent, quiet hours, DLT); answers why when it is blocked.

Access: API key with deals:write, or a member session. Permission deals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

channel: "auto" | "whatsapp_cloud" | "sms" | "email"

Response · 200

datarequired: PaymentLinkSendResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/payment-links/{id}/send' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"channel":"auto"}'

Response example

{
  "data": {
    "status": "queued",
    "channel": "string",
    "message_id": "cmusrceel0000q7kaafxqi1om",
    "reasons": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "deal_id": "cmusrceel0000q7kaafxqi1om", "invoice_id": "cmusrceel0000q7kaafxqi1om", "provider": "razorpay", "purpose": "token", "amount": 850000000, "amount_paid": 850000000, "accept_partial": true, "min_partial_amount": 850000000, "description": "string", "contact": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "phone": "string" }, "status": "creating", "short_url": "string", "expires_at": "2026-10-06T05:30:00.000Z", "sent_at": "2026-10-06T05:30:00.000Z", "paid_at": "2026-10-06T05:30:00.000Z", "cancelled_at": "2026-10-06T05:30:00.000Z", "expired_at": "2026-10-06T05:30:00.000Z", "error": "string", "payments": [ { "id": "cmusrceel0000q7kaafxqi1om", "amount": 850000000, "method": "string", "paid_at": "2026-10-06T05:30:00.000Z", "receipt": { "id": "cmusrceel0000q7kaafxqi1om", "number": "string" } } ], "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/deals/{id}/payment-links' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"purpose":"token","invoice_id":"cmusrceel0000q7kaafxqi1om","amount":0,"description":"string","expires_at":"2026-10-06T05:30:00.000Z","accept_partial":false,"min_partial_amount":0,"payer_contact_id":"cmusrceel0000q7kaafxqi1om","connection_id":"cmusrceel0000q7kaafxqi1om","send":{"channel":"auto"}}'

{ "data": { "link": { "id": "cmusrceel0000q7kaafxqi1om", "deal_id": "cmusrceel0000q7kaafxqi1om", "invoice_id": "cmusrceel0000q7kaafxqi1om", "provider": "razorpay", "purpose": "token", "amount": 850000000, "amount_paid": 850000000, "accept_partial": true, "min_partial_amount": 850000000, "description": "string", "contact": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "phone": "string" }, "status": "creating", "short_url": "string", "expires_at": "2026-10-06T05:30:00.000Z", "sent_at": "2026-10-06T05:30:00.000Z", "paid_at": "2026-10-06T05:30:00.000Z", "cancelled_at": "2026-10-06T05:30:00.000Z", "expired_at": "2026-10-06T05:30:00.000Z", "error": "string", "payments": [ { "id": "cmusrceel0000q7kaafxqi1om", "amount": 850000000, "method": "string", "paid_at": "2026-10-06T05:30:00.000Z", "receipt": { "id": "cmusrceel0000q7kaafxqi1om", "number": "string" } } ], "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z" }, "sent": { "status": "queued", "channel": "string", "message_id": "cmusrceel0000q7kaafxqi1om", "reasons": [ "string" ] } }, "meta": {} }

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "deal_id": "cmusrceel0000q7kaafxqi1om", "invoice_id": "cmusrceel0000q7kaafxqi1om", "provider": "razorpay", "purpose": "token", "amount": 850000000, "amount_paid": 850000000, "accept_partial": true, "min_partial_amount": 850000000, "description": "string", "contact": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "phone": "string" }, "status": "creating", "short_url": "string", "expires_at": "2026-10-06T05:30:00.000Z", "sent_at": "2026-10-06T05:30:00.000Z", "paid_at": "2026-10-06T05:30:00.000Z", "cancelled_at": "2026-10-06T05:30:00.000Z", "expired_at": "2026-10-06T05:30:00.000Z", "error": "string", "payments": [ { "id": "cmusrceel0000q7kaafxqi1om", "amount": 850000000, "method": "string", "paid_at": "2026-10-06T05:30:00.000Z", "receipt": { "id": "cmusrceel0000q7kaafxqi1om", "number": "string" } } ], "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

Payment links

A deal’s payment links

Parameters

Response · 200

Errors

Create a payment link

Parameters

Request body

Response · 201

Errors

Cancel a payment link

Parameters

Response · 200

Errors

Send a payment link to the payer

Parameters

Request body

Response · 200

Errors

Payment links

A deal’s payment links

Parameters

Response · 200

Errors

Create a payment link

Parameters

Request body

Response · 201

Errors

Cancel a payment link

Parameters

Response · 200

Errors

Send a payment link to the payer

Parameters

Request body

Response · 200

Errors