Ledger.V1

Overview

Available Operations

createTransactions - Create a new batch of transactions to a ledger
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
createTransaction - Create a new transaction to a ledger
getAccountLedger - Get account by its address
getBalances - Get the balances from a ledger's account
getBalancesAggregated - Get the aggregated balances from selected accounts
getInfo - Show server information
getLedgerInfo - Get information about a ledger
getMapping - Get the mapping of a ledger
getTransaction - Get transaction from a ledger by its ID
listAccountsLedger - List accounts from a ledger
listLogs - List the logs from a ledger
listTransactions - List transactions from a ledger
readStats - Get statistics from a ledger
revertTransaction - Revert a ledger transaction by its ID
~~runScript~~ - Execute a Numscript ⚠️ Deprecated
updateMapping - Update the mapping of a ledger

createTransactions

Create a new batch of transactions to a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.ledger.*;
import com.formance.formance_sdk.models.operations.CreateTransactionsRequest;
import com.formance.formance_sdk.models.operations.CreateTransactionsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.math.BigInteger;
import java.util.List;

public class Application {

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

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

        CreateTransactionsRequest req = CreateTransactionsRequest.builder()
                .transactions(Transactions.builder()
                    .transactions(List.of(
                        TransactionData.builder()
                            .postings(List.of(
                                Posting.builder()
                                    .amount(new BigInteger("100"))
                                    .asset("COIN")
                                    .destination("users:002")
                                    .source("users:001")
                                    .build()))
                            .reference("ref:001")
                            .build()))
                    .build())
                .ledger("ledger001")
                .build();

        CreateTransactionsResponse res = sdk.ledger().v1().createTransactions()
                .request(req)
                .call();

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

Parameters

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

Response

CreateTransactionsResponse

Errors

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

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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.AddMetadataOnTransactionRequest;
import com.formance.formance_sdk.models.operations.AddMetadataOnTransactionResponse;
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 ErrorsErrorResponse, Exception {

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

        AddMetadataOnTransactionRequest req = AddMetadataOnTransactionRequest.builder()
                .requestBody(Map.ofEntries(
                ))
                .ledger("ledger001")
                .txid(new BigInteger("1234"))
                .build();

        AddMetadataOnTransactionResponse res = sdk.ledger().v1().addMetadataOnTransaction()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

AddMetadataOnTransactionResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorsErrorResponse	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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.AddMetadataToAccountRequest;
import com.formance.formance_sdk.models.operations.AddMetadataToAccountResponse;
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 ErrorsErrorResponse, Exception {

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

        AddMetadataToAccountRequest req = AddMetadataToAccountRequest.builder()
                .requestBody(Map.ofEntries(
                    Map.entry("key", "<value>"),
                    Map.entry("key1", "<value>"),
                    Map.entry("key2", "<value>")))
                .address("users:001")
                .ledger("ledger001")
                .build();

        AddMetadataToAccountResponse res = sdk.ledger().v1().addMetadataToAccount()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

AddMetadataToAccountResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorsErrorResponse	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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.CountAccountsRequest;
import com.formance.formance_sdk.models.operations.CountAccountsResponse;
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 ErrorsErrorResponse, Exception {

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

        CountAccountsRequest req = CountAccountsRequest.builder()
                .ledger("ledger001")
                .address("users:.+")
                .metadata(Map.ofEntries(
                    Map.entry("0", "m"),
                    Map.entry("1", "e"),
                    Map.entry("2", "t"),
                    Map.entry("3", "a"),
                    Map.entry("4", "d"),
                    Map.entry("5", "a"),
                    Map.entry("6", "t"),
                    Map.entry("7", "a"),
                    Map.entry("8", "["),
                    Map.entry("9", "k"),
                    Map.entry("10", "e"),
                    Map.entry("11", "y"),
                    Map.entry("12", "]"),
                    Map.entry("13", "="),
                    Map.entry("14", "v"),
                    Map.entry("15", "a"),
                    Map.entry("16", "l"),
                    Map.entry("17", "u"),
                    Map.entry("18", "e"),
                    Map.entry("19", "1"),
                    Map.entry("20", "&"),
                    Map.entry("21", "m"),
                    Map.entry("22", "e"),
                    Map.entry("23", "t"),
                    Map.entry("24", "a"),
                    Map.entry("25", "d"),
                    Map.entry("26", "a"),
                    Map.entry("27", "t"),
                    Map.entry("28", "a"),
                    Map.entry("29", "["),
                    Map.entry("30", "a"),
                    Map.entry("31", "."),
                    Map.entry("32", "n"),
                    Map.entry("33", "e"),
                    Map.entry("34", "s"),
                    Map.entry("35", "t"),
                    Map.entry("36", "e"),
                    Map.entry("37", "d"),
                    Map.entry("38", "."),
                    Map.entry("39", "k"),
                    Map.entry("40", "e"),
                    Map.entry("41", "y"),
                    Map.entry("42", "]"),
                    Map.entry("43", "="),
                    Map.entry("44", "v"),
                    Map.entry("45", "a"),
                    Map.entry("46", "l"),
                    Map.entry("47", "u"),
                    Map.entry("48", "e"),
                    Map.entry("49", "2")))
                .build();

        CountAccountsResponse res = sdk.ledger().v1().countAccounts()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

CountAccountsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorsErrorResponse	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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        CountTransactionsRequest req = CountTransactionsRequest.builder()
                .ledger("ledger001")
                .account("users:001")
                .destination("users:001")
                .metadata(Metadata.builder()
                    .build())
                .reference("ref:001")
                .source("users:001")
                .build();

        CountTransactionsResponse res = sdk.ledger().v1().countTransactions()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

CountTransactionsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorsErrorResponse	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.ledger.*;
import com.formance.formance_sdk.models.operations.CreateTransactionRequest;
import com.formance.formance_sdk.models.operations.CreateTransactionResponse;
import com.formance.formance_sdk.models.shared.Security;
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 ErrorsErrorResponse, Exception {

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

        CreateTransactionRequest req = CreateTransactionRequest.builder()
                .postTransaction(PostTransaction.builder()
                    .postings(List.of(
                        Posting.builder()
                            .amount(new BigInteger("100"))
                            .asset("COIN")
                            .destination("users:002")
                            .source("users:001")
                            .build()))
                    .reference("ref:001")
                    .script(PostTransactionScript.builder()
                        .plain("vars {\naccount $user\n}\nsend [COIN 10] (\n\tsource = @world\n\tdestination = $user\n)\n")
                        .vars(Map.ofEntries(
                            Map.entry("user", "users:042")))
                        .build())
                    .build())
                .ledger("ledger001")
                .preview(true)
                .build();

        CreateTransactionResponse res = sdk.ledger().v1().createTransaction()
                .request(req)
                .call();

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

Parameters

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

Response

CreateTransactionResponse

Errors

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

getAccountLedger

Get account by its address

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.GetAccountLedgerRequest;
import com.formance.formance_sdk.models.operations.GetAccountLedgerResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

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

        GetAccountLedgerResponse res = sdk.ledger().v1().getAccountLedger()
                .request(req)
                .call();

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

Parameters

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

Response

GetAccountLedgerResponse

Errors

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

getBalances

Get the balances from a ledger's account

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.GetBalancesRequest;
import com.formance.formance_sdk.models.operations.GetBalancesResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        GetBalancesRequest req = GetBalancesRequest.builder()
                .ledger("ledger001")
                .address("users:001")
                .after("users:003")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .build();

        GetBalancesResponse res = sdk.ledger().v1().getBalances()
                .request(req)
                .call();

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

Parameters

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

Response

GetBalancesResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorsErrorResponse	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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.GetBalancesAggregatedRequest;
import com.formance.formance_sdk.models.operations.GetBalancesAggregatedResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

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

        GetBalancesAggregatedResponse res = sdk.ledger().v1().getBalancesAggregated()
                .request(req)
                .call();

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

Parameters

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

Response

GetBalancesAggregatedResponse

Errors

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

getInfo

Show server information

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.GetInfoResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        GetInfoResponse res = sdk.ledger().v1().getInfo()
                .call();

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

Response

GetInfoResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorsErrorResponse	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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.GetLedgerInfoRequest;
import com.formance.formance_sdk.models.operations.GetLedgerInfoResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

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

        GetLedgerInfoResponse res = sdk.ledger().v1().getLedgerInfo()
                .request(req)
                .call();

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

Parameters

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

Response

GetLedgerInfoResponse

Errors

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

getMapping

Get the mapping of a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.GetMappingRequest;
import com.formance.formance_sdk.models.operations.GetMappingResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

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

        GetMappingResponse res = sdk.ledger().v1().getMapping()
                .request(req)
                .call();

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

Parameters

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

Response

GetMappingResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorsErrorResponse	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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.GetTransactionRequest;
import com.formance.formance_sdk.models.operations.GetTransactionResponse;
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 ErrorsErrorResponse, Exception {

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

        GetTransactionRequest req = GetTransactionRequest.builder()
                .ledger("ledger001")
                .txid(new BigInteger("1234"))
                .build();

        GetTransactionResponse res = sdk.ledger().v1().getTransaction()
                .request(req)
                .call();

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

Parameters

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

Response

GetTransactionResponse

Errors

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

listAccountsLedger

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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.ListAccountsLedgerRequest;
import com.formance.formance_sdk.models.operations.ListAccountsLedgerResponse;
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 ErrorsErrorResponse, Exception {

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

        ListAccountsLedgerRequest req = ListAccountsLedgerRequest.builder()
                .ledger("ledger001")
                .address("users:.+")
                .after("users:003")
                .balance(2400L)
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .metadata(Map.ofEntries(
                    Map.entry("0", "m"),
                    Map.entry("1", "e"),
                    Map.entry("2", "t"),
                    Map.entry("3", "a"),
                    Map.entry("4", "d"),
                    Map.entry("5", "a"),
                    Map.entry("6", "t"),
                    Map.entry("7", "a"),
                    Map.entry("8", "["),
                    Map.entry("9", "k"),
                    Map.entry("10", "e"),
                    Map.entry("11", "y"),
                    Map.entry("12", "]"),
                    Map.entry("13", "="),
                    Map.entry("14", "v"),
                    Map.entry("15", "a"),
                    Map.entry("16", "l"),
                    Map.entry("17", "u"),
                    Map.entry("18", "e"),
                    Map.entry("19", "1"),
                    Map.entry("20", "&"),
                    Map.entry("21", "m"),
                    Map.entry("22", "e"),
                    Map.entry("23", "t"),
                    Map.entry("24", "a"),
                    Map.entry("25", "d"),
                    Map.entry("26", "a"),
                    Map.entry("27", "t"),
                    Map.entry("28", "a"),
                    Map.entry("29", "["),
                    Map.entry("30", "a"),
                    Map.entry("31", "."),
                    Map.entry("32", "n"),
                    Map.entry("33", "e"),
                    Map.entry("34", "s"),
                    Map.entry("35", "t"),
                    Map.entry("36", "e"),
                    Map.entry("37", "d"),
                    Map.entry("38", "."),
                    Map.entry("39", "k"),
                    Map.entry("40", "e"),
                    Map.entry("41", "y"),
                    Map.entry("42", "]"),
                    Map.entry("43", "="),
                    Map.entry("44", "v"),
                    Map.entry("45", "a"),
                    Map.entry("46", "l"),
                    Map.entry("47", "u"),
                    Map.entry("48", "e"),
                    Map.entry("49", "2")))
                .pageSize(100L)
                .build();

        ListAccountsLedgerResponse res = sdk.ledger().v1().listAccountsLedger()
                .request(req)
                .call();

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

Parameters

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

Response

ListAccountsLedgerResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorsErrorResponse	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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.ListLogsRequest;
import com.formance.formance_sdk.models.operations.ListLogsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        ListLogsRequest req = ListLogsRequest.builder()
                .ledger("ledger001")
                .after("1234")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .pageSize(100L)
                .build();

        ListLogsResponse res = sdk.ledger().v1().listLogs()
                .request(req)
                .call();

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

Parameters

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

Response

ListLogsResponse

Errors

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

listTransactions

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

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.ListTransactionsRequest;
import com.formance.formance_sdk.models.operations.ListTransactionsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

        ListTransactionsRequest req = ListTransactionsRequest.builder()
                .ledger("ledger001")
                .account("users:001")
                .after("1234")
                .cursor("aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==")
                .destination("users:001")
                .pageSize(100L)
                .reference("ref:001")
                .source("users:001")
                .build();

        ListTransactionsResponse res = sdk.ledger().v1().listTransactions()
                .request(req)
                .call();

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

Parameters

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

Response

ListTransactionsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorsErrorResponse	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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.ReadStatsRequest;
import com.formance.formance_sdk.models.operations.ReadStatsResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;

public class Application {

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

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

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

        ReadStatsResponse res = sdk.ledger().v1().readStats()
                .request(req)
                .call();

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

Parameters

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

Response

ReadStatsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorsErrorResponse	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.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.RevertTransactionRequest;
import com.formance.formance_sdk.models.operations.RevertTransactionResponse;
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 ErrorsErrorResponse, Exception {

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

        RevertTransactionRequest req = RevertTransactionRequest.builder()
                .ledger("ledger001")
                .txid(new BigInteger("1234"))
                .build();

        RevertTransactionResponse res = sdk.ledger().v1().revertTransaction()
                .request(req)
                .call();

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

Parameters

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

Response

RevertTransactionResponse

Errors

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

runScript

This route is deprecated, and has been merged into POST /{ledger}/transactions.

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

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.ledger.Script;
import com.formance.formance_sdk.models.operations.RunScriptRequest;
import com.formance.formance_sdk.models.operations.RunScriptResponse;
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 Exception {

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

        RunScriptRequest req = RunScriptRequest.builder()
                .script(Script.builder()
                    .plain("vars {\naccount $user\n}\nsend [COIN 10] (\n\tsource = @world\n\tdestination = $user\n)\n")
                    .reference("order_1234")
                    .vars(Map.ofEntries(
                        Map.entry("user", "users:042")))
                    .build())
                .ledger("ledger001")
                .preview(true)
                .build();

        RunScriptResponse res = sdk.ledger().v1().runScript()
                .request(req)
                .call();

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

Parameters

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

Response

RunScriptResponse

Errors

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

updateMapping

Update the mapping of a ledger

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.ledger.ErrorsErrorResponse;
import com.formance.formance_sdk.models.operations.UpdateMappingRequest;
import com.formance.formance_sdk.models.operations.UpdateMappingResponse;
import com.formance.formance_sdk.models.shared.Security;
import java.lang.Exception;
import java.util.Optional;

public class Application {

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

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

        UpdateMappingRequest req = UpdateMappingRequest.builder()
                .mapping(Optional.empty())
                .ledger("ledger001")
                .build();

        UpdateMappingResponse res = sdk.ledger().v1().updateMapping()
                .request(req)
                .call();

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

Parameters

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

Response

UpdateMappingResponse

Errors

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

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Ledger.V1

Overview

Available Operations

createTransactions

Example Usage

Parameters

Response

Errors

addMetadataOnTransaction

Example Usage

Parameters

Response

Errors

addMetadataToAccount

Example Usage

Parameters

Response

Errors

countAccounts

Example Usage

Parameters

Response

Errors

countTransactions

Example Usage

Parameters

Response

Errors

createTransaction

Example Usage

Parameters

Response

Errors

getAccountLedger

Example Usage

Parameters

Response

Errors

getBalances

Example Usage

Parameters

Response

Errors

getBalancesAggregated

Example Usage

Parameters

Response

Errors

getInfo

Example Usage

Response

Errors

getLedgerInfo

Example Usage

Parameters

Response

Errors

getMapping

Example Usage

Parameters

Response

Errors

getTransaction

Example Usage

Parameters

Response

Errors

listAccountsLedger

Example Usage

Parameters

Response

Errors

listLogs

Example Usage