Get settlement¶
GET
https://api.mollie.com/v2/settlements/*id*
Successful payments, together with refunds, captures and chargebacks 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
or by the settlement’s bank
reference, for example 1234567.1804.03
.
Response¶
200
application/hal+json
string
|
Indicates the response contains a settlement object. Will always contain settlement for this endpoint. |
||||||||||||||||||||||||||||||||||
string
|
The settlement’s unique identifier, for example stl_jDk30akdN . |
||||||||||||||||||||||||||||||||||
string
|
The settlement’s bank reference, as found on your invoice and in your Mollie account. | ||||||||||||||||||||||||||||||||||
string
|
The date on which the settlement was created, in ISO 8601 format. | ||||||||||||||||||||||||||||||||||
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 . |
||||||||||||||||||||||||||||||||||
string
|
The status of the settlement. Possible values:
|
||||||||||||||||||||||||||||||||||
amount object
|
The total amount paid out with this settlement.
|
||||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||||
string
|
The ID of the invoice on which this settlement is invoiced, if it has been invoiced. | ||||||||||||||||||||||||||||||||||
object
|
An object with several URL objects relevant to the settlement. Every URL object will contain an
|
Example¶
1 2 3 4 5 6 7 | curl -X GET https://api.mollie.com/v2/settlements/stl_jDk30akdN \
-H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"
# or, by bank reference
curl -X GET https://api.mollie.com/v2/settlements/1234567.1804.03 \
-H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"
|
1 2 3 4 5 6 7 8 | <?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ");
$settlement = $mollie->settlements->get("stl_jDk30akdN");
// or, by bank reference
$settlement = $mollie->settlements->get("1234567.1804.03");
|
1 2 3 4 5 6 7 8 9 10 11 | require 'mollie-api-ruby'
Mollie::Client.configure do |config|
config.api_key = 'access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ'
end
settlement = Mollie::Settlement.get('stl_jDk30akdN')
# or, by bank reference
settlement = Mollie::Settlement.get('1234567.1804.03')
|
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 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 132 | 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",
"status": "paidout",
"amount": {
"value": "39.75",
"currency": "EUR"
},
"periods": {
"2018": {
"04": {
"revenue": [
{
"description": "iDEAL",
"method": "ideal",
"count": 6,
"amountNet": {
"value": "86.1000",
"currency": "EUR"
},
"amountVat": null,
"amountGross": {
"value": "86.1000",
"currency": "EUR"
}
},
{
"description": "Refunds iDEAL",
"method": "refund",
"count": 2,
"amountNet": {
"value": "-43.2000",
"currency": "EUR"
},
"amountVat": null,
"amountGross": {
"value": "43.2000",
"currency": "EUR"
}
}
],
"costs": [
{
"description": "iDEAL",
"method": "ideal",
"count": 6,
"rate": {
"fixed": {
"value": "0.3500",
"currency": "EUR"
},
"percentage": null
},
"amountNet": {
"value": "2.1000",
"currency": "EUR"
},
"amountVat": {
"value": "0.4410",
"currency": "EUR"
},
"amountGross": {
"value": "2.5410",
"currency": "EUR"
}
},
{
"description": "Refunds iDEAL",
"method": "refund",
"count": 2,
"rate": {
"fixed": {
"value": "0.2500",
"currency": "EUR"
},
"percentage": null
},
"amountNet": {
"value": "0.5000",
"currency": "EUR"
},
"amountVat": {
"value": "0.1050",
"currency": "EUR"
},
"amountGross": {
"value": "0.6050",
"currency": "EUR"
}
}
]
}
}
},
"invoiceId": "inv_FrvewDA3Pr",
"_links": {
"self": {
"href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN",
"type": "application/hal+json"
},
"invoice": {
"href": "https://api.mollie.com/v2/invoices/inv_FrvewDA3Pr",
"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"
},
"documentation": {
"href": "https://docs.mollie.com/reference/v2/settlements-api/get-settlement",
"type": "text/html"
}
}
}
|