List settlement payments

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 payments 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*/payments
Authentication:App access tokens

Retrieve all payments included in a settlement.

Note that payments for Klarna payment methods are not listed in here. These payment methods are settled using captures. To retrieve the captures, the v2 api needs to be used, see the List settlement captures endpoint.

Parameters

Replace settlementId in the endpoint URL by the settlement’s ID, for example stl_jDk30akdN.

This endpoint is an alias of the List payments endpoint. All parameters for that endpoint can be used here as well.

Response

200 application/json

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

Example

Request

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

{
    "totalCount": 280,
    "offset": 0,
    "count": 10,
    "data": [
        {
            "resource": "payment",
            "id": "tr_7UhSN1zuXS",
            "method": "ideal",
            "mode": "test",
            "createdDatetime": "2018-03-17T01:47:50.0Z"
            "status": "paid",
            "amount": "10.00",
            "description": "Order #12345",
            "metadata": null,
            "profileId": "pfl_QkEhN94Ba",
            "customerId": "cst_4qqhO89gsT",
            "settlementId": "stl_jDk30akdN",
            "links": {
                "settlement": "https://api.mollie.com/v1/settlements/stl_jDk30akdN",
                "redirectUrl": "https://webshop.example.org/order/12345/"
            }
        },
        { },
        { }
    ],
    "links": {
        "first": "https://api.mollie.com/v1/settlements/stl_jDk30akdN/payments?count=10&offset=0",
        "previous": null,
        "next": "https://api.mollie.com/v1/settlements/stl_jDk30akdN/payments?count=10&offset=10",
        "last": "https://api.mollie.com/v1/settlements/stl_jDk30akdN/payments?count=10&offset=270"
    }
}