Skip to main content

Ledger APIs

In this integration mode, Open Fabric converts network events into ledger operations (debit/credit/hold/release) and calls your backend via API to apply them. You do not need to download or process clearing files.

What you build

  • Real-time authorization: Open Fabric forwards authorization requests to you; you approve/decline with sub-second latency.
  • Ledger operations: Open Fabric calls your backend to apply balance operations (debit/credit/hold/release).
  • Settlement: You receive end-of-day settlement. Open Fabric provides settlement reports to reconcile settled funds against the ledger operations performed.

What Open Fabric handles

  • Authorization: When we receive authorization requests, we ask you for approval. Successful approvals trigger the required ledger action(s).
  • Reversals and expiries: When reversals or expiries occur, Open Fabric triggers compensating ledger actions.
  • Clearing file updates: When clearing updates arrive from the network, Open Fabric reconciles the transaction and triggers any remaining ledger actions required to complete the lifecycle.

When to choose this mode

  • You want an API-first integration that fits wallet/ledger systems.
  • You prefer Open Fabric to normalize network message types and timing differences into a consistent set of operations.

Ledger operations

Open Fabric informs you when to make changes to your customers' accounts. This can be the result of a payment you've approved, but also due to reversals, expiries or clearing file updates.

Please implement the following ledger actions in your system.

ActionRequested action
debit_balanceDeducts funds from a customer’s balance for settlement.
credit_balanceAdds funds to a customer’s balance (for refunds or adjustments).
hold_balancePlaces a hold on funds in a customer’s balance (pre-authorization).
restore_balanceReleases previously held funds back to the available balance.
debit_hold_balanceDeducts an amount from previously held funds (created with hold_balance).
credit_hold_balanceAdds an amount to previously held funds (created with hold_balance).

See the Ledger operations API in our API reference for details.