List settlements
Settlements API

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

Retrieve all settlements, ordered from new to old.

Parameters

reference
string

Optional – Use this parameter to filter for a settlement with a specific reference. The reference is visible on your bank statement and in emails. An example reference would be 1182161.1506.02.

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.

  • No includes supported for this endpoint.

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 settlements as described in Get settlement.

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

require_once 'Mollie/API/Autoloader.php';

try
{
    $mollie = new Mollie_API_Client;
    $mollie->setAccessToken('access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ');

    foreach ($mollie->settlements->all() as $settlement)
    {
        echo $settlement->id . ': ' . $settlement->amount;
    }
}
catch (Mollie_API_Exception $e)
{
    echo "API call failed: " . $e->getMessage();
}

Response

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

{
    "totalCount": 9,
    "offset": 0,
    "count": 9,
    "data": [
        {
            "resource": "settlement",
            "id": "stl_jDk30akdN",
            "reference": "123456.1501.02",
            "settledDatetime": "2015-01-09T07:00:00.0Z",
            "amount": "994.55",
            "periods": {
                "2015": {
                    "01": {
                        "revenue": [
                            {
                                "description": "iDEAL",
                                "method": "ideal",
                                "count": 3,
                                "amount": {
                                    "net": "100.0000",
                                    "vat": null,
                                    "gross": "100.0000"
                                }
                            }
                        ],
                        "costs": [
                            {
                                "description": "iDEAL",
                                "method": "ideal",
                                "count": 3,
                                "amount": {
                                    "net": "4.5000",
                                    "vat": "0.9450",
                                    "gross": "5.4450"
                                }
                            }
                        ]
                    }
                }
            },
            "paymentIds": [
                "tr_RpAwK4A7dg",
                "tr_V22Ek4ttj5",
                "tr_ReitZQReAz"
            ]
        },
        {
            "resource": "settlement",
            "id": "stl_pAd3Vq83",
            "reference": "123456.1501.01",
            "settledDatetime": "2015-01-02T07:00:00.0Z",
            "amount": "993.58",
            "periods": {
                "2015": {
                    "01": {
                        "revenue": [
                            {
                                "description": "Creditcard",
                                "method": "creditcard",
                                "count": 10,
                                "amount": {
                                    "net": "100.0000",
                                    "vat": null,
                                    "gross": "100.0000"
                                }
                            }
                        ],
                        "costs": [
                            {
                                "description": "Creditcard",
                                "method": "creditcard",
                                "count": 10,
                                "rate": {
                                    "fixed": "0.25",
                                    "percent": null
                                },
                                "amount": {
                                    "net": "2.5000",
                                    "vat": "0.5250",
                                    "gross": "3.0250"
                                }
                            },
                            {
                                "description": "Creditcard vaste transactiekosten",
                                "method": "creditcard",
                                "count": 10,
                                "rate": {
                                    "fixed": null,
                                    "percent": "2.80"
                                },
                                "amount": {
                                    "net": "2.8000",
                                    "vat": "0.5880",
                                    "gross": "3.3880"
                                }
                            }
                        ]
                    }
                }
            },
            "paymentIds": [
                "tr_s3cMndA7dg",
                "tr_Vs3cPTdtj5",
                "tr_Q3cEnMReAz",
                ...
            ]
        },
        { ... },
        { ... }
    ],
    "links": {
        "first": "https://api.mollie.nl/v1/settlements?count=10&offset=0",
        "previous": null,
        "next": "https://api.mollie.nl/v1/settlements?count=10&offset=10",
        "last": "https://api.mollie.nl/v1/settlements?count=10&offset=20"
    }
}