Settlements

Overview

Available Operations

list - List settlements
get - Get settlement
getOpen - Get open settlement
getNext - Get next settlement
listPayments - List settlement payments
listCaptures - List settlement captures
listRefunds - List settlement refunds
listChargebacks - List settlement chargebacks

list

Retrieve a list of all your settlements.

The results are paginated.

Example Usage

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Currencies;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementsRequest;
import com.mollie.mollie.models.operations.ListSettlementsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementsRequest req = ListSettlementsRequest.builder()
                .from("stl_jDk30akdN")
                .limit(50L)
                .balanceId("bal_gVMhHKqSSRYJyPsuoPNFH")
                .year("2025")
                .month("1")
                .currencies(Currencies.EUR)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().list()
                .callAsStream()
                .forEach((ListSettlementsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	ListSettlementsRequest	✔️	The request object to use for the request.

Response

ListSettlementsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorResponse	400, 404	application/hal+json
models/errors/APIException	4XX, 5XX	/

get

Retrieve a single settlement by its ID.

To lookup settlements by their bank reference, replace the ID in the URL by a reference. For example: 1234567.2404.03.

A settlement represents a transfer of your balance funds to your external bank account.

Settlements will typically include a report that details what balance transactions have taken place between this settlement and the previous one.

For more accurate bookkeeping, refer to the balance report endpoint or the balance transactions endpoint.

Example Usage

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.GetSettlementResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        GetSettlementResponse res = sdk.settlements().get()
                .settlementId("stl_5B8cwPMGnU")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .call();

        if (res.entitySettlement().isPresent()) {
            System.out.println(res.entitySettlement().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`settlementId`	String	✔️	Provide the ID of the related settlement.	stl_5B8cwPMGnU
`idempotencyKey`	Optional<String>	➖	A unique key to ensure idempotent requests. This key should be a UUID v4 string.	123e4567-e89b-12d3-a456-426

Response

GetSettlementResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorResponse	404	application/hal+json
models/errors/APIException	4XX, 5XX	/

getOpen

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

For a complete reference of the settlement object, refer to the Get settlement endpoint documentation.

For more accurate bookkeeping, refer to the balance report endpoint or the balance transactions endpoint.

Example Usage

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.operations.GetOpenSettlementResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        GetOpenSettlementResponse res = sdk.settlements().getOpen()
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .call();

        if (res.entitySettlement().isPresent()) {
            System.out.println(res.entitySettlement().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`idempotencyKey`	Optional<String>	➖	A unique key to ensure idempotent requests. This key should be a UUID v4 string.	123e4567-e89b-12d3-a456-426

Response

GetOpenSettlementResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

getNext

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

For a complete reference of the settlement object, refer to the Get settlement endpoint documentation.

For more accurate bookkeeping, refer to the balance report endpoint or the balance transactions endpoint.

Example Usage

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.operations.GetNextSettlementResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        GetNextSettlementResponse res = sdk.settlements().getNext()
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .call();

        if (res.entitySettlement().isPresent()) {
            System.out.println(res.entitySettlement().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
`idempotencyKey`	Optional<String>	➖	A unique key to ensure idempotent requests. This key should be a UUID v4 string.	123e4567-e89b-12d3-a456-426

Response

GetNextSettlementResponse

Errors

Error Type	Status Code	Content Type
models/errors/APIException	4XX, 5XX	/

listPayments

Retrieve all payments included in the given settlement.

The response is in the same format as the response of the List payments endpoint.

For capture-based payment methods such as Klarna, the payments are not listed here. Refer to the List captures endpoint endpoint instead.

Example Usage: list-payments-200-1

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.components.Sorting;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementPaymentsRequest;
import com.mollie.mollie.models.operations.ListSettlementPaymentsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .profileId("pfl_5B8cwPMGnU")
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementPaymentsRequest req = ListSettlementPaymentsRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("tr_5B8cwPMGnU")
                .limit(50L)
                .sort(Sorting.DESC)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listPayments()
                .callAsStream()
                .forEach((ListSettlementPaymentsResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-payments-200-2

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.components.Sorting;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementPaymentsRequest;
import com.mollie.mollie.models.operations.ListSettlementPaymentsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .profileId("pfl_5B8cwPMGnU")
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementPaymentsRequest req = ListSettlementPaymentsRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("tr_5B8cwPMGnU")
                .limit(50L)
                .sort(Sorting.DESC)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listPayments()
                .callAsStream()
                .forEach((ListSettlementPaymentsResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-payments-200-3

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.components.Sorting;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementPaymentsRequest;
import com.mollie.mollie.models.operations.ListSettlementPaymentsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .profileId("pfl_5B8cwPMGnU")
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementPaymentsRequest req = ListSettlementPaymentsRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("tr_5B8cwPMGnU")
                .limit(50L)
                .sort(Sorting.DESC)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listPayments()
                .callAsStream()
                .forEach((ListSettlementPaymentsResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-settlement-payments-200-1

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.components.Sorting;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementPaymentsRequest;
import com.mollie.mollie.models.operations.ListSettlementPaymentsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .profileId("pfl_5B8cwPMGnU")
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementPaymentsRequest req = ListSettlementPaymentsRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("tr_5B8cwPMGnU")
                .limit(50L)
                .sort(Sorting.DESC)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listPayments()
                .callAsStream()
                .forEach((ListSettlementPaymentsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	ListSettlementPaymentsRequest	✔️	The request object to use for the request.

Response

ListSettlementPaymentsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorResponse	400	application/hal+json
models/errors/APIException	4XX, 5XX	/

listCaptures

Retrieve all captures included in the given settlement.

The response is in the same format as the response of the List captures endpoint.

Example Usage: list-captures-200-1

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementCapturesRequest;
import com.mollie.mollie.models.operations.ListSettlementCapturesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementCapturesRequest req = ListSettlementCapturesRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("cpt_vytxeTZskVKR7C7WgdSP3d")
                .limit(50L)
                .embed("payment")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listCaptures()
                .callAsStream()
                .forEach((ListSettlementCapturesResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-captures-200-2

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementCapturesRequest;
import com.mollie.mollie.models.operations.ListSettlementCapturesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementCapturesRequest req = ListSettlementCapturesRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("cpt_vytxeTZskVKR7C7WgdSP3d")
                .limit(50L)
                .embed("payment")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listCaptures()
                .callAsStream()
                .forEach((ListSettlementCapturesResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-settlement-captures-200-1

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementCapturesRequest;
import com.mollie.mollie.models.operations.ListSettlementCapturesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementCapturesRequest req = ListSettlementCapturesRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("cpt_vytxeTZskVKR7C7WgdSP3d")
                .limit(50L)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listCaptures()
                .callAsStream()
                .forEach((ListSettlementCapturesResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	ListSettlementCapturesRequest	✔️	The request object to use for the request.

Response

ListSettlementCapturesResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorResponse	400, 404	application/hal+json
models/errors/APIException	4XX, 5XX	/

listRefunds

Retrieve all refunds 'deducted' from the given settlement.

The response is in the same format as the response of the List refunds endpoint.

Example Usage: list-refunds-200-1

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementRefundsRequest;
import com.mollie.mollie.models.operations.ListSettlementRefundsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementRefundsRequest req = ListSettlementRefundsRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("re_5B8cwPMGnU")
                .limit(50L)
                .embed("payment")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listRefunds()
                .callAsStream()
                .forEach((ListSettlementRefundsResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-settlement-refunds-200-1

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementRefundsRequest;
import com.mollie.mollie.models.operations.ListSettlementRefundsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementRefundsRequest req = ListSettlementRefundsRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("re_5B8cwPMGnU")
                .limit(50L)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listRefunds()
                .callAsStream()
                .forEach((ListSettlementRefundsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	ListSettlementRefundsRequest	✔️	The request object to use for the request.

Response

ListSettlementRefundsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorResponse	400, 404	application/hal+json
models/errors/APIException	4XX, 5XX	/

listChargebacks

Retrieve all chargebacks 'deducted' from the given settlement.

The response is in the same format as the response of the List chargebacks endpoint.

Example Usage: list-chargeback-200-1

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementChargebacksRequest;
import com.mollie.mollie.models.operations.ListSettlementChargebacksResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .testmode(false)
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementChargebacksRequest req = ListSettlementChargebacksRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("chb_xFzwUN4ci8HAmSGUACS4J")
                .limit(50L)
                .embed("payment")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listChargebacks()
                .callAsStream()
                .forEach((ListSettlementChargebacksResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-chargeback-200-2

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementChargebacksRequest;
import com.mollie.mollie.models.operations.ListSettlementChargebacksResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .testmode(false)
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementChargebacksRequest req = ListSettlementChargebacksRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("chb_xFzwUN4ci8HAmSGUACS4J")
                .limit(50L)
                .embed("payment")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listChargebacks()
                .callAsStream()
                .forEach((ListSettlementChargebacksResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-chargeback-200-3

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.ListSettlementChargebacksRequest;
import com.mollie.mollie.models.operations.ListSettlementChargebacksResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorResponse, Exception {

        Client sdk = Client.builder()
                .testmode(false)
                .security(Security.builder()
                    .organizationAccessToken(System.getenv().getOrDefault("ORGANIZATION_ACCESS_TOKEN", ""))
                    .build())
            .build();

        ListSettlementChargebacksRequest req = ListSettlementChargebacksRequest.builder()
                .settlementId("stl_5B8cwPMGnU")
                .from("chb_xFzwUN4ci8HAmSGUACS4J")
                .limit(50L)
                .embed("payment")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.settlements().listChargebacks()
                .callAsStream()
                .forEach((ListSettlementChargebacksResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
`request`	ListSettlementChargebacksRequest	✔️	The request object to use for the request.

Response

ListSettlementChargebacksResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorResponse	400, 404	application/hal+json
models/errors/APIException	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Settlements

Overview

Available Operations

list

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

getOpen

Example Usage

Parameters

Response

Errors

getNext

Example Usage

Parameters

Response

Errors

listPayments

Example Usage: list-payments-200-1

Example Usage: list-payments-200-2

Example Usage: list-payments-200-3

Example Usage: list-settlement-payments-200-1

Parameters

Response

Errors

listCaptures

Example Usage: list-captures-200-1

Example Usage: list-captures-200-2

Example Usage: list-settlement-captures-200-1

Parameters

Response

Errors

listRefunds

Example Usage: list-refunds-200-1

Example Usage: list-settlement-refunds-200-1

Parameters

Response

Errors

listChargebacks

Example Usage: list-chargeback-200-1

Example Usage: list-chargeback-200-2

Example Usage: list-chargeback-200-3

Parameters

Response

Errors