v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB

Instant Settlements

Fetch instant settlement by ID

Retrieve details of a specific on-demand instant settlement. Use expand[]=ondemand_payouts to include payout records.

get/settlements/ondemand/{id}

idstring required

Instant settlement ID (setlod_*).

expand[]'ondemand_payouts'

Set to ondemand_payouts to include payout details.

Instant settlement details.

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