README.md

Payments

(payments())

Available Operations

• addAccountToPool - Add an account to a pool
• connectorsTransfer - Transfer funds between Connector accounts
• createAccount - Create an account
• createBankAccount - Create a BankAccount in Payments and on the PSP
• createPayment - Create a payment
• createPool - Create a Pool
• createTransferInitiation - Create a TransferInitiation
• deletePool - Delete a Pool
• deleteTransferInitiation - Delete a transfer initiation
• forwardBankAccount - Forward a bank account to a connector
• getAccountBalances - Get account balances
• getBankAccount - Get a bank account created by user on Formance
• getConnectorTask - Read a specific task of the connector ⚠️ Deprecated
• getConnectorTaskV1 - Read a specific task of the connector
• getPayment - Get a payment
• getPool - Get a Pool
• getPoolBalances - Get pool balances
• getTransferInitiation - Get a transfer initiation
• installConnector - Install a connector
• listAllConnectors - List all installed connectors
• listBankAccounts - List bank accounts created by user on Formance
• listConfigsAvailableConnectors - List the configs of each available connector
• listConnectorTasks - List tasks from a connector ⚠️ Deprecated
• listConnectorTasksV1 - List tasks from a connector
• listPayments - List payments
• listPools - List Pools
• listTransferInitiations - List Transfer Initiations
• paymentsgetAccount - Get an account
• paymentsgetServerInfo - Get server info
• paymentslistAccounts - List accounts
• readConnectorConfig - Read the config of a connector ⚠️ Deprecated
• readConnectorConfigV1 - Read the config of a connector
• removeAccountFromPool - Remove an account from a pool
• resetConnector - Reset a connector ⚠️ Deprecated
• resetConnectorV1 - Reset a connector
• retryTransferInitiation - Retry a failed transfer initiation
• reverseTransferInitiation - Reverse a transfer initiation
• udpateTransferInitiationStatus - Update the status of a transfer initiation
• uninstallConnector - Uninstall a connector ⚠️ Deprecated
• uninstallConnectorV1 - Uninstall a connector
• updateBankAccountMetadata - Update metadata of a bank account
• updateConnectorConfigV1 - Update the config of a connector
• updateMetadata - Update metadata

addAccountToPool

Add an account to a pool

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.AddAccountToPoolRequest;
import com.formance.formance_sdk.models.operations.AddAccountToPoolResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.AddAccountToPoolRequest;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            AddAccountToPoolRequest req = AddAccountToPoolRequest.builder()
                .addAccountToPoolRequest(AddAccountToPoolRequest.builder()
                        .accountID("<value>")
                        .build())
                .poolId("<value>")
                .build();

            AddAccountToPoolResponse res = sdk.payments().addAccountToPool()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.AddAccountToPoolRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.AddAccountToPoolResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

connectorsTransfer

Execute a transfer between two accounts.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ConnectorsTransferRequest;
import com.formance.formance_sdk.models.operations.ConnectorsTransferResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.TransferRequest;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ConnectorsTransferRequest req = ConnectorsTransferRequest.builder()
                .transferRequest(TransferRequest.builder()
                        .amount(new BigInteger("100"))
                        .asset("USD")
                        .destination("acct_1Gqj58KZcSIg2N2q")
                        .source("acct_1Gqj58KZcSIg2N2q")
                        .build())
                .connector(Connector.BANKING_CIRCLE)
                .build();

            ConnectorsTransferResponse res = sdk.payments().connectorsTransfer()
                .request(req)
                .call();

            if (res.transferResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ConnectorsTransferRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ConnectorsTransferResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

createAccount

Create an account

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.CreateAccountResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.AccountRequest;
import com.formance.formance_sdk.models.shared.AccountType;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            AccountRequest req = AccountRequest.builder()
                .connectorID("<value>")
                .createdAt(OffsetDateTime.parse("2024-08-19T02:15:08.668Z"))
                .reference("<value>")
                .type(AccountType.UNKNOWN)
                .accountName("<value>")
                .defaultAsset("<value>")
                .metadata(java.util.Map.ofEntries(
                    entry("key", "<value>")))
                .build();

            CreateAccountResponse res = sdk.payments().createAccount()
                .request(req)
                .call();

            if (res.paymentsAccountResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.shared.AccountRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.CreateAccountResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

createBankAccount

Create a bank account in Payments and on the PSP.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.CreateBankAccountResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.BankAccountRequest;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            BankAccountRequest req = BankAccountRequest.builder()
                .connectorID("<value>")
                .country("GB")
                .name("My account")
                .accountNumber("<value>")
                .iban("HU80500236840980904027018003")
                .metadata(java.util.Map.ofEntries(
                    entry("key", "<value>")))
                .swiftBicCode("<value>")
                .build();

            CreateBankAccountResponse res = sdk.payments().createBankAccount()
                .request(req)
                .call();

            if (res.bankAccountResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.shared.BankAccountRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.CreateBankAccountResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

createPayment

Create a payment

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.CreatePaymentResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.PaymentRequest;
import com.formance.formance_sdk.models.shared.PaymentScheme;
import com.formance.formance_sdk.models.shared.PaymentStatus;
import com.formance.formance_sdk.models.shared.PaymentType;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            PaymentRequest req = PaymentRequest.builder()
                .amount(new BigInteger("100"))
                .asset("USD")
                .connectorID("<value>")
                .createdAt(OffsetDateTime.parse("2024-11-09T01:03:21.153Z"))
                .reference("<value>")
                .scheme(PaymentScheme.GOOGLE_PAY)
                .status(PaymentStatus.DISPUTE_WON)
                .type(PaymentType.TRANSFER)
                .destinationAccountID("<value>")
                .sourceAccountID("<value>")
                .build();

            CreatePaymentResponse res = sdk.payments().createPayment()
                .request(req)
                .call();

            if (res.paymentResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.shared.PaymentRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.CreatePaymentResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

createPool

Create a Pool

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.CreatePoolResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.PoolRequest;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            PoolRequest req = PoolRequest.builder()
                .accountIDs(java.util.List.of(
                        "<value>"))
                .name("<value>")
                .build();

            CreatePoolResponse res = sdk.payments().createPool()
                .request(req)
                .call();

            if (res.poolResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.shared.PoolRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.CreatePoolResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

createTransferInitiation

Create a transfer initiation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.CreateTransferInitiationResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.TransferInitiationRequest;
import com.formance.formance_sdk.models.shared.TransferInitiationRequestType;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            TransferInitiationRequest req = TransferInitiationRequest.builder()
                .amount(new BigInteger("256698"))
                .asset("USD")
                .description("<value>")
                .destinationAccountID("<value>")
                .reference("XXX")
                .scheduledAt(OffsetDateTime.parse("2023-06-16T18:59:33.654Z"))
                .sourceAccountID("<value>")
                .type(TransferInitiationRequestType.PAYOUT)
                .validated(false)
                .connectorID("<value>")
                .metadata(java.util.Map.ofEntries(
                    entry("key", "<value>")))
                .provider(Connector.MANGOPAY)
                .build();

            CreateTransferInitiationResponse res = sdk.payments().createTransferInitiation()
                .request(req)
                .call();

            if (res.transferInitiationResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.shared.TransferInitiationRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.CreateTransferInitiationResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

deletePool

Delete a pool by its id.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.DeletePoolRequest;
import com.formance.formance_sdk.models.operations.DeletePoolResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            DeletePoolRequest req = DeletePoolRequest.builder()
                .poolId("<value>")
                .build();

            DeletePoolResponse res = sdk.payments().deletePool()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.DeletePoolRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.DeletePoolResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

deleteTransferInitiation

Delete a transfer initiation by its id.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.DeleteTransferInitiationRequest;
import com.formance.formance_sdk.models.operations.DeleteTransferInitiationResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            DeleteTransferInitiationRequest req = DeleteTransferInitiationRequest.builder()
                .transferId("<value>")
                .build();

            DeleteTransferInitiationResponse res = sdk.payments().deleteTransferInitiation()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.DeleteTransferInitiationRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.DeleteTransferInitiationResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

forwardBankAccount

Forward a bank account to a connector

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ForwardBankAccountRequest;
import com.formance.formance_sdk.models.operations.ForwardBankAccountResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.ForwardBankAccountRequest;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ForwardBankAccountRequest req = ForwardBankAccountRequest.builder()
                .forwardBankAccountRequest(ForwardBankAccountRequest.builder()
                        .connectorID("<value>")
                        .build())
                .bankAccountId("<value>")
                .build();

            ForwardBankAccountResponse res = sdk.payments().forwardBankAccount()
                .request(req)
                .call();

            if (res.bankAccountResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ForwardBankAccountRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ForwardBankAccountResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

getAccountBalances

Get account balances

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.GetAccountBalancesRequest;
import com.formance.formance_sdk.models.operations.GetAccountBalancesResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            GetAccountBalancesRequest req = GetAccountBalancesRequest.builder()
                .accountId("<value>")
                .asset("<value>")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .from(OffsetDateTime.parse("2023-02-05T05:11:20.042Z"))
                .limit(743236L)
                .pageSize(125462L)
                .sort(java.util.List.of(
                    "<value>"))
                .to(OffsetDateTime.parse("2023-07-15T08:57:06.406Z"))
                .build();

            GetAccountBalancesResponse res = sdk.payments().getAccountBalances()
                .request(req)
                .call();

            if (res.balancesCursor().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.GetAccountBalancesRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.GetAccountBalancesResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

getBankAccount

Get a bank account created by user on Formance

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.GetBankAccountRequest;
import com.formance.formance_sdk.models.operations.GetBankAccountResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            GetBankAccountRequest req = GetBankAccountRequest.builder()
                .bankAccountId("<value>")
                .build();

            GetBankAccountResponse res = sdk.payments().getBankAccount()
                .request(req)
                .call();

            if (res.bankAccountResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.GetBankAccountRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.GetBankAccountResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

getConnectorTask

Get a specific task associated to the connector.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.GetConnectorTaskRequest;
import com.formance.formance_sdk.models.operations.GetConnectorTaskResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            GetConnectorTaskRequest req = GetConnectorTaskRequest.builder()
                .connector(Connector.ADYEN)
                .taskId("<value>")
                .build();

            GetConnectorTaskResponse res = sdk.payments().getConnectorTask()
                .request(req)
                .call();

            if (res.taskResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.GetConnectorTaskRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.GetConnectorTaskResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

getConnectorTaskV1

Get a specific task associated to the connector.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.GetConnectorTaskV1Request;
import com.formance.formance_sdk.models.operations.GetConnectorTaskV1Response;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            GetConnectorTaskV1Request req = GetConnectorTaskV1Request.builder()
                .connector(Connector.BANKING_CIRCLE)
                .connectorId("<value>")
                .taskId("<value>")
                .build();

            GetConnectorTaskV1Response res = sdk.payments().getConnectorTaskV1()
                .request(req)
                .call();

            if (res.taskResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.GetConnectorTaskV1Request	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.GetConnectorTaskV1Response>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

getPayment

Get a payment

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.GetPaymentRequest;
import com.formance.formance_sdk.models.operations.GetPaymentResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            GetPaymentRequest req = GetPaymentRequest.builder()
                .paymentId("<value>")
                .build();

            GetPaymentResponse res = sdk.payments().getPayment()
                .request(req)
                .call();

            if (res.paymentResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.GetPaymentRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.GetPaymentResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

getPool

Get a Pool

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.GetPoolRequest;
import com.formance.formance_sdk.models.operations.GetPoolResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            GetPoolRequest req = GetPoolRequest.builder()
                .poolId("<value>")
                .build();

            GetPoolResponse res = sdk.payments().getPool()
                .request(req)
                .call();

            if (res.poolResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.GetPoolRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.GetPoolResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

getPoolBalances

Get pool balances

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.GetPoolBalancesRequest;
import com.formance.formance_sdk.models.operations.GetPoolBalancesResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            GetPoolBalancesRequest req = GetPoolBalancesRequest.builder()
                .at(OffsetDateTime.parse("2023-05-05T06:40:23.018Z"))
                .poolId("<value>")
                .build();

            GetPoolBalancesResponse res = sdk.payments().getPoolBalances()
                .request(req)
                .call();

            if (res.poolBalancesResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.GetPoolBalancesRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.GetPoolBalancesResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

getTransferInitiation

Get a transfer initiation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.GetTransferInitiationRequest;
import com.formance.formance_sdk.models.operations.GetTransferInitiationResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            GetTransferInitiationRequest req = GetTransferInitiationRequest.builder()
                .transferId("<value>")
                .build();

            GetTransferInitiationResponse res = sdk.payments().getTransferInitiation()
                .request(req)
                .call();

            if (res.transferInitiationResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.GetTransferInitiationRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.GetTransferInitiationResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

installConnector

Install a connector by its name and config.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.InstallConnectorRequest;
import com.formance.formance_sdk.models.operations.InstallConnectorResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.AdyenConfig;
import com.formance.formance_sdk.models.shared.AtlarConfig;
import com.formance.formance_sdk.models.shared.BankingCircleConfig;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.CurrencyCloudConfig;
import com.formance.formance_sdk.models.shared.DummyPayConfig;
import com.formance.formance_sdk.models.shared.GenericConfig;
import com.formance.formance_sdk.models.shared.MangoPayConfig;
import com.formance.formance_sdk.models.shared.ModulrConfig;
import com.formance.formance_sdk.models.shared.MoneycorpConfig;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.StripeConfig;
import com.formance.formance_sdk.models.shared.WiseConfig;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            InstallConnectorRequest req = InstallConnectorRequest.builder()
                .connectorConfig(ConnectorConfig.of(StripeConfig.builder()
                            .apiKey("XXX")
                            .name("My Stripe Account")
                            .pageSize(50L)
                            .pollingPeriod("60s")
                            .build()))
                .connector(Connector.WISE)
                .build();

            InstallConnectorResponse res = sdk.payments().installConnector()
                .request(req)
                .call();

            if (res.connectorResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.InstallConnectorRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.InstallConnectorResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

listAllConnectors

List all installed connectors.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ListAllConnectorsResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ListAllConnectorsResponse res = sdk.payments().listAllConnectors()
                .call();

            if (res.connectorsResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Response

Optional<? extends com.formance.formance_sdk.models.operations.ListAllConnectorsResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

listBankAccounts

List all bank accounts created by user on Formance.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ListBankAccountsRequest;
import com.formance.formance_sdk.models.operations.ListBankAccountsResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ListBankAccountsRequest req = ListBankAccountsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(578999L)
                .sort(java.util.List.of(
                    "<value>"))
                .build();

            ListBankAccountsResponse res = sdk.payments().listBankAccounts()
                .request(req)
                .call();

            if (res.bankAccountsCursor().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ListBankAccountsRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ListBankAccountsResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

listConfigsAvailableConnectors

List the configs of each available connector.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ListConfigsAvailableConnectorsResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ListConfigsAvailableConnectorsResponse res = sdk.payments().listConfigsAvailableConnectors()
                .call();

            if (res.connectorsConfigsResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Response

Optional<? extends com.formance.formance_sdk.models.operations.ListConfigsAvailableConnectorsResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

listConnectorTasks

List all tasks associated with this connector.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ListConnectorTasksRequest;
import com.formance.formance_sdk.models.operations.ListConnectorTasksResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ListConnectorTasksRequest req = ListConnectorTasksRequest.builder()
                .connector(Connector.MODULR)
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(501686L)
                .build();

            ListConnectorTasksResponse res = sdk.payments().listConnectorTasks()
                .request(req)
                .call();

            if (res.tasksCursor().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ListConnectorTasksRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ListConnectorTasksResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

listConnectorTasksV1

List all tasks associated with this connector.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ListConnectorTasksV1Request;
import com.formance.formance_sdk.models.operations.ListConnectorTasksV1Response;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ListConnectorTasksV1Request req = ListConnectorTasksV1Request.builder()
                .connector(Connector.BANKING_CIRCLE)
                .connectorId("<value>")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(442673L)
                .build();

            ListConnectorTasksV1Response res = sdk.payments().listConnectorTasksV1()
                .request(req)
                .call();

            if (res.tasksCursor().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ListConnectorTasksV1Request	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ListConnectorTasksV1Response>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

listPayments

List payments

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ListPaymentsRequest;
import com.formance.formance_sdk.models.operations.ListPaymentsResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ListPaymentsRequest req = ListPaymentsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(13778L)
                .query("<value>")
                .sort(java.util.List.of(
                    "<value>"))
                .build();

            ListPaymentsResponse res = sdk.payments().listPayments()
                .request(req)
                .call();

            if (res.paymentsCursor().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ListPaymentsRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ListPaymentsResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

listPools

List Pools

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ListPoolsRequest;
import com.formance.formance_sdk.models.operations.ListPoolsResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ListPoolsRequest req = ListPoolsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(567687L)
                .query("<value>")
                .sort(java.util.List.of(
                    "<value>"))
                .build();

            ListPoolsResponse res = sdk.payments().listPools()
                .request(req)
                .call();

            if (res.poolsCursor().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ListPoolsRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ListPoolsResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

listTransferInitiations

List Transfer Initiations

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ListTransferInitiationsRequest;
import com.formance.formance_sdk.models.operations.ListTransferInitiationsResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ListTransferInitiationsRequest req = ListTransferInitiationsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(706689L)
                .query("<value>")
                .sort(java.util.List.of(
                    "<value>"))
                .build();

            ListTransferInitiationsResponse res = sdk.payments().listTransferInitiations()
                .request(req)
                .call();

            if (res.transferInitiationsCursor().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ListTransferInitiationsRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ListTransferInitiationsResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

paymentsgetAccount

Get an account

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.PaymentsgetAccountRequest;
import com.formance.formance_sdk.models.operations.PaymentsgetAccountResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            PaymentsgetAccountRequest req = PaymentsgetAccountRequest.builder()
                .accountId("<value>")
                .build();

            PaymentsgetAccountResponse res = sdk.payments().paymentsgetAccount()
                .request(req)
                .call();

            if (res.paymentsAccountResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.PaymentsgetAccountRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.PaymentsgetAccountResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

paymentsgetServerInfo

Get server info

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.PaymentsgetServerInfoResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            PaymentsgetServerInfoResponse res = sdk.payments().paymentsgetServerInfo()
                .call();

            if (res.serverInfo().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Response

Optional<? extends com.formance.formance_sdk.models.operations.PaymentsgetServerInfoResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

paymentslistAccounts

List accounts

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.PaymentslistAccountsRequest;
import com.formance.formance_sdk.models.operations.PaymentslistAccountsResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            PaymentslistAccountsRequest req = PaymentslistAccountsRequest.builder()
                .requestBody(java.util.Map.ofEntries(
                    entry("key", "<value>")))
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(227071L)
                .sort(java.util.List.of(
                    "<value>"))
                .build();

            PaymentslistAccountsResponse res = sdk.payments().paymentslistAccounts()
                .request(req)
                .call();

            if (res.accountsCursor().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.PaymentslistAccountsRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.PaymentslistAccountsResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

readConnectorConfig

Read connector config

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ReadConnectorConfigRequest;
import com.formance.formance_sdk.models.operations.ReadConnectorConfigResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ReadConnectorConfigRequest req = ReadConnectorConfigRequest.builder()
                .connector(Connector.GENERIC)
                .build();

            ReadConnectorConfigResponse res = sdk.payments().readConnectorConfig()
                .request(req)
                .call();

            if (res.connectorConfigResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ReadConnectorConfigRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ReadConnectorConfigResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

readConnectorConfigV1

Read connector config

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ReadConnectorConfigV1Request;
import com.formance.formance_sdk.models.operations.ReadConnectorConfigV1Response;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ReadConnectorConfigV1Request req = ReadConnectorConfigV1Request.builder()
                .connector(Connector.CURRENCY_CLOUD)
                .connectorId("<value>")
                .build();

            ReadConnectorConfigV1Response res = sdk.payments().readConnectorConfigV1()
                .request(req)
                .call();

            if (res.connectorConfigResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ReadConnectorConfigV1Request	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ReadConnectorConfigV1Response>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

removeAccountFromPool

Remove an account from a pool by its id.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.RemoveAccountFromPoolRequest;
import com.formance.formance_sdk.models.operations.RemoveAccountFromPoolResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            RemoveAccountFromPoolRequest req = RemoveAccountFromPoolRequest.builder()
                .accountId("<value>")
                .poolId("<value>")
                .build();

            RemoveAccountFromPoolResponse res = sdk.payments().removeAccountFromPool()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.RemoveAccountFromPoolRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.RemoveAccountFromPoolResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

resetConnector

Reset a connector by its name. It will remove the connector and ALL PAYMENTS generated with it.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ResetConnectorRequest;
import com.formance.formance_sdk.models.operations.ResetConnectorResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ResetConnectorRequest req = ResetConnectorRequest.builder()
                .connector(Connector.ATLAR)
                .build();

            ResetConnectorResponse res = sdk.payments().resetConnector()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ResetConnectorRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ResetConnectorResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

resetConnectorV1

Reset a connector by its name. It will remove the connector and ALL PAYMENTS generated with it.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ResetConnectorV1Request;
import com.formance.formance_sdk.models.operations.ResetConnectorV1Response;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ResetConnectorV1Request req = ResetConnectorV1Request.builder()
                .connector(Connector.GENERIC)
                .connectorId("<value>")
                .build();

            ResetConnectorV1Response res = sdk.payments().resetConnectorV1()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ResetConnectorV1Request	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ResetConnectorV1Response>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

retryTransferInitiation

Retry a failed transfer initiation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.RetryTransferInitiationRequest;
import com.formance.formance_sdk.models.operations.RetryTransferInitiationResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            RetryTransferInitiationRequest req = RetryTransferInitiationRequest.builder()
                .transferId("<value>")
                .build();

            RetryTransferInitiationResponse res = sdk.payments().retryTransferInitiation()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.RetryTransferInitiationRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.RetryTransferInitiationResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

reverseTransferInitiation

Reverse transfer initiation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ReverseTransferInitiationRequest;
import com.formance.formance_sdk.models.operations.ReverseTransferInitiationResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.ReverseTransferInitiationRequest;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ReverseTransferInitiationRequest req = ReverseTransferInitiationRequest.builder()
                .reverseTransferInitiationRequest(ReverseTransferInitiationRequest.builder()
                        .amount(new BigInteger("327549"))
                        .asset("USD")
                        .description("<value>")
                        .metadata(java.util.Map.ofEntries(
                                entry("key", "<value>")))
                        .reference("XXX")
                        .build())
                .transferId("<value>")
                .build();

            ReverseTransferInitiationResponse res = sdk.payments().reverseTransferInitiation()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.ReverseTransferInitiationRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ReverseTransferInitiationResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

udpateTransferInitiationStatus

Update a transfer initiation status

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.UdpateTransferInitiationStatusRequest;
import com.formance.formance_sdk.models.operations.UdpateTransferInitiationStatusResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.Status;
import com.formance.formance_sdk.models.shared.UpdateTransferInitiationStatusRequest;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            UdpateTransferInitiationStatusRequest req = UdpateTransferInitiationStatusRequest.builder()
                .updateTransferInitiationStatusRequest(UpdateTransferInitiationStatusRequest.builder()
                        .status(Status.VALIDATED)
                        .build())
                .transferId("<value>")
                .build();

            UdpateTransferInitiationStatusResponse res = sdk.payments().udpateTransferInitiationStatus()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.UdpateTransferInitiationStatusRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.UdpateTransferInitiationStatusResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

uninstallConnector

Uninstall a connector by its name.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.UninstallConnectorRequest;
import com.formance.formance_sdk.models.operations.UninstallConnectorResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            UninstallConnectorRequest req = UninstallConnectorRequest.builder()
                .connector(Connector.MODULR)
                .build();

            UninstallConnectorResponse res = sdk.payments().uninstallConnector()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.UninstallConnectorRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.UninstallConnectorResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

uninstallConnectorV1

Uninstall a connector by its name.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.UninstallConnectorV1Request;
import com.formance.formance_sdk.models.operations.UninstallConnectorV1Response;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            UninstallConnectorV1Request req = UninstallConnectorV1Request.builder()
                .connector(Connector.GENERIC)
                .connectorId("<value>")
                .build();

            UninstallConnectorV1Response res = sdk.payments().uninstallConnectorV1()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.UninstallConnectorV1Request	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.UninstallConnectorV1Response>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

updateBankAccountMetadata

Update metadata of a bank account

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.UpdateBankAccountMetadataRequest;
import com.formance.formance_sdk.models.operations.UpdateBankAccountMetadataResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.UpdateBankAccountMetadataRequest;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            UpdateBankAccountMetadataRequest req = UpdateBankAccountMetadataRequest.builder()
                .updateBankAccountMetadataRequest(UpdateBankAccountMetadataRequest.builder()
                        .metadata(java.util.Map.ofEntries(
                                entry("key", "<value>")))
                        .build())
                .bankAccountId("<value>")
                .build();

            UpdateBankAccountMetadataResponse res = sdk.payments().updateBankAccountMetadata()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.UpdateBankAccountMetadataRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.UpdateBankAccountMetadataResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

updateConnectorConfigV1

Update connector config

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.UpdateConnectorConfigV1Request;
import com.formance.formance_sdk.models.operations.UpdateConnectorConfigV1Response;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.AdyenConfig;
import com.formance.formance_sdk.models.shared.AtlarConfig;
import com.formance.formance_sdk.models.shared.BankingCircleConfig;
import com.formance.formance_sdk.models.shared.Connector;
import com.formance.formance_sdk.models.shared.CurrencyCloudConfig;
import com.formance.formance_sdk.models.shared.DummyPayConfig;
import com.formance.formance_sdk.models.shared.GenericConfig;
import com.formance.formance_sdk.models.shared.MangoPayConfig;
import com.formance.formance_sdk.models.shared.ModulrConfig;
import com.formance.formance_sdk.models.shared.MoneycorpConfig;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.StripeConfig;
import com.formance.formance_sdk.models.shared.WiseConfig;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            UpdateConnectorConfigV1Request req = UpdateConnectorConfigV1Request.builder()
                .connectorConfig(ConnectorConfig.of(StripeConfig.builder()
                            .apiKey("XXX")
                            .name("My Stripe Account")
                            .pageSize(50L)
                            .pollingPeriod("60s")
                            .build()))
                .connector(Connector.STRIPE)
                .connectorId("<value>")
                .build();

            UpdateConnectorConfigV1Response res = sdk.payments().updateConnectorConfigV1()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.UpdateConnectorConfigV1Request	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.UpdateConnectorConfigV1Response>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

updateMetadata

Update metadata

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.UpdateMetadataRequest;
import com.formance.formance_sdk.models.operations.UpdateMetadataResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            UpdateMetadataRequest req = UpdateMetadataRequest.builder()
                .requestBody(java.util.Map.ofEntries(
                        entry("key", "<value>")))
                .paymentId("<value>")
                .build();

            UpdateMetadataResponse res = sdk.payments().updateMetadata()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	com.formance.formance_sdk.models.operations.UpdateMetadataRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.UpdateMetadataResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/