List settlements¶
Settlements API v2
GEThttps://api.mollie.com/v2/settlements
Authentication:Organization access tokensApp access tokens
Retrieve all settlements, ordered from new to old.
The results are paginated. See pagination for more information.
Parameters¶
fromstringoptional
Used for pagination. Offset the result set to the settlement with this ID. The
settlement with this ID is included in the result set as well.
limitintegeroptional
The number of settlements to return (with a maximum of 250).
Response¶
200 application/hal+json
countinteger
The number of settlements found in
_embedded, which is either the requested number (with a maximum of 250) or
the default number._embeddedobjectThe object containing the queried data.
settlementsarray
An array of settlement objects as described in Get settlement.
_linksobjectLinks to help navigate through the lists of settlements. Every URL object will contain an href and a type
field.
selfURL object
The URL to the current set of settlements.
previousURL object
The previous set of settlements, if available.
nextURL object
The next set of settlements, if available.
documentationURL object
The URL to the settlements list endpoint documentation.
Example¶
cURLPHPPythonRubyNode.js
1 2 | curl -X GET https://api.mollie.com/v2/settlements?limit=5 \ -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ" |
1 2 3 4 | <?php $mollie = new \Mollie\Api\MollieApiClient(); $mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"); $settlements = $mollie->settlements->page(); |
1 2 3 4 5 6 | from mollie.api.client import Client mollie_client = Client() mollie_client.set_access_token("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ") settlements = mollie_client.settlements.list() |
1 2 3 4 5 6 7 | require 'mollie-api-ruby' Mollie::Client.configure do |config| config.api_key = 'access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ' end settlements = Mollie::Settlement.all |
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 share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | HTTP/1.1 200 OK
Content-Type: application/hal+json
{
"_embedded": {
"settlements": [
{
"resource": "settlement",
"id": "stl_77zGEcWNhg",
"reference": "3331641.1911.01",
"createdAt": "2019-11-21T05:02:00+00:00",
"settledAt": "2019-11-20T23:00:00+00:00",
"status": "paidout",
"amount": {
"value": "9200.34",
"currency": "EUR"
},
"periods": {
"2019": {
"11": {
"revenue": [],
"costs": []
}
}
},
"_links": {
"self": {
"href": "https://api.mollie.com/v2/settlements/stl_77zGEcWNhg",
"type": "application/hal+json"
},
"payments": {
"href": "https://api.mollie.com/v2/settlements/stl_77zGEcWNhg/payments",
"type": "application/hal+json"
},
"refunds": {
"href": "https://api.mollie.com/v2/settlements/stl_77zGEcWNhg/refunds",
"type": "application/hal+json"
},
"chargebacks": {
"href": "https://api.mollie.com/v2/settlements/stl_77zGEcWNhg/chargebacks",
"type": "application/hal+json"
},
"captures": {
"href": "https://api.mollie.com/v2/settlements/stl_77zGEcWNhg/captures",
"type": "application/hal+json"
}
}
},
{
"resource": "settlement",
"id": "stl_r8FVT3rxGx",
"reference": "6551641.1911.01",
"createdAt": "2019-10-21T05:02:00+00:00",
"settledAt": "2019-10-20T23:00:00+00:00",
"status": "paidout",
"amount": {
"value": "10200.99",
"currency": "EUR"
},
"periods": {
"2019": {
"10": {
"revenue": [
{
"description": "SEPA-incasso",
"method": "directdebit",
"count": 459,
"amountNet": {
"value": "10312.50",
"currency": "EUR"
},
"amountVat": null,
"amountGross": {
"value": "10312.50",
"currency": "EUR"
}
},
{
"description": "SEPA-incasso weigeringen",
"method": "directdebit",
"count": 5,
"amountNet": {
"value": "-111.50",
"currency": "EUR"
},
"amountVat": null,
"amountGross": {
"value": "-111.50",
"currency": "EUR"
}
}
],
"costs": [
{
"description": "SEPA-incasso storneringen",
"method": null,
"count": 12,
"rate": {
"fixed": {
"value": "0.45",
"currency": "EUR"
},
"percentage": "0"
},
"amountNet": {
"value": "5.40",
"currency": "EUR"
},
"amountVat": {
"value": "1.134",
"currency": "EUR"
},
"amountGross": {
"value": "6.534",
"currency": "EUR"
}
}
],
"invoiceId": "inv_M8Sa6n5mf3"
}
}
},
"invoiceId": "inv_M8Sa6n5mf3",
"_links": {
"self": {
"href": "https://api.mollie.com/v2/settlements/stl_r8FVT3rxGx",
"type": "application/hal+json"
},
"invoice": {
"href": "https://api.mollie.com/v2/invoices/inv_M8Sa6n5mf3",
"type": "application/hal+json"
},
"payments": {
"href": "https://api.mollie.com/v2/settlements/stl_r8FVT3rxGx/payments",
"type": "application/hal+json"
},
"refunds": {
"href": "https://api.mollie.com/v2/settlements/stl_r8FVT3rxGx/refunds",
"type": "application/hal+json"
},
"chargebacks": {
"href": "https://api.mollie.com/v2/settlements/stl_r8FVT3rxGx/chargebacks",
"type": "application/hal+json"
},
"captures": {
"href": "https://api.mollie.com/v2/settlements/stl_r8FVT3rxGx/captures",
"type": "application/hal+json"
}
}
}
]
},
"count": 3,
"_links": {
"documentation": {
"href": "https://docs.mollie.com/reference/v2/settlements-api/list-settlements",
"type": "text/html"
},
"self": {
"href": "https://api.mollie.com/v2/settlements?limit=50",
"type": "application/hal+json"
},
"previous": null,
"next": null
}
}
|