Sign in
X Payouts

Cancel a queued payout

Only payouts in 'queued' status can be cancelled.

post/payouts/{payout_id}/cancel

Response

Payout cancelled

idstring

Payout ID (pout_*)

entity'payout'
fund_account_idstring
amountinteger

Amount in paise (min 100)

currency'INR'
feesinteger
taxinteger
mode'NEFT' | 'RTGS' | 'IMPS' | 'UPI' | 'card' | 'amazonpay'

Transfer mode — case-sensitive. amazonpay limited to ₹10,000 per transaction; no custom narration allowed.

utrstring

Unique Transaction Reference from bank

reference_idstring
debit_account_numberstring
narrationstring
purpose'refund' | 'cashback' | 'payout' | 'salary' | 'utility bill' | 'vendor bill'
fee_typestring
status'queued' | 'pending' | 'rejected' | 'processing' | 'processed' | 'cancelled' | 'reversed' | 'failed'
batch_idstring
notesobject
created_atinteger
queue_if_low_balanceboolean

true: queue payout when account balance is insufficient. false (default): fail immediately.

Changes

No recorded changes to this endpoint across all 1 revision of this API.