List settlement refunds¶
Settlements API v2
GET
https://api.mollie.com/v2/settlements/*settlementId*/refunds
Authentication:Organization access tokensApp access tokens
Retrieve all refunds included in a settlement.
Parameters¶
Replace settlementId
in the endpoint URL by the settlement’s ID, for example stl_jDk30akdN
.
This API is an comparable to the List refunds. All parameters for that API can be used here as well.
Response¶
200
application/hal+json
The response of this endpoint is the same as List refunds endpoint.
Example¶
Request¶
cURLPHPPythonRubyNode.js
1 2 | curl -X GET https://api.mollie.com/v2/settlements/stl_jDk30akdN/refunds \ -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ" |
1 2 3 4 5 6 | <?php $mollie = new \Mollie\Api\MollieApiClient(); $mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"); $settlement = $mollie->settlements->get("stl_jDk30akdN"); $refunds = $settlement->refunds(); |
1 2 3 4 5 6 7 | from mollie.api.client import Client mollie_client = Client() mollie_client.set_access_token("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ") settlement = mollie_client.settlements.get("stl_jDk30akdN") refunds = settlement.refunds.list() |
1 2 3 4 5 6 7 | require 'mollie-api-ruby' Mollie::Client.configure do |config| config.api_key = 'access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ' end refunds = Mollie::Settlement::Refund.all(settlement_id: 'stl_jDk30akdN') |
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 | HTTP/1.1 200 OK Content-Type: application/hal+json { "_embedded": { "refunds": [ { "resource": "refund", "id": "re_3aKhkUNigy", "amount": { "value": "10.00", "currency": "EUR" }, "status": "refunded", "createdAt": "2018-08-30T07:59:02+00:00", "description": "Order #33", "paymentId": "tr_maJaG2j8OM", "settlementAmount": { "value": "-10.00", "currency": "EUR" }, "settlementId": "stl_jDk30akdN", "_links": { "self": { "href": "https://api.mollie.com/v2/payments/tr_maJaG2j8OM/refunds/re_3aKhkUNigy", "type": "application/hal+json" }, "payment": { "href": "https://api.mollie.com/v2/payments/tr_maJaG2j8OM", "type": "application/hal+json" }, "settlement": { "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN", "type": "application/hal+json" } } }, { } ] }, "count": 1, "_links": { "documentation": { "href": "https://docs.mollie.com/reference/v2/settlements-api/list-settlement-refunds", "type": "text/html" }, "self": { "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN/refunds?limit=50", "type": "application/hal+json" }, "previous": null, "next": null } } |