List settlements (payouts of your available balance to your bank account)
list_settlementsFetch settlements to review payouts of available or subaccount balances to your settlement bank account, filtered by status, subaccount, or creation date.
Instructions
List settlements (payouts of your available balance to your bank account).
List settlements: payouts of your available balance (or a subaccount’s) to the settlement account you set in the dashboard, on your schedule or on demand. Filter by status or subaccount.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Number of objects to return | |
| status | No | Only objects with this status. | |
| created | No | Filter on creation time, e.g. created[gte]=2026-01-01T00:00:00Z | |
| subaccount | No | Only settlements of this subaccount (sub_…) | |
| ending_before | No | Cursor: return objects created after this object id (newer) | |
| starting_after | No | Cursor: return objects created before this object id (older) |