Payments.V3

Overview

Available Operations

addAccountToPool - Add an account to a pool
addBankAccountToPaymentServiceUser - Add a bank account to a payment service user
approvePaymentInitiation - Approve a payment initiation
createAccount - Create a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes.
createBankAccount - Create a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.
createLinkForPaymentServiceUser - Create an authentication link for a payment service user on a connector, for oauth flow
createPayment - Create a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.
createPaymentServiceUser - Create a formance payment service user object
createPool - Create a formance pool object
deletePaymentInitiation - Delete a payment initiation by ID
deletePaymentServiceUser - Delete a payment service user by ID
deletePaymentServiceUserConnectionFromConnectorID - Delete a connection for a payment service user on a connector
deletePaymentServiceUserConnector - Remove a payment service user from a connector, the PSU will still exist in Formance
deletePool - Delete a pool by ID
forwardBankAccount - Forward a Bank Account to a PSP for creation
forwardPaymentServiceUserBankAccount - Forward a payment service user's bank account to a connector
forwardPaymentServiceUserToProvider - Register/forward a payment service user on/to a connector
getAccount - Get an account by ID
getAccountBalances - Get account balances
getBankAccount - Get a Bank Account by ID
getConnectorConfig - Get a connector configuration by ID
getConnectorSchedule - Get a connector schedule by ID
getPayment - Get a payment by ID
getPaymentInitiation - Get a payment initiation by ID
getPaymentServiceUser - Get a payment service user by ID
getPaymentServiceUserLinkAttemptFromConnectorID - Get a link attempt for a payment service user on a connector
getPool - Get a pool by ID
getPoolBalances - Get historical pool balances from a particular point in time
getPoolBalancesLatest - Get latest pool balances
getTask - Get a task and its result by ID
initiatePayment - Initiate a payment
installConnector - Install a connector
listAccounts - List all accounts
listBankAccounts - List all bank accounts
listConnectorConfigs - List all connector configurations
listConnectorScheduleInstances - List all connector schedule instances
listConnectorSchedules - List all connector schedules
listConnectors - List all connectors
listPaymentInitiationAdjustments - List all payment initiation adjustments
listPaymentInitiationRelatedPayments - List all payments related to a payment initiation
listPaymentInitiations - List all payment initiations
listPaymentServiceUserConnections - List all connections for a payment service user
listPaymentServiceUserConnectionsFromConnectorID - List enabled connections for a payment service user on a connector (i.e. the various banks PSUser has enabled on the connector)
listPaymentServiceUserLinkAttemptsFromConnectorID - List all link attempts for a payment service user on a connector. Allows to check if users used the link and completed the oauth flow.
listPaymentServiceUsers - List all payment service users
listPayments - List all payments
listPools - List all pools
rejectPaymentInitiation - Reject a payment initiation
removeAccountFromPool - Remove an account from a pool
resetConnector - Reset a connector. Be aware that this will delete all data and stop all existing tasks like payment initiations and bank account creations.
retryPaymentInitiation - Retry a payment initiation
reversePaymentInitiation - Reverse a payment initiation
uninstallConnector - Uninstall a connector
updateBankAccountMetadata - Update a bank account's metadata
updateLinkForPaymentServiceUserOnConnector - Update/Regenerate a link for a payment service user on a connector
updatePaymentMetadata - Update a payment's metadata
updatePoolQuery - Update the query of a pool
v3UpdateConnectorConfig - Update the config of a connector

addAccountToPool

Add an account to a pool

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3AddAccountToPoolRequest;
import com.formance.formance_sdk.models.operations.V3AddAccountToPoolResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3AddAccountToPoolRequest req = V3AddAccountToPoolRequest.builder()
                .accountID("<id>")
                .poolID("<id>")
                .build();

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

        // handle response
    }
}

Parameters

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

Response

V3AddAccountToPoolResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

addBankAccountToPaymentServiceUser

Add a bank account to a payment service user

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3AddBankAccountToPaymentServiceUserRequest;
import com.formance.formance_sdk.models.operations.V3AddBankAccountToPaymentServiceUserResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3AddBankAccountToPaymentServiceUserRequest req = V3AddBankAccountToPaymentServiceUserRequest.builder()
                .bankAccountID("<id>")
                .paymentServiceUserID("<id>")
                .build();

        V3AddBankAccountToPaymentServiceUserResponse res = sdk.payments().v3().addBankAccountToPaymentServiceUser()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V3AddBankAccountToPaymentServiceUserResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

approvePaymentInitiation

Approve a payment initiation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ApprovePaymentInitiationRequest;
import com.formance.formance_sdk.models.operations.V3ApprovePaymentInitiationResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ApprovePaymentInitiationRequest req = V3ApprovePaymentInitiationRequest.builder()
                .paymentInitiationID("<id>")
                .build();

        V3ApprovePaymentInitiationResponse res = sdk.payments().v3().approvePaymentInitiation()
                .request(req)
                .call();

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

Parameters

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

Response

V3ApprovePaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

createAccount

Create a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3CreateAccountResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3CreateAccountResponse res = sdk.payments().v3().createAccount()
                .call();

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

Parameters

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

Response

V3CreateAccountResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

createBankAccount

Create a formance bank account object. This object will not be forwarded to the connector until you called the forwardBankAccount method.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3CreateBankAccountResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3CreateBankAccountResponse res = sdk.payments().v3().createBankAccount()
                .call();

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

Parameters

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

Response

V3CreateBankAccountResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

createLinkForPaymentServiceUser

Create an authentication link for a payment service user on a connector, for oauth flow

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3CreateLinkForPaymentServiceUserRequest;
import com.formance.formance_sdk.models.operations.V3CreateLinkForPaymentServiceUserResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3CreateLinkForPaymentServiceUserRequest req = V3CreateLinkForPaymentServiceUserRequest.builder()
                .connectorID("<id>")
                .paymentServiceUserID("<id>")
                .build();

        V3CreateLinkForPaymentServiceUserResponse res = sdk.payments().v3().createLinkForPaymentServiceUser()
                .request(req)
                .call();

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

Parameters

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

Response

V3CreateLinkForPaymentServiceUserResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

createPayment

Create a formance payment object. This object will not be forwarded to the connector. It is only used for internal purposes.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3CreatePaymentResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3CreatePaymentResponse res = sdk.payments().v3().createPayment()
                .call();

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

Parameters

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

Response

V3CreatePaymentResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

createPaymentServiceUser

Create a formance payment service user object

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3CreatePaymentServiceUserResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3CreatePaymentServiceUserResponse res = sdk.payments().v3().createPaymentServiceUser()
                .call();

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

Parameters

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

Response

V3CreatePaymentServiceUserResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

createPool

Create a formance pool object

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3CreatePoolResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3CreatePoolResponse res = sdk.payments().v3().createPool()
                .call();

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

Parameters

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

Response

V3CreatePoolResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

deletePaymentInitiation

Delete a payment initiation by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3DeletePaymentInitiationRequest;
import com.formance.formance_sdk.models.operations.V3DeletePaymentInitiationResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3DeletePaymentInitiationRequest req = V3DeletePaymentInitiationRequest.builder()
                .paymentInitiationID("<id>")
                .build();

        V3DeletePaymentInitiationResponse res = sdk.payments().v3().deletePaymentInitiation()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V3DeletePaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

deletePaymentServiceUser

Delete a payment service user by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3DeletePaymentServiceUserRequest;
import com.formance.formance_sdk.models.operations.V3DeletePaymentServiceUserResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3DeletePaymentServiceUserRequest req = V3DeletePaymentServiceUserRequest.builder()
                .paymentServiceUserID("<id>")
                .build();

        V3DeletePaymentServiceUserResponse res = sdk.payments().v3().deletePaymentServiceUser()
                .request(req)
                .call();

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

Parameters

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

Response

V3DeletePaymentServiceUserResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

deletePaymentServiceUserConnectionFromConnectorID

Delete a connection for a payment service user on a connector

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3DeletePaymentServiceUserConnectionFromConnectorIDRequest;
import com.formance.formance_sdk.models.operations.V3DeletePaymentServiceUserConnectionFromConnectorIDResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3DeletePaymentServiceUserConnectionFromConnectorIDRequest req = V3DeletePaymentServiceUserConnectionFromConnectorIDRequest.builder()
                .connectionID("<id>")
                .connectorID("<id>")
                .paymentServiceUserID("<id>")
                .build();

        V3DeletePaymentServiceUserConnectionFromConnectorIDResponse res = sdk.payments().v3().deletePaymentServiceUserConnectionFromConnectorID()
                .request(req)
                .call();

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

Parameters

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

Response

V3DeletePaymentServiceUserConnectionFromConnectorIDResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

deletePaymentServiceUserConnector

Remove a payment service user from a connector, the PSU will still exist in Formance

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3DeletePaymentServiceUserConnectorRequest;
import com.formance.formance_sdk.models.operations.V3DeletePaymentServiceUserConnectorResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3DeletePaymentServiceUserConnectorRequest req = V3DeletePaymentServiceUserConnectorRequest.builder()
                .connectorID("<id>")
                .paymentServiceUserID("<id>")
                .build();

        V3DeletePaymentServiceUserConnectorResponse res = sdk.payments().v3().deletePaymentServiceUserConnector()
                .request(req)
                .call();

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

Parameters

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

Response

V3DeletePaymentServiceUserConnectorResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

deletePool

Delete a pool by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3DeletePoolRequest;
import com.formance.formance_sdk.models.operations.V3DeletePoolResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3DeletePoolRequest req = V3DeletePoolRequest.builder()
                .poolID("<id>")
                .build();

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

        // handle response
    }
}

Parameters

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

Response

V3DeletePoolResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

forwardBankAccount

Forward a Bank Account to a PSP for creation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ForwardBankAccountRequest;
import com.formance.formance_sdk.models.operations.V3ForwardBankAccountResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ForwardBankAccountRequest req = V3ForwardBankAccountRequest.builder()
                .bankAccountID("<id>")
                .build();

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

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

Parameters

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

Response

V3ForwardBankAccountResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

forwardPaymentServiceUserBankAccount

Forward a payment service user's bank account to a connector

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ForwardPaymentServiceUserBankAccountRequest;
import com.formance.formance_sdk.models.operations.V3ForwardPaymentServiceUserBankAccountResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ForwardPaymentServiceUserBankAccountRequest req = V3ForwardPaymentServiceUserBankAccountRequest.builder()
                .bankAccountID("<id>")
                .paymentServiceUserID("<id>")
                .build();

        V3ForwardPaymentServiceUserBankAccountResponse res = sdk.payments().v3().forwardPaymentServiceUserBankAccount()
                .request(req)
                .call();

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

Parameters

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

Response

V3ForwardPaymentServiceUserBankAccountResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

forwardPaymentServiceUserToProvider

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ForwardPaymentServiceUserToProviderRequest;
import com.formance.formance_sdk.models.operations.V3ForwardPaymentServiceUserToProviderResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ForwardPaymentServiceUserToProviderRequest req = V3ForwardPaymentServiceUserToProviderRequest.builder()
                .connectorID("<id>")
                .paymentServiceUserID("<id>")
                .build();

        V3ForwardPaymentServiceUserToProviderResponse res = sdk.payments().v3().forwardPaymentServiceUserToProvider()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V3ForwardPaymentServiceUserToProviderResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getAccount

Get an account by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetAccountRequest;
import com.formance.formance_sdk.models.operations.V3GetAccountResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetAccountRequest req = V3GetAccountRequest.builder()
                .accountID("<id>")
                .build();

        V3GetAccountResponse res = sdk.payments().v3().getAccount()
                .request(req)
                .call();

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

Parameters

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

Response

V3GetAccountResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
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.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetAccountBalancesRequest;
import com.formance.formance_sdk.models.operations.V3GetAccountBalancesResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetAccountBalancesRequest req = V3GetAccountBalancesRequest.builder()
                .accountID("<id>")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

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

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

Parameters

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

Response

V3GetAccountBalancesResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getBankAccount

Get a Bank Account by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetBankAccountRequest;
import com.formance.formance_sdk.models.operations.V3GetBankAccountResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetBankAccountRequest req = V3GetBankAccountRequest.builder()
                .bankAccountID("<id>")
                .build();

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

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

Parameters

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

Response

V3GetBankAccountResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getConnectorConfig

Get a connector configuration by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetConnectorConfigRequest;
import com.formance.formance_sdk.models.operations.V3GetConnectorConfigResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetConnectorConfigRequest req = V3GetConnectorConfigRequest.builder()
                .connectorID("<id>")
                .build();

        V3GetConnectorConfigResponse res = sdk.payments().v3().getConnectorConfig()
                .request(req)
                .call();

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

Parameters

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

Response

V3GetConnectorConfigResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getConnectorSchedule

Get a connector schedule by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetConnectorScheduleRequest;
import com.formance.formance_sdk.models.operations.V3GetConnectorScheduleResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetConnectorScheduleRequest req = V3GetConnectorScheduleRequest.builder()
                .connectorID("<id>")
                .scheduleID("<id>")
                .build();

        V3GetConnectorScheduleResponse res = sdk.payments().v3().getConnectorSchedule()
                .request(req)
                .call();

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

Parameters

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

Response

V3GetConnectorScheduleResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getPayment

Get a payment by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetPaymentRequest;
import com.formance.formance_sdk.models.operations.V3GetPaymentResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetPaymentRequest req = V3GetPaymentRequest.builder()
                .paymentID("<id>")
                .build();

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

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

Parameters

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

Response

V3GetPaymentResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getPaymentInitiation

Get a payment initiation by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetPaymentInitiationRequest;
import com.formance.formance_sdk.models.operations.V3GetPaymentInitiationResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetPaymentInitiationRequest req = V3GetPaymentInitiationRequest.builder()
                .paymentInitiationID("<id>")
                .build();

        V3GetPaymentInitiationResponse res = sdk.payments().v3().getPaymentInitiation()
                .request(req)
                .call();

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

Parameters

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

Response

V3GetPaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getPaymentServiceUser

Get a payment service user by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetPaymentServiceUserRequest;
import com.formance.formance_sdk.models.operations.V3GetPaymentServiceUserResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetPaymentServiceUserRequest req = V3GetPaymentServiceUserRequest.builder()
                .paymentServiceUserID("<id>")
                .build();

        V3GetPaymentServiceUserResponse res = sdk.payments().v3().getPaymentServiceUser()
                .request(req)
                .call();

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

Parameters

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

Response

V3GetPaymentServiceUserResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getPaymentServiceUserLinkAttemptFromConnectorID

Get a link attempt for a payment service user on a connector

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetPaymentServiceUserLinkAttemptFromConnectorIDRequest;
import com.formance.formance_sdk.models.operations.V3GetPaymentServiceUserLinkAttemptFromConnectorIDResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetPaymentServiceUserLinkAttemptFromConnectorIDRequest req = V3GetPaymentServiceUserLinkAttemptFromConnectorIDRequest.builder()
                .attemptID("<id>")
                .connectorID("<id>")
                .paymentServiceUserID("<id>")
                .build();

        V3GetPaymentServiceUserLinkAttemptFromConnectorIDResponse res = sdk.payments().v3().getPaymentServiceUserLinkAttemptFromConnectorID()
                .request(req)
                .call();

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

Parameters

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

Response

V3GetPaymentServiceUserLinkAttemptFromConnectorIDResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getPool

Get a pool by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetPoolRequest;
import com.formance.formance_sdk.models.operations.V3GetPoolResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetPoolRequest req = V3GetPoolRequest.builder()
                .poolID("<id>")
                .build();

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

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

Parameters

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

Response

V3GetPoolResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getPoolBalances

Get historical pool balances from a particular point in time

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetPoolBalancesRequest;
import com.formance.formance_sdk.models.operations.V3GetPoolBalancesResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetPoolBalancesRequest req = V3GetPoolBalancesRequest.builder()
                .poolID("<id>")
                .build();

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

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

Parameters

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

Response

V3GetPoolBalancesResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getPoolBalancesLatest

Get latest pool balances

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetPoolBalancesLatestRequest;
import com.formance.formance_sdk.models.operations.V3GetPoolBalancesLatestResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetPoolBalancesLatestRequest req = V3GetPoolBalancesLatestRequest.builder()
                .poolID("<id>")
                .build();

        V3GetPoolBalancesLatestResponse res = sdk.payments().v3().getPoolBalancesLatest()
                .request(req)
                .call();

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

Parameters

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

Response

V3GetPoolBalancesLatestResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

getTask

Get a task and its result by ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3GetTaskRequest;
import com.formance.formance_sdk.models.operations.V3GetTaskResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3GetTaskRequest req = V3GetTaskRequest.builder()
                .taskID("<id>")
                .build();

        V3GetTaskResponse res = sdk.payments().v3().getTask()
                .request(req)
                .call();

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

Parameters

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

Response

V3GetTaskResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

initiatePayment

Initiate a payment

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3InitiatePaymentRequest;
import com.formance.formance_sdk.models.operations.V3InitiatePaymentResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3InitiatePaymentRequest req = V3InitiatePaymentRequest.builder()
                .build();

        V3InitiatePaymentResponse res = sdk.payments().v3().initiatePayment()
                .request(req)
                .call();

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

Parameters

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

Response

V3InitiatePaymentResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

installConnector

Install a connector

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3InstallConnectorRequest;
import com.formance.formance_sdk.models.operations.V3InstallConnectorResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3InstallConnectorRequest req = V3InstallConnectorRequest.builder()
                .connector("<value>")
                .build();

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

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

Parameters

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

Response

V3InstallConnectorResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listAccounts

List all accounts

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListAccountsRequest;
import com.formance.formance_sdk.models.operations.V3ListAccountsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListAccountsRequest req = V3ListAccountsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListAccountsResponse res = sdk.payments().v3().listAccounts()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListAccountsResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listBankAccounts

List all bank accounts

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListBankAccountsRequest;
import com.formance.formance_sdk.models.operations.V3ListBankAccountsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListBankAccountsRequest req = V3ListBankAccountsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

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

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

Parameters

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

Response

V3ListBankAccountsResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listConnectorConfigs

List all connector configurations

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListConnectorConfigsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListConnectorConfigsResponse res = sdk.payments().v3().listConnectorConfigs()
                .call();

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

Response

V3ListConnectorConfigsResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listConnectorScheduleInstances

List all connector schedule instances

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListConnectorScheduleInstancesRequest;
import com.formance.formance_sdk.models.operations.V3ListConnectorScheduleInstancesResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListConnectorScheduleInstancesRequest req = V3ListConnectorScheduleInstancesRequest.builder()
                .connectorID("<id>")
                .scheduleID("<id>")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListConnectorScheduleInstancesResponse res = sdk.payments().v3().listConnectorScheduleInstances()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListConnectorScheduleInstancesResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listConnectorSchedules

List all connector schedules

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListConnectorSchedulesRequest;
import com.formance.formance_sdk.models.operations.V3ListConnectorSchedulesResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListConnectorSchedulesRequest req = V3ListConnectorSchedulesRequest.builder()
                .connectorID("<id>")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListConnectorSchedulesResponse res = sdk.payments().v3().listConnectorSchedules()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListConnectorSchedulesResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listConnectors

List all connectors

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListConnectorsRequest;
import com.formance.formance_sdk.models.operations.V3ListConnectorsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListConnectorsRequest req = V3ListConnectorsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListConnectorsResponse res = sdk.payments().v3().listConnectors()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListConnectorsResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listPaymentInitiationAdjustments

List all payment initiation adjustments

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListPaymentInitiationAdjustmentsRequest;
import com.formance.formance_sdk.models.operations.V3ListPaymentInitiationAdjustmentsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListPaymentInitiationAdjustmentsRequest req = V3ListPaymentInitiationAdjustmentsRequest.builder()
                .paymentInitiationID("<id>")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListPaymentInitiationAdjustmentsResponse res = sdk.payments().v3().listPaymentInitiationAdjustments()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListPaymentInitiationAdjustmentsResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listPaymentInitiationRelatedPayments

List all payments related to a payment initiation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListPaymentInitiationRelatedPaymentsRequest;
import com.formance.formance_sdk.models.operations.V3ListPaymentInitiationRelatedPaymentsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListPaymentInitiationRelatedPaymentsRequest req = V3ListPaymentInitiationRelatedPaymentsRequest.builder()
                .paymentInitiationID("<id>")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListPaymentInitiationRelatedPaymentsResponse res = sdk.payments().v3().listPaymentInitiationRelatedPayments()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListPaymentInitiationRelatedPaymentsResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listPaymentInitiations

List all payment initiations

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListPaymentInitiationsRequest;
import com.formance.formance_sdk.models.operations.V3ListPaymentInitiationsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListPaymentInitiationsRequest req = V3ListPaymentInitiationsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListPaymentInitiationsResponse res = sdk.payments().v3().listPaymentInitiations()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListPaymentInitiationsResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listPaymentServiceUserConnections

List all connections for a payment service user

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListPaymentServiceUserConnectionsRequest;
import com.formance.formance_sdk.models.operations.V3ListPaymentServiceUserConnectionsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListPaymentServiceUserConnectionsRequest req = V3ListPaymentServiceUserConnectionsRequest.builder()
                .paymentServiceUserID("<id>")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListPaymentServiceUserConnectionsResponse res = sdk.payments().v3().listPaymentServiceUserConnections()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListPaymentServiceUserConnectionsResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listPaymentServiceUserConnectionsFromConnectorID

List enabled connections for a payment service user on a connector (i.e. the various banks PSUser has enabled on the connector)

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListPaymentServiceUserConnectionsFromConnectorIDRequest;
import com.formance.formance_sdk.models.operations.V3ListPaymentServiceUserConnectionsFromConnectorIDResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListPaymentServiceUserConnectionsFromConnectorIDRequest req = V3ListPaymentServiceUserConnectionsFromConnectorIDRequest.builder()
                .connectorID("<id>")
                .paymentServiceUserID("<id>")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListPaymentServiceUserConnectionsFromConnectorIDResponse res = sdk.payments().v3().listPaymentServiceUserConnectionsFromConnectorID()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListPaymentServiceUserConnectionsFromConnectorIDResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listPaymentServiceUserLinkAttemptsFromConnectorID

List all link attempts for a payment service user on a connector. Allows to check if users used the link and completed the oauth flow.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListPaymentServiceUserLinkAttemptsFromConnectorIDRequest;
import com.formance.formance_sdk.models.operations.V3ListPaymentServiceUserLinkAttemptsFromConnectorIDResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListPaymentServiceUserLinkAttemptsFromConnectorIDRequest req = V3ListPaymentServiceUserLinkAttemptsFromConnectorIDRequest.builder()
                .connectorID("<id>")
                .paymentServiceUserID("<id>")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListPaymentServiceUserLinkAttemptsFromConnectorIDResponse res = sdk.payments().v3().listPaymentServiceUserLinkAttemptsFromConnectorID()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListPaymentServiceUserLinkAttemptsFromConnectorIDResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listPaymentServiceUsers

List all payment service users

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListPaymentServiceUsersRequest;
import com.formance.formance_sdk.models.operations.V3ListPaymentServiceUsersResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListPaymentServiceUsersRequest req = V3ListPaymentServiceUsersRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        V3ListPaymentServiceUsersResponse res = sdk.payments().v3().listPaymentServiceUsers()
                .request(req)
                .call();

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

Parameters

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

Response

V3ListPaymentServiceUsersResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listPayments

List all payments

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListPaymentsRequest;
import com.formance.formance_sdk.models.operations.V3ListPaymentsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListPaymentsRequest req = V3ListPaymentsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

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

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

Parameters

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

Response

V3ListPaymentsResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

listPools

List all pools

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ListPoolsRequest;
import com.formance.formance_sdk.models.operations.V3ListPoolsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ListPoolsRequest req = V3ListPoolsRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

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

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

Parameters

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

Response

V3ListPoolsResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

rejectPaymentInitiation

Reject a payment initiation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3RejectPaymentInitiationRequest;
import com.formance.formance_sdk.models.operations.V3RejectPaymentInitiationResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3RejectPaymentInitiationRequest req = V3RejectPaymentInitiationRequest.builder()
                .paymentInitiationID("<id>")
                .build();

        V3RejectPaymentInitiationResponse res = sdk.payments().v3().rejectPaymentInitiation()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V3RejectPaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

removeAccountFromPool

Remove an account from a pool

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3RemoveAccountFromPoolRequest;
import com.formance.formance_sdk.models.operations.V3RemoveAccountFromPoolResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3RemoveAccountFromPoolRequest req = V3RemoveAccountFromPoolRequest.builder()
                .accountID("<id>")
                .poolID("<id>")
                .build();

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

        // handle response
    }
}

Parameters

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

Response

V3RemoveAccountFromPoolResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

resetConnector

Reset a connector. Be aware that this will delete all data and stop all existing tasks like payment initiations and bank account creations.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ResetConnectorRequest;
import com.formance.formance_sdk.models.operations.V3ResetConnectorResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ResetConnectorRequest req = V3ResetConnectorRequest.builder()
                .connectorID("<id>")
                .build();

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

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

Parameters

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

Response

V3ResetConnectorResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

retryPaymentInitiation

Retry a payment initiation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3RetryPaymentInitiationRequest;
import com.formance.formance_sdk.models.operations.V3RetryPaymentInitiationResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3RetryPaymentInitiationRequest req = V3RetryPaymentInitiationRequest.builder()
                .paymentInitiationID("<id>")
                .build();

        V3RetryPaymentInitiationResponse res = sdk.payments().v3().retryPaymentInitiation()
                .request(req)
                .call();

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

Parameters

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

Response

V3RetryPaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

reversePaymentInitiation

Reverse a payment initiation

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3ReversePaymentInitiationRequest;
import com.formance.formance_sdk.models.operations.V3ReversePaymentInitiationResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3ReversePaymentInitiationRequest req = V3ReversePaymentInitiationRequest.builder()
                .paymentInitiationID("<id>")
                .build();

        V3ReversePaymentInitiationResponse res = sdk.payments().v3().reversePaymentInitiation()
                .request(req)
                .call();

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

Parameters

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

Response

V3ReversePaymentInitiationResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

uninstallConnector

Uninstall a connector

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3UninstallConnectorRequest;
import com.formance.formance_sdk.models.operations.V3UninstallConnectorResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3UninstallConnectorRequest req = V3UninstallConnectorRequest.builder()
                .connectorID("<id>")
                .build();

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

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

Parameters

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

Response

V3UninstallConnectorResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

updateBankAccountMetadata

Update a bank account's metadata

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3UpdateBankAccountMetadataRequest;
import com.formance.formance_sdk.models.operations.V3UpdateBankAccountMetadataResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3UpdateBankAccountMetadataRequest req = V3UpdateBankAccountMetadataRequest.builder()
                .bankAccountID("<id>")
                .build();

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

        // handle response
    }
}

Parameters

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

Response

V3UpdateBankAccountMetadataResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

updateLinkForPaymentServiceUserOnConnector

Update/Regenerate a link for a payment service user on a connector

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3UpdateLinkForPaymentServiceUserOnConnectorRequest;
import com.formance.formance_sdk.models.operations.V3UpdateLinkForPaymentServiceUserOnConnectorResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3UpdateLinkForPaymentServiceUserOnConnectorRequest req = V3UpdateLinkForPaymentServiceUserOnConnectorRequest.builder()
                .connectionID("<id>")
                .connectorID("<id>")
                .paymentServiceUserID("<id>")
                .build();

        V3UpdateLinkForPaymentServiceUserOnConnectorResponse res = sdk.payments().v3().updateLinkForPaymentServiceUserOnConnector()
                .request(req)
                .call();

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

Parameters

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

Response

V3UpdateLinkForPaymentServiceUserOnConnectorResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

updatePaymentMetadata

Update a payment's metadata

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3UpdatePaymentMetadataRequest;
import com.formance.formance_sdk.models.operations.V3UpdatePaymentMetadataResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3UpdatePaymentMetadataRequest req = V3UpdatePaymentMetadataRequest.builder()
                .paymentID("<id>")
                .build();

        V3UpdatePaymentMetadataResponse res = sdk.payments().v3().updatePaymentMetadata()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V3UpdatePaymentMetadataResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

updatePoolQuery

Update the query of a pool

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V3ErrorResponse;
import com.formance.formance_sdk.models.operations.V3UpdatePoolQueryRequest;
import com.formance.formance_sdk.models.operations.V3UpdatePoolQueryResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3UpdatePoolQueryRequest req = V3UpdatePoolQueryRequest.builder()
                .poolID("<id>")
                .build();

        V3UpdatePoolQueryResponse res = sdk.payments().v3().updatePoolQuery()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V3UpdatePoolQueryResponse

Errors

Error Type	Status Code	Content Type
models/errors/V3ErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

v3UpdateConnectorConfig

Update connector config

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.PaymentsErrorResponse;
import com.formance.formance_sdk.models.operations.V3UpdateConnectorConfigRequest;
import com.formance.formance_sdk.models.operations.V3UpdateConnectorConfigResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

        SDK sdk = SDK.builder()
                .security(Security.builder()
                    .clientID(System.getenv().getOrDefault("CLIENT_ID", ""))
                    .clientSecret(System.getenv().getOrDefault("CLIENT_SECRET", ""))
                    .build())
            .build();

        V3UpdateConnectorConfigRequest req = V3UpdateConnectorConfigRequest.builder()
                .connectorID("<id>")
                .build();

        V3UpdateConnectorConfigResponse res = sdk.payments().v3().v3UpdateConnectorConfig()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V3UpdateConnectorConfigResponse

Errors

Error Type	Status Code	Content Type
models/errors/PaymentsErrorResponse	default	application/json
models/errors/SDKError	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Payments.V3

Overview

Available Operations

addAccountToPool

Example Usage

Parameters

Response

Errors

addBankAccountToPaymentServiceUser

Example Usage

Parameters

Response

Errors

approvePaymentInitiation

Example Usage

Parameters

Response

Errors

createAccount

Example Usage

Parameters

Response

Errors

createBankAccount

Example Usage

Parameters

Response

Errors

createLinkForPaymentServiceUser

Example Usage

Parameters

Response

Errors

createPayment

Example Usage

Parameters

Response

Errors

createPaymentServiceUser

Example Usage

Parameters

Response

Errors

createPool

Example Usage

Parameters

Response

Errors

deletePaymentInitiation

Example Usage

Parameters

Response

Errors

deletePaymentServiceUser

Example Usage

Parameters

Response

Errors

deletePaymentServiceUserConnectionFromConnectorID

Example Usage

Parameters

Response

Errors

deletePaymentServiceUserConnector

Example Usage

Parameters

Response

Errors

deletePool

Example Usage

Parameters

Response

Errors

forwardBankAccount