How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Formance Ledger API

Programmable double-entry ledger (v2).

Formance Ledger API is one of 8 APIs that Formance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Ledger. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 18 operations across 14 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://{organization}.{environment}.formance.cloud.

18 operations 14 paths 2 schemas 10 GET2 HEAD6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://{organization}.{environment}.formance.cloud/api/ledger
Authentication
OAuth 2.0
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Formance Ledger API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 6 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth2 client-credentials flow. Exchange a client id and secret at /api/auth/oauth/token for a Bearer access token, then send it as Authorization: Bearer .

Paths & Operations 18

Across 14 paths, the API surfaces 18 operations — 10 GET, 2 HEAD, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Ledger 18

Programmable double-entry ledger (v2).

GET
/api/ledger/v2
List ledgers
v2ListLedgers → 200
GET
/api/ledger/v2/{ledger}
Get a ledger
v2GetLedger 1 param → 200
POST
/api/ledger/v2/{ledger}
Create a ledger
v2CreateLedger 1 param → 204
GET
/api/ledger/v2/{ledger}/_info
Get information about a ledger
v2GetLedgerInfo 1 param → 200
POST
/api/ledger/v2/{ledger}/_bulk
Bulk request
v2CreateBulk 1 param → 200
GET
/api/ledger/v2/{ledger}/accounts
List accounts from a ledger
v2ListAccounts 1 param → 200
HEAD
/api/ledger/v2/{ledger}/accounts
Count the accounts from a ledger
v2CountAccounts 1 param → 204
GET
/api/ledger/v2/{ledger}/accounts/{address}
Get account by its address
v2GetAccount 2 params → 200
POST
/api/ledger/v2/{ledger}/accounts/{address}/metadata
Add metadata to an account
v2AddMetadataToAccount 2 params → 204
GET
/api/ledger/v2/{ledger}/transactions
List transactions from a ledger
v2ListTransactions 1 param → 200
POST
/api/ledger/v2/{ledger}/transactions
Create a new transaction
v2CreateTransaction 1 param body → 200
HEAD
/api/ledger/v2/{ledger}/transactions
Count the transactions from a ledger
v2CountTransactions 1 param → 204
GET
/api/ledger/v2/{ledger}/transactions/{id}
Get transaction by its ID
v2GetTransaction 2 params → 200
POST
/api/ledger/v2/{ledger}/transactions/{id}/metadata
Set the metadata of a transaction by its ID
v2AddMetadataOnTransaction 2 params → 204
POST
/api/ledger/v2/{ledger}/transactions/{id}/revert
Revert a ledger transaction by its ID
v2RevertTransaction 2 params → 201
GET
/api/ledger/v2/{ledger}/aggregate/balances
Get the aggregated balances from selected accounts
v2GetBalancesAggregated 1 param → 200
GET
/api/ledger/v2/{ledger}/volumes
Get list of volumes with balances for (account/asset)
v2GetVolumesWithBalances 1 param → 200
GET
/api/ledger/v2/{ledger}/logs
List the logs from a ledger
v2ListLogs 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are V2PostTransaction (5 properties), V2Posting (4 properties). Each schema is shown below with its type and property counts.

V2Posting
object
4 properties 4 required
V2PostTransaction
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

formance-ledger-api-openapi.yml Raw ↑

Other APIs Formance publishes across the network.

Formance Auth API
Formance Orchestration API
Formance Payments API
Formance Reconciliation API
Formance Search API
Formance Wallets API
Formance Webhooks API
Where this information came from

This is an independent, third-party profile of Formance Ledger API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.