v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB

Orders

Update an order

Update the notes field of an existing order. Only notes can be modified after creation.

patch/orders/{id}

idstring required

Order ID (order_*).

notesNotes required

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

Updated order.

idstring

Unique order identifier. Prefix: order_

entity'order'

amountinteger

Order amount in paise. Example: 50000 = ₹500.

amount_paidinteger

Total amount paid against this order (paise).

amount_dueinteger

Remaining unpaid amount (paise).

currencystring

ISO 4217 currency code. Example: INR.

receiptstring

Your internal receipt or order reference number.

status'created' | 'attempted' | 'paid'

created: awaiting payment. attempted: payment attempted but not captured. paid: fully paid.

attemptsinteger

Number of payment attempts made.

notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

created_atinteger

Unix timestamp of order creation.

offer_idstring

offersstring[]