Get settlement

Settlements API v2
GEThttps://api.mollie.com/v2/settlements/*id*

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

Beside payments, settlements can be composed of other entities such as refunds, chargebacks or captures.

Parameters

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

Response

200 application/hal+json

resource

string
Indicates the response contains a settlement object. Will always contain settlement for this endpoint.

id

string
The settlement’s unique identifier, for example stl_jDk30akdN.

reference

string
The settlement’s bank reference, as found on your invoice and in your Mollie account.

createdAt

string
The date on which the settlement was created, in ISO 8601 format.

settledAt

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

status

string

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.

amount

amount object

The total amount paid out with this settlement.

currency

string
The ISO 4217 currency code.

value

string
A string containing the exact amount of the settlement in the given currency.

periods

object

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.

revenue

array

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

description

string
A description of the revenue subtotal.

amountNet

amount object
The net total of received funds for this payment method (excludes VAT).

amountVat

amount object
The VAT amount applicable to the revenue.

amountGross

amount object
The gross total of received funds for this payment method (includes VAT).

count

integer
The number of payments received for this payment method.

method

string
The payment method ID, if applicable.

costs

array

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

description

string
A description of the subtotal.

amountNet

amount object
The net total costs for this payment method (excludes VAT).

amountVat

amount object
The VAT amount applicable to the costs.

amountGross

amount object
The gross total costs for this payment method (includes VAT).

count

integer
The number of times costs were made for this payment method.

rate

object

The service rates, further divided into fixed and percentage costs.

fixed

amount object
An amount object describing the fixed costs.

variable

string
A string describing the variable costs as a percentage.

method

string
The payment method ID, if applicable.

invoiceId

string
The ID of the invoice on which this settlement is invoiced, if it has been invoiced.

_links

object

An object with several URL objects relevant to the settlement. Every URL object will contain an href and a type field.

self

URL object
The API resource URL of the settlement itself.

payments

URL object
The API resource URL of the payments that are included in this settlement.

refunds

URL object
The API resource URL of the refunds that are included in this settlement.

chargebacks

URL object
The API resource URL of the chargebacks that are included in this settlement.

captures

URL object
The API resource URL of the captures that are included in this settlement.

invoice

URL object
The API resource URL of the invoice that contains this settlement.

documentation

URL object
The URL to the settlement retrieval endpoint documentation.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/settlements/stl_jDk30akdN \
   -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"
1
2
3
4
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ");
$settlement = $mollie->settlements->get("stl_jDk30akdN");
1
2
3
4
We don't have a Python code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation
1
2
3
4
We don't have a Ruby code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation
1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

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
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "resource": "settlement",
    "id": "stl_jDk30akdN",
    "reference": "1234567.1804.03",
    "createdAt": "2018-04-06T06:00:01.0Z",
    "settledAt": "2018-04-06T09:41:44.0Z",
    "amount": {
        "currency": "EUR",
        "value": "39.75"
    },
    "periods": {
        "2018": {
            "4": {
                "revenue": [
                    {
                        "description": "iDEAL",
                        "method": "ideal",
                        "count": 6,
                        "amountNet": {
                            "currency": "EUR",
                            "value": "86.1000"
                        },
                        "amountVat": null,
                        "amountGross": {
                            "currency": "EUR",
                            "value": "86.1000"
                        }
                    },
                    {
                        "description": "Refunds iDEAL",
                        "method": "refund",
                        "count": 2,
                        "amountNet": {
                            "currency": "EUR",
                            "value": "-43.2000"
                        },
                        "amountVat": null,
                        "amountGross": {
                            "currency": "EUR",
                            "value": "43.2000"
                        }
                    }
                ],
                "costs": [
                    {
                        "description": "iDEAL",
                        "method": "ideal",
                        "count": 6,
                        "rate": {
                            "fixed": {
                                "currency": "EUR",
                                "value": "0.3500"
                            },
                            "percentage": null
                        },
                        "amountNet": {
                            "currency": "EUR",
                            "value": "2.1000"
                        },
                        "amountVat": {
                            "currency": "EUR",
                            "value": "0.4410"
                        },
                        "amountGross": {
                            "currency": "EUR",
                            "value": "2.5410"
                        }
                    },
                    {
                        "description": "Refunds iDEAL",
                        "method": "refund",
                        "count": 2,
                        "rate": {
                            "fixed": {
                                "currency": "EUR",
                                "value": "0.2500"
                            },
                            "percentage": null
                        },
                        "amountNet": {
                            "currency": "EUR",
                            "value": "0.5000"
                        },
                        "amountVat": {
                            "currency": "EUR",
                            "value": "0.1050"
                        },
                        "amountGross": {
                            "currency": "EUR",
                            "value": "0.6050"
                        }
                    }
                ]
            }
        }
    },
    "invoiceId": "inv_FrvewDA3Pr",
    "_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"
        },
        "captures": {
            "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN/captures",
            "type": "application/hal+json"
        },
        "invoice": {
             "href": "https://api.mollie.com/v2/invoices/inv_FrvewDA3Pr",
             "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/settlements-api/get-settlement",
            "type": "text/html"
        }
    }
}