RArazorpay
Instant Settlements

Create an instant settlement

Request an on-demand (instant) settlement of your available Razorpay balance to your bank account. Fees apply. Use settle_full_balance=true to settle everything available, or specify an amount.

post/settlements/ondemand

Request

Request body

amountinteger required

Settlement amount in paise.

settle_full_balanceboolean

Set true to settle the full available balance. Overrides amount.

descriptionstring

Custom reference note. Max 30 alphanumeric characters.

notesNotes

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

Response

Instant settlement initiated.

idstring

Unique instant settlement identifier. Prefix: setlod_

entity'settlement.ondemand'
amount_requestedinteger

Settlement amount requested (paise).

amount_settledinteger

Total amount transferred minus fees and tax (paise).

amount_pendinginteger

Portion of requested amount yet to be settled (paise).

amount_reversedinteger

Amount returned to PG balance (paise).

feesinteger

Combined fees and tax deducted (paise).

taxinteger

Tax on fee component (paise).

currencystring
settle_full_balanceboolean

If true, settles maximum available balance.

status'created' | 'initiated' | 'partially_processed' | 'processed' | 'reversed'
descriptionstring

Custom reference note. Max 30 alphanumeric characters.

notesNotes

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

created_atinteger

Changes

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