List settlement payments

Settlements API v2
GEThttps://api.mollie.com/v2/settlements/*settlementId*/payments

Retrieve all Payments included in a Settlement.

Note that payments for pay after delivery methods (such as Klarna Pay later) are not listed in here. These payment methods are settled using captures. To retrieve the captures, use the List settlement captures.

Parameters

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

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

Response

200 application/hal+json

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

Example

Request

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/settlements/stl_jDk30akdN/payments?limit=5 \
    -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"
1
2
3
4
5
6
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ");

$settlement = $mollie->settlements->get("stl_jDk30akdN");
$payments = $settlement->payments();
1
2
3
4
5
6
from mollie.api.client import Client

mollie_client = Client()
mollie_client.set_access_token('access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ')

payments = mollie_client.settlement_payments.with_parent_id('stl_jDk30akdN').list()
1
2
3
4
5
6
7
require 'mollie-api-ruby'

Mollie::Client.configure do |config|
  config.api_key = 'access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ'
end

payments = Mollie::Settlement::Payment.all(settlement_id: 'stl_jDk30akdN')
1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

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

{
    "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": "Order #12345",
                "method": "ideal",
                "metadata": null,
                "details": null,
                "profileId": "pfl_QkEhN94Ba",
                "settlementId": "stl_jDk30akdN",
                "redirectUrl": "https://webshop.example.org/order/12345/",
                "_links": {
                     "self": {
                         "href": "https://api.mollie.com/v2/payments/tr_7UhSN1zuXS",
                         "type": "application/hal+json"
                     },
                     "settlement": {
                         "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN",
                         "type": "application/hal+json"
                     }
                 }
             },
            { },
            { },
            { },
            { }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN/payments?limit=5",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/settlements/stl_jDk30akdN/payments?from=tr_SDkzMggpvx&limit=5",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/settlements-api/list-settlement-payments",
            "type": "text/html"
        }
    }
}