List settlements

Settlements API v2
GEThttps://api.mollie.com/v2/settlements
Authentication:OAuth access tokens

Retrieve all settlements, ordered from new to old.

The results are paginated. See pagination for more information.

Parameters

reference

string
optional
Use this parameter to filter for a settlement with a specific reference. The reference is visible on your bank statement and in emails. An example reference would be 1182161.1506.02.

offset

integer
optional
The number of settlements to skip.

count

integer
optional
The number of settlements to return (with a maximum of 250).

Response

200 application/hal+json; charset=utf-8

count

integer
The number of settlements found in _embedded, which is either the requested number (with a maximum of 250) or the default number.

_embedded

object

The object containing the queried data.

settlements

array
An array of settlement objects as described in Get settlement.

_links

object

Links to help navigate through the lists of settlements. Every URL object will contain an href and a type field.

self

URL object
The URL to the current set of settlements.

previous

URL object
The previous set of settlements, if available.

next

URL object
The next set of settlements, if available.

documentation

URL object
The URL to the settlements list endpoint documentation.

Example

Request (curl)

1
2
curl -X GET https://api.mollie.com/v2/settlements?limit=5 \
    -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"

Request (PHP)

1
2
3
4
 <?php
 $mollie = new \Mollie\Api\MollieApiClient();
 $mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ");
 $settlements = $mollie->settlements->page();

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
HTTP/1.1 200 OK
Content-Type: application/hal+json; charset=utf-8

{
    "count": 5,
    "_embedded": {
        "settlements": [
            {
                "resource": "settlement",
                "id": "stl_jDk30akdN",
                "reference": "1234567.1804.03",
                "createdDatetime": "2018-04-06T06:00:01.0Z",
                "settledDatetime": "2018-04-06T09:41:44.0Z",
                "amount": {
                    "currency": "EUR",
                    "value": "39.75"
                },
                "periods": {
                    "2018": {
                        "4": {
                            "revenue": [ ],
                            "costs": [ ]
                        }
                    }
                },
                "_links": {
                    "self": {
                        "href": "https://api.mollie.com/v2/settlements/next",
                        "type": "application/hal+json"
                    },
                    "payments": {
                        "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN/payments",
                        "type": "application/hal+json"
                    },
                    "refunds": {
                        "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN/refunds",
                        "type": "application/hal+json"
                    },
                    "chargebacks": {
                        "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN/chargebacks",
                        "type": "application/hal+json"
                    },
                    "documentation": {
                        "href": "https://docs.mollie.com/reference/v2/settlements-api/get-settlement",
                        "type": "text/html"
                    }
                }
            },
            { },
            { },
            { },
            { }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/settlements?limit=5",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/settlements?from=stl_QM8w7JDEhU&limit=5",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/settlements-api/list-settlements",
            "type": "text/html"
        }
    }
}