List settlement refunds

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 listing refunds included in a settlement 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/*settlementId*/refunds
Authentication:App 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 endpoint is an alias of the List refunds endpoint. All parameters for that endpoint can be used here as well.

Response

200 application/json

This endpoint is an alias of the List refunds endpoint. The response is therefore the exact same.

Example

Request

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

{
    "totalCount": 28,
    "offset": 0,
    "count": 10,
    "data": [
        {
            "id": "re_CkS3qkJ8Ny",
            "payment": {
                "resource": "payment",
                "id": "tr_2qkhcMzypH",
                "mode": "live",
                "createdDatetime": "2017-01-11T15:38:55.0Z",
                "status": "refunded",
                "paidDatetime": "2017-01-11T15:40:59.0Z",
                "amount": "25.00",
                "amountRefunded": "5.00",
                "amountRemaining": "45.00",
                "description": "Test payment 25 EU",
                "method": "ideal",
                "metadata": null,
                "profileId": "pfl_D96wnsu869",
                "links": {
                    "refunds": "https://api.mollie.com/v1/payments/tr_2qkhcMzypH/refunds",
                    "settlement": "https://api.mollie.com/v1/settlements/stl_QM8w7JDEhU"
                },
                "settlementId": "stl_QM8w7JDEhU"
            },
            "amount": "5.00",
            "status": "processing",
            "refundedDatetime": "2017-01-11T15:39:53.0Z",
            "description": "Test refund 5 EU",
            "links": {
                "self": "https://api.mollie.com/v1/payments/tr_2qkhcMzypH/refunds/re_CkS3qkJ8Ny"
            }
        },
        { },
        { }
    ],
    "links": {
        "first": "https://api.mollie.com/v1/settlements/stl_QM8w7JDEhU/refunds?count=10&offset=0",
        "previous": null,
        "next": "https://api.mollie.com/v1/settlements/stl_QM8w7JDEhU/refunds?count=10&offset=10",
        "last": "https://api.mollie.com/v1/settlements/stl_QM8w7JDEhU/refunds?count=10&offset=20"
    }
}