PaymentLink

object

idrequired: Id
Opaque record id.
deal_idrequired: Id
Opaque record id.
invoice_idrequired: Id or null
The brokerage invoice it collects (I-01).
providerrequired: "razorpay" | "cashfree"
purposerequired: "token" | "brokerage"
token: collected for the owner (not commission) · brokerage: commission.
amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
amount_paidrequired: Paise
Money in paise (₹1 = 100), an exact integer.
accept_partialrequired: boolean
min_partial_amountrequired: Paise or null
Money in paise (₹1 = 100), an exact integer.
descriptionrequired: string
contactrequired: object or null
The payer; the phone follows the caller’s field rules.
contact.idrequired: Id
Opaque record id.
contact.namerequired: string
contact.phonerequired: string or null
statusrequired: PaymentLinkStatus
short_urlrequired: string or null
expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
paid_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
cancelled_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
expired_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
errorrequired: string or null
Why the provider refused to create it (status failed).
paymentsrequired: array of object
payments[].idrequired: Id
Opaque record id.
payments[].amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
payments[].methodrequired: string or null
payments[].paid_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
payments[].receiptrequired: object or null
payments[].receipt.idrequired: Id
Opaque record id.
payments[].receipt.numberrequired: string
created_byrequired: MemberRef or null
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "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"
}

{ "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" }