/

/Ledger API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v34

latestOpenAPI 3.0.1raw.githubusercontent.com2026-01-20203250.6 KB

Other

Healthcheck endpoint the ledger (checks postgresql, sqs queue)

get/healthcheck

Response

OK

string required

All 20 operations

get Healthcheck endpoint the ledger (checks postgresql, sqs queue)
get Search agreements by query params
get Find agreement by ID
get Find agreement events by agreement ID
post Write a list of events to the ledger database
get Get list of events between a date/time range and event type
get Search payouts by gateway_account_id and state
get Get monthly performance report by gateway account. Queries transaction_summary table
get Get number of payments by transaction (payment) state
get Get platform performance report (total volume and total_amount) for the date range and transaction state. Queries transaction_summary table for stats
get Get platform performance report (total volume and total_amount) for the date range and transaction state. Queries transaction table for stats, so could be slow for large date ranges
get Get transaction summary by hour
get Get transaction summary for query params
post Redacts/Removes historical data based on `expungeOrRedactHistoricalDataConfig`. Currently redacts PII from transactions and deletes related transaction events
get Search transactions by query params. Same endpoint can be used to download CSV (with Accept header="text/csv"). Refer to code for details
get Get transaction for a gateway transaction ID
post /v1/transaction/redact-reference/{transactionExternalId}
get Get transactions (ex: refunds) related to parent transaction (payment)
get Get transaction by external ID
get Get events for transaction external ID