List settlements

get

https://api.mollie.com/v2/settlements

Retrieve a list of all your settlements.

The results are paginated.

🔑
Access with
Advanced access token with settlements.readOAuth access with settlements.read

Query Params

from

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.

limit

integer | null

1 to 250

Defaults to 50

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

balanceId

string | null

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

year

string | null

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

month

string | null

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

currencies

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 RON

Show Details

Responses

Language

Credentials

Loading…

Response

Choose an example:

application/hal+json

200A list of settlement objects. For a complete reference of the settlement object, refer to the Get settlement endpoint documentation.