Get settlement
Settlements API

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

Successful payments are collected into settlements, which are then paid out according to your account's payout schedule. By retrieving a single settlement, you can check which payments were paid out with it, when the settlement took place, and what invoice reference was used for it.

Settlements will be transferred to your bank account with a reference, for example 1182161.1506.02. You can use the List settlements endpoint to find the settlement with this reference.

Parameters

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

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
resource
string

Indicates the response contains a settlement object.

Possible values: settlement

id
string

The settlement's identifier, for example stl_jDk30akdN.

reference
string

The settlement's bank reference, as found on your invoice and in your Mollie account.

createdDatetime
string | null

The date on which the settlement was created. When requesting the next settlement the returned date signifies the expected settlement date. When requesting the open settlement (open funds) the return value is null.

settledDatetime
string | null

The date on which the settlement was settled. When requesting the open settlement or next settlement the return value is null.

status
string

The status of the settlement.

Possible values:

  • open The settlement has not been closed yet.
  • pending The settlement has been closed and is being processed.
  • paidout The settlement has been paid out.
  • failed The settlement could not be paid out.
amount
decimal

The total amount paid out with this settlement.

periods
object

This object is a collection of Period objects, which describe the settlement by month in full detail. Please refer to the Period object section below.

paymentIds
array

A list of all payment IDs that make up the settlement. You can use this to fully reconciliate the settlement with your back office.

refundIds
array

A list of all refund IDs that make up the settlement. You can use this to fully reconciliate the settlement with your back office.

chargebackIds
array

A list of all chargeback IDs that make up the settlement. You can use this to fully reconciliate the settlement with your back office.

links
object

An object with URLs to related resources.

chargebacks
string

URL to retrieve all chargebacks included in the settlement.

payments
string

URL to retrieve all payments included in the settlement.

refunds
string

URL to retrieve all refunds included in the settlement.

Period object

Please note the periods field is sorted by date. For example, the periods field may contain an object called 2017, which contains a Period object called 12. The Period object fields are listed below.

revenue
array

The total revenue for each payment method during this period.

description
string

A description of the subtotal.

amount
object

The received subtotal for this payment method, further divided in net (excludes VAT), vat, and gross (includes VAT).

count
integer

The number of payments received for this payment method.

method
string | null

The payment method ID, if applicable.

costs
array

The fees withheld for each payment method during this period.

description
string

A description of the subtotal.

amount
object

The paid costs for this payment method, further divided in net (excludes VAT), vat, and gross (includes VAT).

count
integer

The number of times costs were made for this payment method.

rate
object

The service rates, further divided into fixed and variable costs.

method
string | null

The payment method ID, if applicable.

Example

Request code

require_once 'Mollie/API/Autoloader.php';

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

    $settlement = $mollie->settlements->get('stl_jDk30akdN');

    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

{
    "resource": "settlement",
    "id": "stl_jDk30akdN",
    "reference": "1234567.1511.03",
    "createdDatetime": "2015-11-06T06:00:01.0Z",
    "settledDatetime": "2015-11-06T09:41:44.0Z",
    "amount": "39.75",
    "periods": {
        "2015": {
            "11": {
                "revenue": [
                    {
                        "description": "iDEAL",
                        "method": "ideal",
                        "count": 6,
                        "amount": {
                            "net": "86.1000",
                            "vat": null,
                            "gross": "86.1000"
                        }
                    },
                    {
                        "description": "Refunds iDEAL",
                        "method": "refund",
                        "count": 2,
                        "amount": {
                            "net": "-43.2000",
                            "vat": null,
                            "gross": "-43.2000"
                        }
                    }
                ],
                "costs": [
                    {
                        "description": "iDEAL",
                        "method": "ideal",
                        "count": 6,
                        "rate": {
                            "fixed": "0.3500",
                            "percentage": null
                        },
                        "amount": {
                            "net": "2.1000",
                            "vat": "0.4410",
                            "gross": "2.5410"
                        }
                    },
                    {
                        "description": "Refunds iDEAL",
                        "method": "refund",
                        "count": 2,
                        "rate": {
                            "fixed": "0.2500",
                            "percentage": null
                        },
                        "amount": {
                            "net": "0.5000",
                            "vat": "0.1050",
                            "gross": "0.6050"
                        }
                    }
                ]
            }
        }
    },
    "links": {
        "chargebacks": "https://api.mollie.nl/v1/settlements/stl_jDk30akdN/chargebacks",
        "payments": "https://api.mollie.nl/v1/settlements/stl_jDk30akdN/payments",
        "refunds": "https://api.mollie.nl/v1/settlements/stl_jDk30akdN/refunds"
    },
    "paymentIds": [
        "tr_PBHPvA2ViG",
        "tr_GAHivPBVP2",
        "tr_2VBPiPvGAH",
        "tr_2iHGBvPPVA",
        "tr_VPH2iPGvAB",
        "tr_AGPVviP2BH"
    ],
    "refundIds": [
        "re_PvGHiV2BPA",
        "re_APBiGPH2vV"
    ]
}