Get next settlement

Settlements API v2
GEThttps://api.mollie.com/v2/settlements/next
Authentication:Organization access tokensApp access tokens

Retrieve the details of the current settlement that has not yet been paid out.

Response

200 application/hal+json

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

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/settlements/next \
   -H "Authorization: Bearer access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ"

1
2
3
4
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setAccessToken("access_Wwvu7egPcJLLJ9Kb7J632x8wJ2zMeJ");
$nextSettlement = $mollie->settlements->next();

1
2
3
4
5
6
from mollie.api.client import Client

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

settlement = mollie_client.settlements.get("next")

1
2
3
4
5
6
7
require 'mollie-api-ruby'

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

settlement = Mollie::Settlement.next

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 share suggestions on our Discord:
https://discord.gg/VaTVkXB4aQ

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
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "resource": "settlement",
    "id": "next",
    "createdAt": "2018-04-06T06:00:01.0Z",
    "status": "open",
    "amount": {
        "currency": "EUR",
        "value": "39.75"
    },
    "periods": {
        "2018": {
            "04": {
                "revenue": [
                    {
                        "description": "iDEAL",
                        "method": "ideal",
                        "count": 6,
                        "amountNet": {
                            "value": "86.1000",
                            "currency": "EUR"
                        },
                        "amountVat": null,
                        "amountGross": {
                            "value": "86.1000",
                            "currency": "EUR"
                        }
                    },
                    {
                        "description": "Refunds iDEAL",
                        "method": "refund",
                        "count": 2,
                        "amountNet": {
                            "value": "-43.2000",
                            "currency": "EUR"
                        },
                        "amountVat": null,
                        "amountGross": {
                            "value": "43.2000",
                            "currency": "EUR"
                        }
                    }
                ],
                "costs": [
                    {
                        "description": "iDEAL",
                        "method": "ideal",
                        "count": 6,
                        "rate": {
                            "fixed": {
                                "value": "0.3500",
                                "currency": "EUR"
                            },
                            "percentage": null
                        },
                        "amountNet": {
                            "value": "2.1000",
                            "currency": "EUR"
                        },
                        "amountVat": {
                            "value": "0.4410",
                            "currency": "EUR"
                        },
                        "amountGross": {
                            "value": "2.5410",
                            "currency": "EUR"
                        }
                    },
                    {
                        "description": "Refunds iDEAL",
                        "method": "refund",
                        "count": 2,
                        "rate": {
                            "fixed": {
                                "value": "0.2500",
                                "currency": "EUR"
                            },
                            "percentage": null
                        },
                        "amountNet": {
                            "value": "0.5000",
                            "currency": "EUR"
                        },
                        "amountVat": {
                            "value": "0.1050",
                            "currency": "EUR"
                        },
                        "amountGross": {
                            "value": "0.6050",
                            "currency": "EUR"
                        }
                    }
                ]
            }
        }
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/settlements/next",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/settlements-api/get-next-settlement",
            "type": "text/html"
        }
    }
}