Skip to main content
← All schemas

UpdateCommissionPayoutInput

object

status
PayoutStatus

pending, approved (runs the payout approval policy), on_hold or cancelled — paid goes through /pay.

gross
PaiseInput

Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.

release_rule
PayoutReleaseRule

manual: payable at once · on_receipt: as the brokerage comes in · on_closure: once the deal is won.

invoice_ref
string or null
notes
string or null
reason
string or null

Why it is held or cancelled.

paid_on
LocalDate or null

Refused: record payments with /pay.

Example
{
  "status": "pending",
  "gross": 0,
  "release_rule": "manual",
  "invoice_ref": "string",
  "notes": "string",
  "reason": "string",
  "paid_on": "2026-10-06"
}