Retrieve Settlements

Retrieves a list of Settlements.

Query Params
string
required

The date to start from.

string
required

The date to end at.

string

Filters, the settlements by the status.

string

Filters, the settlements by the settlement profile.

integer
≤ 200
Defaults to 50

The number of items to return.

string
Defaults to null

Used for pagination. Set this to the first/last id value of your payload to get the prev/next page of results respectively.

string

The direction of the pagination.

Response

Language
Credentials
URL