List refunds

Refunds API v2
GEThttps://api.mollie.com/v2/refunds
GEThttps://api.mollie.com/v2/payments/*paymentId*/refunds

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.

from

string
optional
Offset the result set to the refund with this ID. The refund with this ID is included in the result set as well.

limit

integer
optional
The number of refunds to return (with a maximum of 250).

Response

200 application/hal+json; charset=utf-8

count

integer
The number of refunds found in _embedded, which is either the requested number (with a maximum of 250) or the default number.

_embedded

object

The object containing the queried data.

refunds

array
An array of refund objects as described in Get refund.

_links

object

Links to help navigate through the lists of refunds. Every URL object will contain an href and a type field.

self

object
The URL to the current set of refunds.

previous

object
The previous set of refunds, if available.

next

object
The next set of refunds, if available.

documentation

object
The URL to the refunds list endpoint documentation.

Example

Request

1
2
curl -X GET https://api.mollie.com/v2/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
48
49
50
51
52
53
HTTP/1.1 200 OK
Content-Type: application/hal+json; charset=utf-8

{
    "count": 5,
    "_embedded": {
        "refunds": [
            {
                "resource": "refund",
                "id": "re_4qqhO89gsT",
                "amount": {
                    "currency": "EUR",
                    "value": "5.95"
                },
                "status": "pending",
                "createdAt": "2018-03-14T17:09:02.0Z",
                "description": "Order",
                "paymentId": "tr_WDqYK6vllg",
                "_links": {
                    "self": {
                        "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg/refunds/re_4qqhO89gsT",
                        "type": "application/hal+json"
                    },
                    "payment": {
                        "href": "https://api.mollie.com/v2/payments/tr_WDqYK6vllg",
                        "type": "application/hal+json"
                    },
                    "documentation": {
                        "href": "https://docs.mollie.com/reference/v2/refunds-api/get-refund",
                        "type": "text/html"
                    }
                }
            },
            { },
            { }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/payments/tr_7UhSN1zuXS/refunds?limit=5",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/payments/tr_7UhSN1zuXS/refunds?from=re_APBiGPH2vV&limit=5",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/refunds-api/list-refunds",
            "type": "text/html"
        }
    }
}