API Reference

API Reference

Complete REST API reference for the Minka Ledger. Browse endpoints by resource.

Auth

OAuth 2.0 client-credentials token exchange — obtain a Bearer token to authenticate all subsequent requests.

Wallets

Ledger accounts identified by a handle (e.g. `svgs:10000001@bancorojo.com.co`), typed by schema and optionally bound to an external bank account via a bridge.

Intents

Signed payment instructions composed of one or more claims (`transfer`, `issue`, `destroy`, `limit`) that progress through states — `pending` → `prepared` → `committed` → `completed` or `rejected`.

Anchors

External payment identifiers mapped to wallets — EMVCo QR v1.4 codes (`emvco-v14-co`) and Bre-B Llaves (`alias`) including `mailto:`, `tel:`, `nidn:`, `merchid:`, and dynamic `key:` types.

Effects

Subscriptions that react to ledger signals — deliver the event payload to a webhook endpoint or a bridge. Supports all ledger signals (`balance-received`, `intent-updated`, `wallet-created`, `signer-updated`, and 50+ more) with optional dot-path filters for fine-grained targeting.

Schemas

JSON Schema record-type definitions that govern the allowed `custom` fields on wallets, anchors, intents, signers, and policies.

Symbols

Currency and asset definitions — `cop` (factor 100, centavos) is the settlement symbol for the Colombian ecosystem; all amounts are integers in the smallest unit.

Circles

Named signer groups (`owner`, `admin`, `operations`, `security`, `support`, `services`) used in access-control policies to grant permissions to sets of Ed25519 keys.

Policies

Ledger-wide access rules that define which signers (via circles) can perform which operations on which record types.

Bridges

Configurations that connect the ledger to external financial systems — a bridge declares its capabilities (`debits`, `credits`, `anchors`, `events`) and the URL of your bridge server.

Signers

Ed25519 public keys registered on the ledger and assigned to circles — used to verify the cryptographic proof attached to every write request.

Bridge Server

Endpoints your bridge server must implement to participate in the two-phase commit protocol — the ledger calls these to prepare and commit debits and credits on external bank accounts.

On this page

No Headings