List settlements
Returns your settlements, newest first. Each settlement groups the transactions paid out together in a single bank transfer.
Narrow the results with status[], created_at, and updated_at. Pagination is cursor-based: pass the previous response's metadata.next_cursor back as cursor. An empty next_cursor means there are no further pages.
Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">settlement:read</code>
Query parameters
The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100.
The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results.
Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM).
Filter records by update datetime interval. Maximum range of 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)
Filter by one or more statuses. Repeat the parameter for multiple values (e.g. status[]=IN_TRANSIT&status[]=SUCCEEDED). Case-insensitive.
[ "SUCCEEDED", "FAILED" ]
Response
Successful response with a list of settlements
Example response
{
"data": [
{
"id": "f6a7b8c9-d0e1-2345-fabc-456789012306",
"created_at": "2026-02-05T09:30:00Z",
"updated_at": "2025-10-01T00:00:00Z",
"name": "1006",
"description": "EASYPAY-1977225-42185-161-998590696",
"status": "IN_TRANSIT",
"total_amount": {
"amount": 0.12,
"currency": "EUR"
},
"number_of_items": 2,
"destination": {
"type": "IBAN",
"details": {
"iban": "PT50007974951304464003280"
}
}
}
],
"metadata": {
"next_cursor": "lL_j7ilk7rc",
"count": 10
}
}