List payments

Payments 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 payments 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/payments
Authentication:API keysApp access tokens

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

The results are paginated. See pagination for more information.

Parameters

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

Access token parameters

If you are using organization access tokens or are creating an OAuth app, the following query string 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.

profileIdstringoptional
testmodebooleanoptional

Includes

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

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

Response

200 application/json

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

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

Show child parameters

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

Example

Request

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

{
    "totalCount": 280,
    "offset": 0,
    "count": 10,
    "data": [
        {
            "resource": "payment",
            "id": "tr_7UhSN1zuXS",
            "mode": "test",
            "createdDatetime": "2018-03-16T17:09:01.0Z",
            "status": "open",
            "expiryPeriod": "PT15M",
            "amount": "10.00",
            "description": "Order #12345",
            "metadata": {
                "order_id": "12345"
            },
            "locale": "nl_NL",
            "profileId": "pfl_QkEhN94Ba",
            "links": {
                "redirectUrl": "https://webshop.example.org/order/12345/"
            }
        },
        { },
        { }
    ],
    "links": {
        "first": "https://api.mollie.com/v1/payments?count=10&offset=0",
        "previous": null,
        "next": "https://api.mollie.com/v1/payments?count=10&offset=10",
        "last": "https://api.mollie.com/v1/payments?count=10&offset=270"
    }
}