List settlements

Returns settlements for the organisation. (Requires READ permission)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer

Zero-based page number for pagination.

integer

Number of settlements returned per page.

string

Inclusive lower bound of the settlement createdAt, ISO 8601 (YYYY-MM-DD).

string

Inclusive upper bound of the settlement createdAt, ISO 8601 (YYYY-MM-DD).

string

Sort expression in the form "field:ORDER" (ORDER is ASC or DESC).

string

Filter by settlement type. RECEIVABLE means owed to your organization; PAYABLE means owed by your organization.

Headers
string
required
number
required
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json