Skip to content
/
List settlements

List settlements

Request

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: settlement:read

Security
accountId and apiKey
Query
limitnumber

The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100.

cursorstring

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.

created_atstring

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).

Example:created_at=interval(2006-01-02 15:04,2006-01-02 15:04)
updated_atstring

Filter records by update datetime interval. Maximum range of 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM)

Example:updated_at=interval(2006-01-02 15:04,2006-01-02 15:04)
status[]Array of strings

Filter by one or more statuses. Repeat the parameter for multiple values (e.g. status[]=IN_TRANSIT&status[]=SUCCEEDED). Case-insensitive.

Items Enum:"IN_TRANSIT""SUCCEEDED""FAILED"
Example:status[]=SUCCEEDED&status[]=FAILED
curl -i -X GET \
  'https://api.test.easypay.pt/2.0/settlement?limit=0&cursor=string&created_at=interval(2006-01-02%2015%3A04%2C2006-01-02%2015%3A04)&updated_at=interval(2006-01-02%2015%3A04%2C2006-01-02%2015%3A04)&status%5B%5D=SUCCEEDED%2CFAILED' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

Successful response with a list of settlements

Bodyapplication/json
dataArray of objects(Settlement)required
metadataobject(Metadata)required

An object containing additional information about the response. It includes details that help manage and navigate the retrieved data.

Response
{
  "data": [
    { … }
  ],
  "metadata": {
    "next_cursor": "lL_j7ilk7rc",
    "count": 1
  }
}