List settlements

Retrieve a list of all your settlements.

The results are paginated.

Access with

Organization access token with settlements.read

OAuth access with settlements.read

Query Params
string

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

integer | null
1 to 250
Defaults to 50

The maximum number of items to return. Defaults to 50 items.

string | null

Provide the token of the balance to filter the settlements by. This is the balance token that the settlement was settled to.

string | null

Provide the year to query the settlements. Must be used combined with month parameter

string | null

Provide the month to query the settlements. Must be used combined with year parameter

string | null

Provides the currencies to retrieve the settlements. It accepts multiple currencies in a comma-separated format.

Possible values: EUR GBP CHF DKK NOK PLN SEK USD CZK HUF AUD CAD

Show Details
EUREuro
GBPBritish Pound
CHFSwiss Franc
DKKDanish Krone
NOKNorwegian Krone
PLNPolish zล‚oty
SEKSwedish Krona
USDUnited States Dollar
CZKCzech Koruna
HUFHungarian Forint
AUDAustralian Dollar
CADCanadian Dollar
Responses

Language
Credentials
Request
Response
Choose an example:
application/hal+json