Check Ledger Routing Readiness
Use this endpoint to check whether this tenant is ready for ledger-scoped routing. The report lists one line per Midaz organization, ledger, and transfer type:
- Every tuple that has carried a transfer, whatever its outcome.
transferCountmeasures traffic, not settlement. - Every tuple that the chargeback path demands although nothing has transferred on it and no binding addresses it (
transferCount0): the inbound tuple that everyTED_OUTledger owes for the refund (derivedFrom: ted_out_refund), and the outbound tuple that everyTED_INledger owes for the compensation (derivedFrom: ted_in_compensation). - One organization-level line per Midaz organization that the tenant registered to receive inbound TED and that has no inbound binding at any ledger (
derivedFrom: ispb_onboarded_organization).ledgerIdis empty, because the recipient account record decides the ledger when the credit arrives. Any inbound line for that organization answers the demand, and the line disappears.
Both chargeback tuples are demanded of a ledger that the configuration only declares, in either mode, as well as of one that has carried traffic. Once a binding answers the demand, the line is reported as a configured scope with no derivedFrom, and it is still judged. ready is true only when every line clears. A declared scope, and the chargeback counterpart of a declared binding, are judged like any other line, because a binding is a promise about money that the operator intends to move, and a route that does not verify on it holds or refuses that ledger’s first transfer. An explicit mode: omit answers any line, because it posts with the route fields left off, and a chargeback against money that landed unrouted posts back unrouted. The one pairing that it cannot express, a ledger that routes its incoming credits while it declares their compensation unrouted, is refused when the configuration is read and never reaches this report.
The report also lists the bindings that the configuration carries, each with whether a binding covers it and whether the accounting routes it names exist inside that exact scope in Midaz. legacyPendingInitiations counts the live initiations still pending from before ledger-scoped routing, which this service answers with 409 (BTF-0112). readbackBudgetExhausted is false for every configuration that the contract accepts. A true value means a service defect: report it instead of retrying. The scopes past the budget then read unavailable.
This is a read-only administrative endpoint. It never writes the configuration and never moves money. It does not require the X-Organization-Id header. In multi-tenant deployments the report is scoped to the caller’s resolved tenant.
Authorizations
JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.
Response
Indicates that the readiness report was returned.
true only when every line in scopes clears.
false
absent, sentinel, empty, bindings "bindings"
Live initiations still pending from before ledger-scoped routing.
2
false for every configuration that the contract accepts. true means a service defect; the scopes past the budget read unavailable.
false

