v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Settlements API

List settlements

Retrieve a list of all your settlements.

The results are paginated.

🔑 Access with

Advanced access token with settlements.read

OAuth access with settlements.read

get/settlements

fromstring

Example:stl_jDk30akdN

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.

limitinteger nullable

Example:50

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

balanceIdstring nullable

Example:bal_gVMhHKqSSRYJyPsuoPNFH

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

yearstring nullable

Example:2025

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

monthstring nullable

Example:1

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

currenciesstring nullable

Example:EUR

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

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