List settlements

Settlements API v1

Warning

The v1 API has been deprecated. The v1 API will be supported for the foreseeable future, at least until July 2023. However, new features will only be added to the v2 API.

The documentation for listing settlements in the new v2 API can be found here. For more information on the v2 API, refer to our v2 migration guide.

GEThttps://api.mollie.com/v1/settlements
Authentication:App access tokens

Retrieve all settlements, ordered from new to old.

The results are paginated. See pagination for more information.

Parameters

referencestringoptional
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.
offsetintegeroptional
The number of settlements to skip.
countintegeroptional
The number of settlements to return (with a maximum of 250).

Response

200 application/json

totalCountinteger
The total number of settlements available.
offsetinteger
The number of skipped settlements as requested.
countinteger
The number of settlements found in data, which is either the requested number (with a maximum of 250) or the default number.
dataarray
An array of settlement objects as described in Get settlement.
linksobject

Links to help navigate through the lists of settlements, based on the given offset.

Show child parameters

previousstring
The previous set of settlements, if available.
nextstring
The next set of settlements, if available.
firststring
The first set of settlements, if available.
laststring
The last set of settlements, if available.

Example

Request

1
2
curl -X GET https://api.mollie.com/v1/settlements \
    -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"

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
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
HTTP/1.1 200 OK
Content-Type: application/json

{
    "totalCount": 9,
    "offset": 0,
    "count": 9,
    "data": [
        {
            "resource": "settlement",
            "id": "stl_jDk30akdN",
            "reference": "123456.1501.02",
            "createdDatetime": "2015-01-09T07:00:00.0Z",
            "settledDatetime": "2015-01-09T07:00:00.0Z",
            "status": "paidout",
            "amount": "994.55",
            "periods": {
                "2015": {
                    "01": {
                        "revenue": [
                            {
                                "description": "iDEAL",
                                "method": "ideal",
                                "count": 3,
                                "amount": {
                                    "net": "100.0000",
                                    "vat": null,
                                    "gross": "100.0000"
                                }
                            }
                        ],
                        "costs": [
                            {
                                "description": "iDEAL",
                                "method": "ideal",
                                "count": 3,
                                "amount": {
                                    "net": "4.5000",
                                    "vat": "0.9450",
                                    "gross": "5.4450"
                                }
                            }
                        ]
                    }
                }
            },
            "links": {
                "chargebacks": "https://api.mollie.com/v1/settlements/stl_jDk30akdN/chargebacks",
                "payments": "https://api.mollie.com/v1/settlements/stl_jDk30akdN/payments",
                "refunds": "https://api.mollie.com/v1/settlements/stl_jDk30akdN/refunds"
            },
            "paymentIds": [
                "tr_RpAwK4A7dg",
                "tr_V22Ek4ttj5",
                "tr_ReitZQReAz"
            ]
        },
        {
            "resource": "settlement",
            "id": "stl_pAd3Vq83",
            "reference": "123456.1501.01",
            "settledDatetime": "2015-01-02T07:00:00.0Z",
            "status": "paidout",
            "amount": "993.58",
            "periods": {
                "2015": {
                    "01": {
                        "revenue": [
                            {
                                "description": "Creditcard",
                                "method": "creditcard",
                                "count": 10,
                                "amount": {
                                    "net": "100.0000",
                                    "vat": null,
                                    "gross": "100.0000"
                                }
                            }
                        ],
                        "costs": [
                            {
                                "description": "Creditcard",
                                "method": "creditcard",
                                "count": 10,
                                "rate": {
                                    "fixed": "0.25",
                                    "percent": null
                                },
                                "amount": {
                                    "net": "2.5000",
                                    "vat": "0.5250",
                                    "gross": "3.0250"
                                }
                            },
                            {
                                "description": "Creditcard vaste transactiekosten",
                                "method": "creditcard",
                                "count": 10,
                                "rate": {
                                    "fixed": null,
                                    "percent": "2.80"
                                },
                                "amount": {
                                    "net": "2.8000",
                                    "vat": "0.5880",
                                    "gross": "3.3880"
                                }
                            }
                        ]
                    }
                }
            },
            "links": {
                "chargebacks": "https://api.mollie.com/v1/settlements/stl_pAd3Vq83/chargebacks",
                "payments": "https://api.mollie.com/v1/settlements/stl_pAd3Vq83/payments",
                "refunds": "https://api.mollie.com/v1/settlements/stl_pAd3Vq83/refunds"
            },
            "paymentIds": [
                "tr_s3cMndA7dg",
                "tr_Vs3cPTdtj5",
                "tr_Q3cEnMReAz",
                "..."
            ]
        },
        { },
        { }
    ],
    "links": {
        "first": "https://api.mollie.com/v1/settlements?count=10&offset=0",
        "previous": null,
        "next": "https://api.mollie.com/v1/settlements?count=10&offset=10",
        "last": "https://api.mollie.com/v1/settlements?count=10&offset=20"
    }
}