Ledger.V2

Overview

Available Operations

addMetadataOnTransaction - Set the metadata of a transaction by its ID
addMetadataToAccount - Add metadata to an account
countAccounts - Count the accounts from a ledger
countTransactions - Count the transactions from a ledger
createBulk - Bulk request
createExporter - Create exporter
createLedger - Create a ledger
createPipeline - Create pipeline
createTransaction - Create a new transaction to a ledger
deleteAccountMetadata - Delete metadata by key
deleteBucket - Delete bucket
deleteExporter - Delete exporter
deleteLedgerMetadata - Delete ledger metadata by key
deletePipeline - Delete pipeline
deleteTransactionMetadata - Delete metadata by key
exportLogs - Export logs
getAccount - Get account by its address
getBalancesAggregated - Get the aggregated balances from selected accounts
getExporterState - Get exporter state
getLedger - Get a ledger
getLedgerInfo - Get information about a ledger
getPipelineState - Get pipeline state
getSchema - Get a schema for a ledger by version
getTransaction - Get transaction from a ledger by its ID
getVolumesWithBalances - Get list of volumes with balances for (account/asset)
importLogs
insertSchema - Insert a schema for a ledger
listAccounts - List accounts from a ledger
listExporters - List exporters
listLedgers - List ledgers
listLogs - List the logs from a ledger
listPipelines - List pipelines
listSchemas - List all schemas for a ledger
listTransactions - List transactions from a ledger
readStats - Get statistics from a ledger
resetPipeline - Reset pipeline
restoreBucket - Restore bucket
revertTransaction - Revert a ledger transaction by its ID
runQuery - Run a query template
startPipeline - Start pipeline
stopPipeline - Stop pipeline
updateExporter - Update exporter
updateLedgerMetadata - Update ledger metadata

addMetadataOnTransaction

Set the metadata of a transaction by its ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2AddMetadataOnTransactionRequest;
import com.formance.formance_sdk.models.operations.V2AddMetadataOnTransactionResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.math.BigInteger;
import java.util.Map;

public class Application {

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

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

        V2AddMetadataOnTransactionRequest req = V2AddMetadataOnTransactionRequest.builder()
                .requestBody(Map.ofEntries(
                    Map.entry("admin", "true")))
                .id(new BigInteger("1234"))
                .ledger("ledger001")
                .dryRun(true)
                .schemaVersion("v1.0.0")
                .build();

        V2AddMetadataOnTransactionResponse res = sdk.ledger().v2().addMetadataOnTransaction()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2AddMetadataOnTransactionResponse

Errors

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

addMetadataToAccount

Add metadata to an account

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2AddMetadataToAccountRequest;
import com.formance.formance_sdk.models.operations.V2AddMetadataToAccountResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.util.Map;

public class Application {

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

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

        V2AddMetadataToAccountRequest req = V2AddMetadataToAccountRequest.builder()
                .requestBody(Map.ofEntries(
                    Map.entry("admin", "true")))
                .address("users:001")
                .ledger("ledger001")
                .dryRun(true)
                .schemaVersion("v1.0.0")
                .build();

        V2AddMetadataToAccountResponse res = sdk.ledger().v2().addMetadataToAccount()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2AddMetadataToAccountResponse

Errors

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

countAccounts

Count the accounts from a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2CountAccountsRequest;
import com.formance.formance_sdk.models.operations.V2CountAccountsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2CountAccountsRequest req = V2CountAccountsRequest.builder()
                .ledger("ledger001")
                .build();

        V2CountAccountsResponse res = sdk.ledger().v2().countAccounts()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2CountAccountsResponse

Errors

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

countTransactions

Count the transactions from a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2CountTransactionsRequest;
import com.formance.formance_sdk.models.operations.V2CountTransactionsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2CountTransactionsRequest req = V2CountTransactionsRequest.builder()
                .ledger("ledger001")
                .build();

        V2CountTransactionsResponse res = sdk.ledger().v2().countTransactions()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2CountTransactionsResponse

Errors

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

createBulk

Bulk request

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2CreateBulkRequest;
import com.formance.formance_sdk.models.operations.V2CreateBulkResponse;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.V2BulkElementRevertTransaction;
import java.lang.Exception;
import java.util.List;

public class Application {

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

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

        V2CreateBulkRequest req = V2CreateBulkRequest.builder()
                .requestBody(List.of(
                    V2BulkElementRevertTransaction.builder()
                        .action("REVERT_TRANSACTION")
                        .build()))
                .ledger("ledger001")
                .atomic(true)
                .continueOnFailure(true)
                .parallel(true)
                .schemaVersion("v1.0.0")
                .build();

        V2CreateBulkResponse res = sdk.ledger().v2().createBulk()
                .request(req)
                .call();

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

Parameters

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

Response

V2CreateBulkResponse

Errors

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

createExporter

Create exporter

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2CreateExporterResponse;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.V2CreateExporterRequest;
import java.lang.Exception;
import java.util.Map;

public class Application {

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

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

        V2CreateExporterRequest req = V2CreateExporterRequest.builder()
                .config(Map.ofEntries(
                    Map.entry("key", "<value>")))
                .driver("<value>")
                .build();

        V2CreateExporterResponse res = sdk.ledger().v2().createExporter()
                .request(req)
                .call();

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

Parameters

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

Response

V2CreateExporterResponse

Errors

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

createLedger

Create a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2CreateLedgerResponse;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.V2CreateLedgerRequest;
import java.lang.Exception;
import java.util.Map;

public class Application {

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

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

        com.formance.formance_sdk.models.operations.V2CreateLedgerRequest req = com.formance.formance_sdk.models.operations.V2CreateLedgerRequest.builder()
                .v2CreateLedgerRequest(V2CreateLedgerRequest.builder()
                    .metadata(Map.ofEntries(
                        Map.entry("admin", "true")))
                    .build())
                .ledger("ledger001")
                .build();

        V2CreateLedgerResponse res = sdk.ledger().v2().createLedger()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2CreateLedgerResponse

Errors

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

createPipeline

Create pipeline

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2CreatePipelineRequest;
import com.formance.formance_sdk.models.operations.V2CreatePipelineResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2CreatePipelineRequest req = V2CreatePipelineRequest.builder()
                .ledger("ledger001")
                .build();

        V2CreatePipelineResponse res = sdk.ledger().v2().createPipeline()
                .request(req)
                .call();

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

Parameters

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

Response

V2CreatePipelineResponse

Errors

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

createTransaction

Create a new transaction to a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2CreateTransactionRequest;
import com.formance.formance_sdk.models.operations.V2CreateTransactionResponse;
import com.formance.formance_sdk.models.shared.*;
import java.lang.Exception;
import java.math.BigInteger;
import java.util.List;
import java.util.Map;

public class Application {

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

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

        V2CreateTransactionRequest req = V2CreateTransactionRequest.builder()
                .v2PostTransaction(V2PostTransaction.builder()
                    .metadata(Map.ofEntries(
                        Map.entry("admin", "true")))
                    .accountMetadata(Map.ofEntries(
                        Map.entry("key", Map.ofEntries(
                            Map.entry("admin", "true"))),
                        Map.entry("key1", Map.ofEntries(
                            Map.entry("admin", "true"))),
                        Map.entry("key2", Map.ofEntries(
                            Map.entry("admin", "true")))))
                    .postings(List.of(
                        V2Posting.builder()
                            .amount(new BigInteger("100"))
                            .asset("COIN")
                            .destination("users:002")
                            .source("users:001")
                            .build()))
                    .reference("ref:001")
                    .script(V2PostTransactionScript.builder()
                        .plain("vars {\naccount $user\n}\nsend [COIN 10] (\n\tsource = @world\n\tdestination = $user\n)\n")
                        .template("CUSTOMER_DEPOSIT")
                        .vars(Map.ofEntries(
                            Map.entry("user", "users:042")))
                        .build())
                    .build())
                .ledger("ledger001")
                .dryRun(true)
                .force(true)
                .schemaVersion("v1.0.0")
                .build();

        V2CreateTransactionResponse res = sdk.ledger().v2().createTransaction()
                .request(req)
                .call();

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

Parameters

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

Response

V2CreateTransactionResponse

Errors

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

deleteAccountMetadata

Delete metadata by key

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2DeleteAccountMetadataRequest;
import com.formance.formance_sdk.models.operations.V2DeleteAccountMetadataResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2DeleteAccountMetadataRequest req = V2DeleteAccountMetadataRequest.builder()
                .address("6753 S Washington Street")
                .key("foo")
                .ledger("ledger001")
                .build();

        V2DeleteAccountMetadataResponse res = sdk.ledger().v2().deleteAccountMetadata()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2DeleteAccountMetadataResponse

Errors

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

deleteBucket

Delete a bucket by marking all ledgers in the bucket as deleted (soft delete). All ledgers in the bucket will have their deleted_at field set to the current timestamp.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2DeleteBucketRequest;
import com.formance.formance_sdk.models.operations.V2DeleteBucketResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2DeleteBucketRequest req = V2DeleteBucketRequest.builder()
                .bucket("<value>")
                .build();

        V2DeleteBucketResponse res = sdk.ledger().v2().deleteBucket()
                .request(req)
                .call();

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

Parameters

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

Response

V2DeleteBucketResponse

Errors

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

deleteExporter

Delete exporter

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2DeleteExporterRequest;
import com.formance.formance_sdk.models.operations.V2DeleteExporterResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2DeleteExporterRequest req = V2DeleteExporterRequest.builder()
                .exporterID("<id>")
                .build();

        V2DeleteExporterResponse res = sdk.ledger().v2().deleteExporter()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2DeleteExporterResponse

Errors

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

deleteLedgerMetadata

Delete ledger metadata by key

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2DeleteLedgerMetadataRequest;
import com.formance.formance_sdk.models.operations.V2DeleteLedgerMetadataResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2DeleteLedgerMetadataRequest req = V2DeleteLedgerMetadataRequest.builder()
                .key("foo")
                .ledger("ledger001")
                .build();

        V2DeleteLedgerMetadataResponse res = sdk.ledger().v2().deleteLedgerMetadata()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2DeleteLedgerMetadataResponse

Errors

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

deletePipeline

Delete pipeline

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2DeletePipelineRequest;
import com.formance.formance_sdk.models.operations.V2DeletePipelineResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2DeletePipelineRequest req = V2DeletePipelineRequest.builder()
                .ledger("ledger001")
                .pipelineID("<id>")
                .build();

        V2DeletePipelineResponse res = sdk.ledger().v2().deletePipeline()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2DeletePipelineResponse

Errors

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

deleteTransactionMetadata

Delete metadata by key

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2DeleteTransactionMetadataRequest;
import com.formance.formance_sdk.models.operations.V2DeleteTransactionMetadataResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.math.BigInteger;

public class Application {

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

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

        V2DeleteTransactionMetadataRequest req = V2DeleteTransactionMetadataRequest.builder()
                .id(new BigInteger("1234"))
                .key("foo")
                .ledger("ledger001")
                .build();

        V2DeleteTransactionMetadataResponse res = sdk.ledger().v2().deleteTransactionMetadata()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2DeleteTransactionMetadataResponse

Errors

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

exportLogs

Export logs

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.V2ExportLogsRequest;
import com.formance.formance_sdk.models.operations.V2ExportLogsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2ExportLogsRequest req = V2ExportLogsRequest.builder()
                .ledger("ledger001")
                .build();

        V2ExportLogsResponse res = sdk.ledger().v2().exportLogs()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2ExportLogsResponse

Errors

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

getAccount

Get account by its address

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2GetAccountRequest;
import com.formance.formance_sdk.models.operations.V2GetAccountResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2GetAccountRequest req = V2GetAccountRequest.builder()
                .address("users:001")
                .ledger("ledger001")
                .build();

        V2GetAccountResponse res = sdk.ledger().v2().getAccount()
                .request(req)
                .call();

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

Parameters

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

Response

V2GetAccountResponse

Errors

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

getBalancesAggregated

Get the aggregated balances from selected accounts

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2GetBalancesAggregatedRequest;
import com.formance.formance_sdk.models.operations.V2GetBalancesAggregatedResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2GetBalancesAggregatedRequest req = V2GetBalancesAggregatedRequest.builder()
                .ledger("ledger001")
                .build();

        V2GetBalancesAggregatedResponse res = sdk.ledger().v2().getBalancesAggregated()
                .request(req)
                .call();

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

Parameters

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

Response

V2GetBalancesAggregatedResponse

Errors

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

getExporterState

Get exporter state

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2GetExporterStateRequest;
import com.formance.formance_sdk.models.operations.V2GetExporterStateResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2GetExporterStateRequest req = V2GetExporterStateRequest.builder()
                .exporterID("<id>")
                .build();

        V2GetExporterStateResponse res = sdk.ledger().v2().getExporterState()
                .request(req)
                .call();

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

Parameters

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

Response

V2GetExporterStateResponse

Errors

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

getLedger

Get a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2GetLedgerRequest;
import com.formance.formance_sdk.models.operations.V2GetLedgerResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2GetLedgerRequest req = V2GetLedgerRequest.builder()
                .ledger("ledger001")
                .build();

        V2GetLedgerResponse res = sdk.ledger().v2().getLedger()
                .request(req)
                .call();

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

Parameters

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

Response

V2GetLedgerResponse

Errors

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

getLedgerInfo

Get information about a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2GetLedgerInfoRequest;
import com.formance.formance_sdk.models.operations.V2GetLedgerInfoResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2GetLedgerInfoRequest req = V2GetLedgerInfoRequest.builder()
                .ledger("ledger001")
                .build();

        V2GetLedgerInfoResponse res = sdk.ledger().v2().getLedgerInfo()
                .request(req)
                .call();

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

Parameters

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

Response

V2GetLedgerInfoResponse

Errors

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

getPipelineState

Get pipeline state

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2GetPipelineStateRequest;
import com.formance.formance_sdk.models.operations.V2GetPipelineStateResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2GetPipelineStateRequest req = V2GetPipelineStateRequest.builder()
                .ledger("ledger001")
                .pipelineID("<id>")
                .build();

        V2GetPipelineStateResponse res = sdk.ledger().v2().getPipelineState()
                .request(req)
                .call();

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

Parameters

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

Response

V2GetPipelineStateResponse

Errors

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

getSchema

Get a schema for a ledger by version

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2GetSchemaRequest;
import com.formance.formance_sdk.models.operations.V2GetSchemaResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2GetSchemaRequest req = V2GetSchemaRequest.builder()
                .ledger("ledger001")
                .version("v1.0.0")
                .build();

        V2GetSchemaResponse res = sdk.ledger().v2().getSchema()
                .request(req)
                .call();

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

Parameters

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

Response

V2GetSchemaResponse

Errors

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

getTransaction

Get transaction from a ledger by its ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2GetTransactionRequest;
import com.formance.formance_sdk.models.operations.V2GetTransactionResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.math.BigInteger;

public class Application {

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

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

        V2GetTransactionRequest req = V2GetTransactionRequest.builder()
                .id(new BigInteger("1234"))
                .ledger("ledger001")
                .build();

        V2GetTransactionResponse res = sdk.ledger().v2().getTransaction()
                .request(req)
                .call();

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

Parameters

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

Response

V2GetTransactionResponse

Errors

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

getVolumesWithBalances

Get list of volumes with balances for (account/asset)

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2GetVolumesWithBalancesRequest;
import com.formance.formance_sdk.models.operations.V2GetVolumesWithBalancesResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2GetVolumesWithBalancesRequest req = V2GetVolumesWithBalancesRequest.builder()
                .ledger("ledger001")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .groupBy(3L)
                .pageSize(100L)
                .sort("id:desc")
                .build();

        V2GetVolumesWithBalancesResponse res = sdk.ledger().v2().getVolumesWithBalances()
                .request(req)
                .call();

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

Parameters

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

Response

V2GetVolumesWithBalancesResponse

Errors

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

importLogs

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2ImportLogsRequest;
import com.formance.formance_sdk.models.operations.V2ImportLogsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.nio.charset.StandardCharsets;

public class Application {

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

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

        V2ImportLogsRequest req = V2ImportLogsRequest.builder()
                .v2ImportLogsRequest("0xde3EDEE9e6".getBytes(StandardCharsets.UTF_8))
                .ledger("ledger001")
                .build();

        V2ImportLogsResponse res = sdk.ledger().v2().importLogs()
                .request(req)
                .call();

    }
}

Parameters

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

Response

V2ImportLogsResponse

Errors

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

insertSchema

Insert a schema for a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2InsertSchemaRequest;
import com.formance.formance_sdk.models.operations.V2InsertSchemaResponse;
import com.formance.formance_sdk.models.shared.*;
import java.lang.Exception;
import java.util.Map;

public class Application {

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

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

        V2InsertSchemaRequest req = V2InsertSchemaRequest.builder()
                .v2SchemaData(V2SchemaData.builder()
                    .chart(Map.ofEntries(
                        Map.entry("users", V2ChartSegment.builder()
                            .additionalProperties(Map.ofEntries(
                                Map.entry("$userID", V2ChartSegment.builder()
                                    .dotPattern("^[0-9]{16}$")
                                    .build())))
                            .build())))
                    .queries(Map.ofEntries(
                        Map.entry("key", V2QueryTemplate.builder()
                            .params(V2QueryParams.of(QueryTemplateAccountParams.builder()
                                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                                .pageSize(100L)
                                .sort("id:desc")
                                .build()))
                            .build())))
                    .build())
                .ledger("ledger001")
                .version("v1.0.0")
                .build();

        V2InsertSchemaResponse res = sdk.ledger().v2().insertSchema()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2InsertSchemaResponse

Errors

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

listAccounts

List accounts from a ledger, sorted by address in descending order.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2ListAccountsRequest;
import com.formance.formance_sdk.models.operations.V2ListAccountsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2ListAccountsRequest req = V2ListAccountsRequest.builder()
                .ledger("ledger001")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .sort("id:desc")
                .build();

        V2ListAccountsResponse res = sdk.ledger().v2().listAccounts()
                .request(req)
                .call();

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

Parameters

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

Response

V2ListAccountsResponse

Errors

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

listExporters

List exporters

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2ListExportersResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2ListExportersResponse res = sdk.ledger().v2().listExporters()
                .call();

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

Response

V2ListExportersResponse

Errors

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

listLedgers

List ledgers

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2ListLedgersRequest;
import com.formance.formance_sdk.models.operations.V2ListLedgersResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2ListLedgersRequest req = V2ListLedgersRequest.builder()
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .sort("id:desc")
                .build();

        V2ListLedgersResponse res = sdk.ledger().v2().listLedgers()
                .request(req)
                .call();

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

Parameters

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

Response

V2ListLedgersResponse

Errors

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

listLogs

List the logs from a ledger, sorted by ID in descending order.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2ListLogsRequest;
import com.formance.formance_sdk.models.operations.V2ListLogsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2ListLogsRequest req = V2ListLogsRequest.builder()
                .ledger("ledger001")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .sort("id:desc")
                .build();

        V2ListLogsResponse res = sdk.ledger().v2().listLogs()
                .request(req)
                .call();

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

Parameters

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

Response

V2ListLogsResponse

Errors

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

listPipelines

List pipelines

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2ListPipelinesRequest;
import com.formance.formance_sdk.models.operations.V2ListPipelinesResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2ListPipelinesRequest req = V2ListPipelinesRequest.builder()
                .ledger("ledger001")
                .build();

        V2ListPipelinesResponse res = sdk.ledger().v2().listPipelines()
                .request(req)
                .call();

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

Parameters

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

Response

V2ListPipelinesResponse

Errors

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

listSchemas

List all schemas for a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2ListSchemasRequest;
import com.formance.formance_sdk.models.operations.V2ListSchemasResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2ListSchemasRequest req = V2ListSchemasRequest.builder()
                .ledger("ledger001")
                .build();

        V2ListSchemasResponse res = sdk.ledger().v2().listSchemas()
                .request(req)
                .call();

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

Parameters

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

Response

V2ListSchemasResponse

Errors

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

listTransactions

List transactions from a ledger, sorted by id in descending order.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2ListTransactionsRequest;
import com.formance.formance_sdk.models.operations.V2ListTransactionsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2ListTransactionsRequest req = V2ListTransactionsRequest.builder()
                .ledger("ledger001")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .sort("id:desc")
                .build();

        V2ListTransactionsResponse res = sdk.ledger().v2().listTransactions()
                .request(req)
                .call();

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

Parameters

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

Response

V2ListTransactionsResponse

Errors

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

readStats

Get statistics from a ledger. (aggregate metrics on accounts and transactions)

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2ReadStatsRequest;
import com.formance.formance_sdk.models.operations.V2ReadStatsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2ReadStatsRequest req = V2ReadStatsRequest.builder()
                .ledger("ledger001")
                .build();

        V2ReadStatsResponse res = sdk.ledger().v2().readStats()
                .request(req)
                .call();

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

Parameters

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

Response

V2ReadStatsResponse

Errors

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

resetPipeline

Reset pipeline

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2ResetPipelineRequest;
import com.formance.formance_sdk.models.operations.V2ResetPipelineResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2ResetPipelineRequest req = V2ResetPipelineRequest.builder()
                .ledger("ledger001")
                .pipelineID("<id>")
                .build();

        V2ResetPipelineResponse res = sdk.ledger().v2().resetPipeline()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2ResetPipelineResponse

Errors

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

restoreBucket

Restore a deleted bucket by unmarking all ledgers in the bucket as deleted. All ledgers in the bucket will have their deleted_at field set to NULL.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2RestoreBucketRequest;
import com.formance.formance_sdk.models.operations.V2RestoreBucketResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2RestoreBucketRequest req = V2RestoreBucketRequest.builder()
                .bucket("<value>")
                .build();

        V2RestoreBucketResponse res = sdk.ledger().v2().restoreBucket()
                .request(req)
                .call();

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

Parameters

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

Response

V2RestoreBucketResponse

Errors

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

revertTransaction

Revert a ledger transaction by its ID

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2RevertTransactionRequest;
import com.formance.formance_sdk.models.operations.V2RevertTransactionResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.math.BigInteger;

public class Application {

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

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

        V2RevertTransactionRequest req = V2RevertTransactionRequest.builder()
                .id(new BigInteger("1234"))
                .ledger("ledger001")
                .dryRun(true)
                .schemaVersion("v1.0.0")
                .build();

        V2RevertTransactionResponse res = sdk.ledger().v2().revertTransaction()
                .request(req)
                .call();

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

Parameters

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

Response

V2RevertTransactionResponse

Errors

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

runQuery

Run a query template on a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.shared.*;
import java.lang.Exception;
import java.lang.Object;

public class Application {

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

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

        V2RunQueryRequest req = V2RunQueryRequest.builder()
                .requestBody(V2RunQueryRequestBody.builder()
                    .params(V2QueryParams.of(QueryTemplateAccountParams.builder()
                        .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                        .pageSize(100L)
                        .sort("id:desc")
                        .build()))
                    .build())
                .id("CUSTOMER_DEPOSIT")
                .ledger("ledger001")
                .schemaVersion("v1.0.0")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .sort("id:desc")
                .build();

        V2RunQueryResponse res = sdk.ledger().v2().runQuery()
                .request(req)
                .call();

        if (res.oneOf().isPresent()) {
            V2RunQueryResponseBody unionValue = res.oneOf().get();
            Object raw = unionValue.value();
            if (raw instanceof V2TransactionsCursorResponse) {
                V2TransactionsCursorResponse v2TransactionsCursorResponseValue = (V2TransactionsCursorResponse) raw;
                // Handle v2TransactionsCursorResponse variant
            } else if (raw instanceof V2AccountsCursorResponse) {
                V2AccountsCursorResponse v2AccountsCursorResponseValue = (V2AccountsCursorResponse) raw;
                // Handle v2AccountsCursorResponse variant
            } else if (raw instanceof V2LogsCursorResponse) {
                V2LogsCursorResponse v2LogsCursorResponseValue = (V2LogsCursorResponse) raw;
                // Handle v2LogsCursorResponse variant
            } else if (raw instanceof V2VolumesWithBalanceCursorResponse) {
                V2VolumesWithBalanceCursorResponse v2VolumesWithBalanceCursorResponseValue = (V2VolumesWithBalanceCursorResponse) raw;
                // Handle v2VolumesWithBalanceCursorResponse variant
            } else {
                // Unknown or unsupported variant
            }
        }
    }
}

Parameters

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

Response

V2RunQueryResponse

Errors

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

startPipeline

Start pipeline

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2StartPipelineRequest;
import com.formance.formance_sdk.models.operations.V2StartPipelineResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2StartPipelineRequest req = V2StartPipelineRequest.builder()
                .ledger("ledger001")
                .pipelineID("<id>")
                .build();

        V2StartPipelineResponse res = sdk.ledger().v2().startPipeline()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2StartPipelineResponse

Errors

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

stopPipeline

Stop pipeline

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2StopPipelineRequest;
import com.formance.formance_sdk.models.operations.V2StopPipelineResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        V2StopPipelineRequest req = V2StopPipelineRequest.builder()
                .ledger("ledger001")
                .pipelineID("<id>")
                .build();

        V2StopPipelineResponse res = sdk.ledger().v2().stopPipeline()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2StopPipelineResponse

Errors

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

updateExporter

Update exporter

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2UpdateExporterRequest;
import com.formance.formance_sdk.models.operations.V2UpdateExporterResponse;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.V2CreateExporterRequest;
import java.lang.Exception;
import java.util.Map;

public class Application {

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

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

        V2UpdateExporterRequest req = V2UpdateExporterRequest.builder()
                .v2CreateExporterRequest(V2CreateExporterRequest.builder()
                    .config(Map.ofEntries(
                        Map.entry("key", "<value>"),
                        Map.entry("key1", "<value>"),
                        Map.entry("key2", "<value>")))
                    .driver("<value>")
                    .build())
                .exporterID("<id>")
                .build();

        V2UpdateExporterResponse res = sdk.ledger().v2().updateExporter()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

V2UpdateExporterResponse

Errors

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

updateLedgerMetadata

Update ledger metadata

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.errors.V2ErrorResponse;
import com.formance.formance_sdk.models.operations.V2UpdateLedgerMetadataRequest;
import com.formance.formance_sdk.models.operations.V2UpdateLedgerMetadataResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.util.Map;

public class Application {

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

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

        V2UpdateLedgerMetadataRequest req = V2UpdateLedgerMetadataRequest.builder()
                .requestBody(Map.ofEntries(
                    Map.entry("admin", "true")))
                .ledger("ledger001")
                .build();

        V2UpdateLedgerMetadataResponse res = sdk.ledger().v2().updateLedgerMetadata()
                .request(req)
                .call();

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

Parameters

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

Response

V2UpdateLedgerMetadataResponse

Errors

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

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Ledger.V2

Overview

Available Operations

addMetadataOnTransaction

Example Usage

Parameters

Response

Errors

addMetadataToAccount

Example Usage

Parameters

Response

Errors

countAccounts

Example Usage

Parameters

Response

Errors

countTransactions

Example Usage

Parameters

Response

Errors

createBulk

Example Usage

Parameters

Response

Errors

createExporter

Example Usage

Parameters

Response

Errors

createLedger

Example Usage

Parameters

Response

Errors

createPipeline

Example Usage

Parameters

Response

Errors

createTransaction

Example Usage

Parameters

Response

Errors

deleteAccountMetadata

Example Usage

Parameters

Response

Errors

deleteBucket

Example Usage

Parameters

Response

Errors

deleteExporter

Example Usage

Parameters

Response

Errors

deleteLedgerMetadata

Example Usage

Parameters

Response

Errors

deletePipeline

Example Usage

Parameters

Response

Errors

deleteTransactionMetadata