Get open balance
Settlements API

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

Retrieve the details of the open balance of the organization. This will return a settlement object representing your organization's balance.

If you don't have any balance, we will return an HTTP 404 response.

Parameters

No parameters required.

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

The open balance is returned in the same fashion as the Get settlement endpoint.

Example

Request code

require_once 'Mollie/API/Autoloader.php';

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

try
{
    $settlement = $mollie->settlements->get('open');

    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

{
    "id": "open",
    "reference": null,
    "amount": "0.46",
    "settledDatetime": null,
    "periods": {
        "2015": {
            "06": {
                "costs": [
                    {
                        "description": "SMS-notificatie",
                        "method": null,
                        "count": 1,
                        "rate": {
                            "fixed": "0.0900",
                            "percentage": null
                        },
                        "amount": {
                            "net": "0.0900",
                            "vat": "0.0000",
                            "gross": "0.0900"
                        }
                    },
                    {
                        "description": "iDEAL",
                        "method": "ideal",
                        "count": 1,
                        "rate": {
                            "fixed": "0.4500",
                            "percentage": null
                        },
                        "amount": {
                            "net": "0.4500",
                            "vat": "0.0000",
                            "gross": "0.4500"
                        }
                    }
                ],
                "revenue": [
                    {
                        "description": "iDEAL",
                        "method": "ideal",
                        "count": 1,
                        "amount": {
                            "net": "1.0000",
                            "vat": null,
                            "gross": "1.0000"
                        }
                    }
                ]
            }
        }
    },
    "paymentIds": null,
    "resource": "settlement"
}