Get settlement

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 retrieving 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/*id*
Authentication:App access tokens

Successful payments are collected into settlements, which are then paid out according to your account’s payout schedule. By retrieving a single settlement, you can check which payments were paid out with it and when the settlement took place.

Settlements will be transferred to your bank account with a reference, for example 1182161.1506.02. You can use the List settlements endpoint to look up a settlement by reference.

Parameters

Replace id in the endpoint URL by the settlement’s ID, for example stl_jDk30akdN.

Response

200 application/json

resourcestring
Indicates the response contains a settlement object. Will always contain settlement for this endpoint.
idstring
The settlement’s unique identifier, for example stl_jDk30akdN.
referencestring
The settlement’s bank reference, as found in your Mollie account and on your bank statement.
createdDatetimestring
The date on which the settlement was created, in ISO 8601 format.
settledDatetimestring
The date on which the settlement was settled, in ISO 8601 format. When requesting the open settlement or next settlement the return value is null.
statusstring

The status of the settlement.

Possible values:

  • open The settlement has not been closed yet.
  • pending The settlement has been closed and is being processed.
  • paidout The settlement has been paid out.
  • failed The settlement could not be paid out.
amountdecimal
The total amount in EUR paid out with this settlement.
periodsobject

This object is a collection of Period objects, which describe the settlement by month in full detail.

Please note the periods are sorted by date. For example, the field may contain an object called 2018, which contains a Period object called 03. The Period object fields are listed below.

Show child parameters

revenuearray

An array of Revenue objects containing the total revenue for each payment method during this period. Each object has the following fields.

Show child parameters

descriptionstring
A description of the revenue subtotal.
methodstring
The payment method ID, if applicable.
countinteger
The number of payments received for this payment method.
amountobject
The received subtotal for this payment method, further divided in net (excludes VAT), vat, and gross (includes VAT).
costsarray

An array of Cost objects, describing the fees withheld for each payment method during this period. Each object has the following fields.

Show child parameters

descriptionstring
A description of the subtotal.
methodstring
The payment method ID, if applicable.
countinteger
The number of times costs were made for this payment method.
rateobject
The service rates, further divided into fixed and variable costs.
amountobject
The paid costs for this payment method, further divided in net (excludes VAT), vat, and gross (includes VAT).
paymentIdsarray
A list of all payment IDs that are included in the settlement. You can use this to fully reconcile the settlement with your back office.
refundIdsarray
A list of all refund IDs that are included in the settlement. You can use this to fully recocnile the settlement with your back office.
chargebackIdsarray
A list of all chargeback IDs that are included in the settlement. You can use this to fully recocnile the settlement with your back office.
linksobject

An object with URLs to related resources.

Show child parameters

paymentsstring
URL to retrieve all payments included in the settlement.
refundsstring
URL to retrieve all refunds included in the settlement.
chargebacksstring
URL to retrieve all chargebacks included in the settlement.

Example

Request

1
2
curl -X GET https://api.mollie.com/v1/settlements/stl_jDk30akdN \
    -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
HTTP/1.1 200 OK
Content-Type: application/json

{
    "resource": "settlement",
    "id": "stl_jDk30akdN",
    "reference": "1234567.1511.03",
    "createdDatetime": "2015-11-06T06:00:01.0Z",
    "settledDatetime": "2015-11-06T09:41:44.0Z",
    "status": "paidout",
    "amount": "39.75",
    "periods": {
        "2015": {
            "11": {
                "revenue": [
                    {
                        "description": "iDEAL",
                        "method": "ideal",
                        "count": 6,
                        "amount": {
                            "net": "86.1000",
                            "vat": null,
                            "gross": "86.1000"
                        }
                    },
                    {
                        "description": "Refunds iDEAL",
                        "method": "refund",
                        "count": 2,
                        "amount": {
                            "net": "-43.2000",
                            "vat": null,
                            "gross": "-43.2000"
                        }
                    }
                ],
                "costs": [
                    {
                        "description": "iDEAL",
                        "method": "ideal",
                        "count": 6,
                        "rate": {
                            "fixed": "0.3500",
                            "percentage": null
                        },
                        "amount": {
                            "net": "2.1000",
                            "vat": "0.4410",
                            "gross": "2.5410"
                        }
                    },
                    {
                        "description": "Refunds iDEAL",
                        "method": "refund",
                        "count": 2,
                        "rate": {
                            "fixed": "0.2500",
                            "percentage": null
                        },
                        "amount": {
                            "net": "0.5000",
                            "vat": "0.1050",
                            "gross": "0.6050"
                        }
                    }
                ]
            }
        }
    },
    "links": {
        "payments": "https://api.mollie.com/v1/settlements/stl_jDk30akdN/payments",
        "refunds": "https://api.mollie.com/v1/settlements/stl_jDk30akdN/refunds",
        "chargebacks": "https://api.mollie.com/v1/settlements/stl_jDk30akdN/chargebacks"
    },
    "paymentIds": [
        "tr_PBHPvA2ViG",
        "tr_GAHivPBVP2",
        "tr_2VBPiPvGAH",
        "tr_2iHGBvPPVA",
        "tr_VPH2iPGvAB",
        "tr_AGPVviP2BH"
    ],
    "refundIds": [
        "re_PvGHiV2BPA",
        "re_APBiGPH2vV"
    ]
}