Skip to content

README.md

Latest commit

 

History

History
549 lines (410 loc) · 26.3 KB

README.md

File metadata and controls

549 lines (410 loc) · 26.3 KB

Balances

Overview

Available Operations

list

Retrieve a list of the organization's balances, including the primary balance.

The results are paginated.

Example Usage: list-balances-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.ListBalancesRequest;
import com.mollie.mollie.models.operations.ListBalancesResponse;
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();

        ListBalancesRequest req = ListBalancesRequest.builder()
                .currency("EUR")
                .from("bal_gVMhHKqSSRYJyPsuoPNFH")
                .limit(50L)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


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

    }
}

Example Usage: list-balances-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.ListBalancesRequest;
import com.mollie.mollie.models.operations.ListBalancesResponse;
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();

        ListBalancesRequest req = ListBalancesRequest.builder()
                .currency("EUR")
                .from("bal_gVMhHKqSSRYJyPsuoPNFH")
                .limit(50L)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


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

    }
}

Parameters

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

Response

ListBalancesResponse

Errors

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

get

When processing payments with Mollie, we put all pending funds — usually minus Mollie fees — on a balance. Once you have linked a bank account to your Mollie account, we can pay out your balance towards this bank account.

With the Balances API you can retrieve your current balance. The response includes two amounts:

  • The pending amount. These are payments that have been marked as paid, but are not yet available on your balance.
  • The available amount. This is the amount that you can get paid out to your bank account, or use for refunds.

With instant payment methods like iDEAL, payments are moved to the available balance instantly. With slower payment methods, like credit card for example, it can take a few days before the funds are available on your balance. These funds will be shown under the pending amount in the meanwhile.

Example Usage: get-balance-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.GetBalanceResponse;
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();

        GetBalanceResponse res = sdk.balances().get()
                .balanceId("bal_gVMhHKqSSRYJyPsuoPNFH")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .call();

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

Example Usage: get-balance-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.GetBalanceResponse;
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();

        GetBalanceResponse res = sdk.balances().get()
                .balanceId("bal_gVMhHKqSSRYJyPsuoPNFH")
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .call();

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

Parameters

Parameter Type Required Description Example
balanceId String ✔️ Provide the ID of the related balance. bal_gVMhHKqSSRYJyPsuoPNFH
testmode Optional<Boolean> ➖ You can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
idempotencyKey Optional<String> ➖ A unique key to ensure idempotent requests. This key should be a UUID v4 string. 123e4567-e89b-12d3-a456-426

Response

GetBalanceResponse

Errors

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

getPrimary

Retrieve the primary balance. This is the balance of your account's primary currency, where all payments are settled to by default.

This endpoint is a convenient alias of the Get balance endpoint.

Example Usage

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.operations.GetPrimaryBalanceResponse;
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();

        GetPrimaryBalanceResponse res = sdk.balances().getPrimary()
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .call();

        if (res.entityBalance().isPresent()) {
            System.out.println(res.entityBalance().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

GetPrimaryBalanceResponse

Errors

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

getReport

Retrieve a summarized report for all transactions on a given balance within a given timeframe.

The API also provides a detailed report on all 'prepayments' for Mollie fees that were deducted from your balance during the reported period, ahead of your Mollie invoice.

The alias primary can be used instead of the balance ID to refer to the organization's primary balance.

Example Usage: get-balance-report-200-1

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.BalanceReportGrouping;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.GetBalanceReportRequest;
import com.mollie.mollie.models.operations.GetBalanceReportResponse;
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();

        GetBalanceReportRequest req = GetBalanceReportRequest.builder()
                .balanceId("bal_gVMhHKqSSRYJyPsuoPNFH")
                .from("2024-01-01")
                .until("2024-02-01")
                .grouping(BalanceReportGrouping.STATUS_BALANCES)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();

        GetBalanceReportResponse res = sdk.balances().getReport()
                .request(req)
                .call();

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

Example Usage: get-balance-report-200-2

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.BalanceReportGrouping;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.GetBalanceReportRequest;
import com.mollie.mollie.models.operations.GetBalanceReportResponse;
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();

        GetBalanceReportRequest req = GetBalanceReportRequest.builder()
                .balanceId("bal_gVMhHKqSSRYJyPsuoPNFH")
                .from("2024-01-01")
                .until("2024-02-01")
                .grouping(BalanceReportGrouping.STATUS_BALANCES)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();

        GetBalanceReportResponse res = sdk.balances().getReport()
                .request(req)
                .call();

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

Example Usage: get-balance-report-200-3

package hello.world;

import com.mollie.mollie.Client;
import com.mollie.mollie.models.components.BalanceReportGrouping;
import com.mollie.mollie.models.components.Security;
import com.mollie.mollie.models.errors.ErrorResponse;
import com.mollie.mollie.models.operations.GetBalanceReportRequest;
import com.mollie.mollie.models.operations.GetBalanceReportResponse;
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();

        GetBalanceReportRequest req = GetBalanceReportRequest.builder()
                .balanceId("bal_gVMhHKqSSRYJyPsuoPNFH")
                .from("2024-01-01")
                .until("2024-02-01")
                .grouping(BalanceReportGrouping.STATUS_BALANCES)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();

        GetBalanceReportResponse res = sdk.balances().getReport()
                .request(req)
                .call();

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

Parameters

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

Response

GetBalanceReportResponse

Errors

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

listTransactions

Retrieve a list of all balance transactions. Transactions include for example payments, refunds, chargebacks, and settlements.

For an aggregated report of these balance transactions, refer to the Get balance report endpoint.

The alias primary can be used instead of the balance ID to refer to the organization's primary balance.

The results are paginated.

Example Usage: list-balance-transactions-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.ListBalanceTransactionsRequest;
import com.mollie.mollie.models.operations.ListBalanceTransactionsResponse;
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();

        ListBalanceTransactionsRequest req = ListBalanceTransactionsRequest.builder()
                .balanceId("bal_gVMhHKqSSRYJyPsuoPNFH")
                .from("baltr_QM24QwzUWR4ev4Xfgyt29A")
                .limit(50L)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.balances().listTransactions()
                .callAsStream()
                .forEach((ListBalanceTransactionsResponse item) -> {
                   // handle page
                });

    }
}

Example Usage: list-balance-transactions-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.ListBalanceTransactionsRequest;
import com.mollie.mollie.models.operations.ListBalanceTransactionsResponse;
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();

        ListBalanceTransactionsRequest req = ListBalanceTransactionsRequest.builder()
                .balanceId("bal_gVMhHKqSSRYJyPsuoPNFH")
                .from("baltr_QM24QwzUWR4ev4Xfgyt29A")
                .limit(50L)
                .idempotencyKey("123e4567-e89b-12d3-a456-426")
                .build();


        sdk.balances().listTransactions()
                .callAsStream()
                .forEach((ListBalanceTransactionsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

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

Response

ListBalanceTransactionsResponse

Errors

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