Allowed Scopes: settlement:read

Returns settlements. For more information about settlements, see this guide. Settlements data are cached for 86400 seconds.

This endpoint uses page-based pagination. Use page and pageSize to retrieve additional results. The maximum pageSize is 30. Continue fetching while page * pageSize < meta.pagination.total.

To filter by settlement status, use state (for example, /v1/settlements?page=1&pageSize=30&state=created).

Settlements expose allocation links through allocations[].payableId. For accounting export use cases that require payable line amounts, retrieve the related payable and read lineItems[].financial.netAmount. Amounts are expressed in the smallest unit of the currency.