Skip to content
Ledger by RODMEN/A
Menu

Documentation

Guides for the Ledger API

Four guides, in reading order. Every request and response in them was captured from a running instance; none of it is illustrative.

Before you start

  • You need a key. Tenants and keys are provisioned personally: request access and we mint your first one. Request access.
  • Every response is real. Each request and reply in these guides was captured from a running instance, never written by hand.
  • Amounts are text. "100.00", never a JSON number; fields ending in _minor are whole minor units.
  • Every write carries a key. Derive it from your own record, so a retry after a timeout replays the answer instead of moving value twice.

In reading order

Guide 1

Getting started

From nothing to a posted, balanced transaction: asset types, accounts, holds and the retry protocol, every response captured from a running instance.

Guide 2

Sub-tenants

Give each of your own clients an isolated ledger: production and sandbox tenants, keys issued and revoked, suspend and restore, all through the API.

Guide 3

API reference

Every endpoint, field and error code of the Ledger API, with the retryable ones marked, plus the machine-readable OpenAPI and llms.txt contracts.

Guide 4

Authentication

How credentials work in the Ledger API: one key shape, four roles, expiry and revocation enforced by the ledger, and what to do when a key leaks.