Omni Way developer docs v1.0.0
Products ยท Payouts & Balance

Payouts & Balance

Every settled payment grows your balance; payouts move it to your own InnBucks wallet. Underneath is an append-only ledger โ€” every cent has a line, nothing is ever edited or deleted, and your balance is always the sum of the lines.

Balance

curl https://omniway.online/v1/balance \
  -H "Authorization: Bearer sk_live_..."
# โ†’ { "object":"balance", "livemode":true,
#     "USD": { "available_cents": 184550 }, "ZWG": { "available_cents": 0 } }

available_cents is spendable now โ€” pending payouts are already deducted, so what you see is what you can move.

The ledger

Every money event writes one or more signed entries (positive = credit, negative = debit):

Entry typeSignWritten when
payment+A payment settles (gross amount)
platform_feeโˆ’Same moment โ€” your fee on that payment
payoutโˆ’You request a payout (reserved immediately)
payout_reversal+A payout fails or is reversed โ€” compensating credit, the original line stays
agent_withdrawal+A cash-out code is redeemed at your till
bank_changeโˆ’You send change to a customer wallet
utility_sale / utility_commissionโˆ’ / +You sell airtime/utilities; commission credited back
adjustmentยฑA documented manual correction by the platform (always carries a reason)
curl "https://omniway.online/v1/ledger?entry_type=payment&from=2026-06-01" \
  -H "Authorization: Bearer sk_live_..."

CSV statement

curl -OJ "https://omniway.online/v1/statement.csv?from=2026-06-01&to=2026-06-30" \
  -H "Authorization: Bearer sk_live_..."
# date,entry_type,currency,amount,balance,source_type,source_id,note

Each row carries a running balance โ€” hand it straight to your accountant. The same export is one click in the dashboard.

Request a payout

curl https://omniway.online/v1/payouts \
  -H "Authorization: Bearer sk_live_..." -H "Content-Type: application/json" \
  -H "Idempotency-Key: payout-2026-06-11" \
  -d '{"amount_cents": 50000, "currency": "USD"}'
โ—†
No destination parameter โ€” by design

Payouts go only to the InnBucks wallet the platform verified against your national ID at onboarding. A leaked API key can drain nothing to an attacker's wallet. To change wallets, contact the platform team for re-verification.

Payout lifecycle

requested

Reserved

Funds debited from your balance instantly โ€” no double-spending the same cents.

โ†’
submitted

At InnBucks

The deposit is on its way to your wallet.

โ†’
confirmed

Landed

Verified in your wallet. payout.confirmed fires. Typically minutes; definitive within 30.

If InnBucks rejects the deposit the payout becomes failed, a compensating payout_reversal credit restores your balance automatically, and payout.failed fires with the reason. The rare platform-initiated reversal of a confirmed payout follows the same pattern (reversed + credit + payout.reversed).

Guarantees

  • No overdrafts. Concurrent payout requests are serialized; only requests that fit your balance succeed (402 insufficient_funds otherwise).
  • No double-moves. Same Idempotency-Key โ†’ same single payout, no matter how many retries.
  • Nothing disappears. Failures compensate with new entries; your statement always adds up.
  • Nightly reconciliation. The platform ties its ledger to the InnBucks master statement every night; discrepancies are chased by the platform team, not you.

Omni Way is the financial core; your storefront or till is the surface it powers. Integrate once and the same ledger, payouts and reporting work across every product you adopt.

omniway.online ยท InnBucksPowered by InnBucks (MicroBank Limited) ยท USD & ZWG.