List payments

Payments API v2
GEThttps://api.mollie.com/v2/payments

Retrieve all payments created with the current payment profile, ordered from newest to oldest.

The results are paginated. See pagination for more information.

Parameters

from
string
optional
Offset the result set to the payment with this ID. The payment with this ID is included in the result set as well.
limit
integer
optional
The number of payments to return (with a maximum of 250).

Mollie Connect/OAuth parameters

If you’re creating an app with Mollie Connect/OAuth, the following parameters are also available. With the profileId parameter, you can specify which profile you want to look at when listing payments. If you omit the profileId parameter, you will get all payments on the organization. Organizations can have multiple profiles for each of their websites. See Profiles API for more information.

profileId
string
optional
The payment profile’s unique identifier, for example pfl_3RkSN1zuPE.
testmode
boolean
optional
Set this to true to only retrieve payments made in test mode. By default, only live payments are returned.

Includes

This endpoint allows you to include additional information by appending the following values via the include querystring parameter.

  • details.qrCode Include a QR code object for each payment that supports it. Only available for iDEAL, Bitcoin, Bancontact and bank transfer payments.

Response

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

count
integer
The number of payments 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.

payments
array
An array of payment objects as described in Get payment.
_links
object

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

self
URL object
The URL to the current set of payments.
previous
URL object
The previous set of payments, if available.
next
URL object
The next set of payments, if available.
documentation
URL object
The URL to the payments list endpoint documentation.

Example

Request

1
2
curl -X GET https://api.mollie.com/v2/payments?limit=5 \
    -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
54
55
56
57
58
HTTP/1.1 200 OK
Content-Type: application/hal+json; charset=utf-8

{
    "count": 5,
    "_embedded": {
        "payments": [
            {
                "resource": "payment",
                "id": "tr_7UhSN1zuXS",
                "mode": "test",
                "createdAt": "2018-02-12T11:58:35.0Z",
                "expiresAt": "2018-02-12T12:13:35.0Z",
                "status": "open",
                "isCancelable": false,
                "amount": {
                    "value": "75.00",
                    "currency": "GBP"
                },
                "description": "test",
                "method": "ideal",
                "metadata": null,
                "details": null,
                "profileId": "pfl_QkEhN94Ba",
                "redirectUrl": "https://webshop.example.org/order/12345/",
                "_links": {
                    "checkout": {
                        "href": "https://www.mollie.com/paymentscreen/issuer/select/ideal/7UhSN1zuXS",
                        "type": "text/html"
                    },
                    "self": {
                        "href": "https://api.mollie.com/v2/payments/tr_7UhSN1zuXS",
                        "type": "application/hal+json"
                    }
                }
            },
            { },
            { },
            { },
            { }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/payments?limit=5",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/payments?from=tr_SDkzMggpvx&limit=5",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/payments-api/list-payments",
            "type": "text/html"
        }
    }
}