v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB
Instant Settlements

Fetch all instant settlements

Retrieve a list of all on-demand instant settlements. Use expand[]=ondemand_payouts to include individual payout records inline.

get/settlements/ondemand

Query parameters

frominteger

Unix timestamp (seconds). Fetch records created on or after this time.

tointeger

Unix timestamp (seconds). Fetch records created on or before this time.

countinteger

Number of records to return per call. Maximum 100. Default 10.

skipinteger

Number of records to skip. Use with count for pagination. Default 0.

expand[]'ondemand_payouts'

Set to ondemand_payouts to include payout details.

Response

Collection of instant settlements.

entity'collection'
countinteger

Number of items in the current page.