List settlement payments
Settlements API

GET
https://api.mollie.nl/v1/settlements/settlementId/payments
Authentication: OAuth access tokens

Retrieve all payments included in a settlement.

Parameters

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

offset
integer

Optional – The number of objects to skip.

count
integer

Optional – The number of objects to return (with a maximum of 250).

Includes

Some endpoints allow you to indicate if you want more information to be included in the API response via the include querystring parameter.

  • settlement For each payment, include the settlement this payment belongs to.

Response

200
application/json; charset=utf-8
totalCount
integer

The total number of objects available.

offset
integer

The number of skipped objects as requested.

count
integer

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

data
array

A list of payments as described in Get payment.

links
object

Optional – Links to help navigate through the lists of objects, based on the given offset.

previous
string | null

Optional – The previous set of objects, if available.

next
string | null

Optional – The next set of objects, if available.

first
string | null

Optional – The first set of objects, if available.

last
string | null

Optional – The last set of objects, if available.

Example

Request code

// Not implemented. Create a pull request:
//   https://github.com/mollie/mollie-api-php

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "totalCount": 280,
    "offset": 0,
    "count": 10,
    "data": [
        {
            "resource": "payment",
            "id": "tr_7UhSN1zuXS",
            "method": "ideal",
            "mode": "test",
            "createdDatetime": "2017-12-16T06:33:27.0Z"
            "status": "paid",
            "amount": "10.00",
            "description": "My first payment",
            "metadata": null,
            "profileId": "pfl_QkEhN94Ba",
            "customerId": "cst_4qqhO89gsT",
            "settlementId": "stl_jDk30akdN",
            "links": {
                "settlement": "https://api.mollie.nl/v1/settlements/stl_jDk30akdN",
                "redirectUrl": "https://webshop.example.org/order/12345/"
            }
        },
        { ... },
        { ... }
    ],
    "links": {
        "first": "https://api.mollie.nl/v1/settlements/stl_jDk30akdN/payments?count=10&offset=0",
        "previous": null,
        "next": "https://api.mollie.nl/v1/settlements/stl_jDk30akdN/payments?count=10&offset=10",
        "last": "https://api.mollie.nl/v1/settlements/stl_jDk30akdN/payments?count=10&offset=270"
    }
}