Central Ledger API Documentation

Version: 1.0

Summary

Tag: enums

Operation	Description
GET /enums

Tag: health

Operation	Description
GET /health

Tag: metrics

Operation	Description
GET /metrics	Prometheus metrics endpoint

Tag: participants

Operation	Description
GET /participants
POST /participants
GET /participants/limits	View limits for all participants
GET /participants/{name}
PUT /participants/{name}
GET /participants/{name}/endpoints	View participant endpoints
POST /participants/{name}/endpoints	Add/Update participant endpoints
GET /participants/{name}/limits	View participant limits
PUT /participants/{name}/limits	Adjust participant limits
GET /participants/{name}/positions	View participant positions
GET /participants/{name}/accounts	View participant accounts and balances
POST /participants/{name}/accounts	Create hub accounts
POST /participants/{name}/initialPositionAndLimits	Add initial participant limits and position
POST /participants/{name}/accounts/{id}	Record Funds In or Out of participant account
PUT /participants/{name}/accounts/{id}	Update participant accounts
PUT /participants/{name}/accounts/{id}/transfers/{transferId}	Record Funds In or Out of participant account

Tag: ledgerAccountTypes

Operation	Description
GET /ledgerAccountTypes	View all ledger account types

Tag: ledgerAccountType

Operation	Description
POST /ledgerAccountTypes	Create a ledgerAccount type

Tag: settlementModels

Operation	Description
GET /settlementModels	View all settlement models
POST /settlementModels	Create a settlement model. This will create any associated ledgerAccountTypes for every participant that matches the settlementModel's currency
GET /settlementModels/{name}	View settlement model by name
PUT /settlementModels/{name}	Update a settlement model

Tag: transaction

Operation	Description
GET /transactions/{id}	Retrieve transaction details by a transferId

Paths