List refunds

Refunds 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 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/refunds
GEThttps://api.mollie.com/v1/payments/*paymentId*/refunds
Authentication:API keysApp access tokens

Retrieve all refunds. If the payment-specific endpoint is used, only refunds for that specific payment are returned.

The results are paginated. See pagination for more information.

Parameters

When using the payment-specific endpoint, replace paymentId in the endpoint URL by the payment’s ID, for example tr_7UhSN1zuXS.

offsetintegeroptional
The number of refunds to skip.
countintegeroptional
The number of refunds to return (with a maximum of 250).

Response

200 application/json

totalCountinteger
The total number of refunds available.
offsetinteger
The number of skipped refunds as requested.
countinteger
The number of refunds found in data, which is either the requested number (with a maximum of 250) or the default number.
dataarray
An array of refund objects as described in Get refund.
linksobject

Links to help navigate through the lists of refunds, based on the given offset.

Show child parameters

previousstring
The previous set of refunds, if available.
nextstring
The next set of refunds, if available.
firststring
The first set of refunds, if available.
laststring
The last set of refunds, if available.

Example

Request

1
2
curl -X GET https://api.mollie.com/v1/payments/tr_7UhSN1zuXS/refunds \
    -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

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

{
    "totalCount": 3,
    "offset": 0,
    "count": 3,
    "data": [
        {
            "id": "re_4qqhO89gsT",
            "payment": {
                "id": "tr_WDqYK6vllg",
                "mode": "test",
                "createdDatetime": "2018-03-14T11:26:38.0Z",
                "status": "refunded",
                "amount": "35.07",
                "amountRefunded": "5.95",
                "amountRemaining": "54.12",
                "description": "Order #33",
                "method": "ideal",
                "metadata": {
                    "order_id": "33"
                },
                "details": {
                    "consumerName": "Hr E G H K\u00fcppers en\/of MW M.J. K\u00fcppers-Veeneman",
                    "consumerAccount": "NL53INGB0654422370",
                    "consumerBic": "INGBNL2A"
                },
                "locale": "nl_NL",
                "links": {
                    "webhookUrl": "https://webshop.example.org/payments/webhook",
                    "redirectUrl": "https://webshop.example.org/order/33/",
                    "refunds": "https://api.mollie.com/v1/payments/tr_WDqYK6vllg/refunds"
                }
            },
            "amount": "5.95",
            "status": "pending",
            "refundedDatetime": "2018-03-14T17:00:50.0Z",
            "description": "Refund of order",
            "links": {
                "self": "https://api.mollie.com/v1/payments/tr_WDqYK6vllg/refunds/re_4qqhO89gsT"
            }
        },
        { },
        { }
    ]
}