0Bit Documentation

Settlement tracking

Track 0Gate session, transaction, webhook, and settlement-aware records without exposing provider or treasury internals.

Settlement tracking is the operational view of a 0Gate flow after the user has completed hosted steps. It joins your order or ledger record to 0Gate session ids, transaction refs, webhook event ids, request ids, timestamps, and, where your account is enabled, rail or settlement-aware records.

Tracking model

Records to store

RecordSourceWhy
Partner order idYour backendPrimary id for your support and ledger.
user_referenceSession create request and webhook dataCorrelates 0Gate events to your record.
Session id0Gate session responseAnchors the hosted attempt.
Transaction refCompletion event or transaction API where availableHelps investigate payment/ramp outcomes.
local_rail_transaction_idTransaction or receipt API where availableRail-side reference for local payment or payout records. Prefer this over deprecated rail-specific aliases.
Event idWebhook header or payloadDedupe key and audit trace.
Request idAPI response headers or error envelopeUseful for support escalation.
EnvironmentKey mode and API hostPrevents mixing sandbox and live records.

What to show users

User-facing stateBackend evidence
PendingSession open, processing event, return URL reached without terminal backend event, or delayed delivery.
CompletedVerified completion event and your idempotent ledger update.
FailedVerified failed event, unrecoverable API state, or manual support resolution.
CancelledVerified cancel event or your own cancellation action.
ExpiredSession expires_at passed or expired event processed.

Do not publish

  • Provider identities, bank or rail internals, treasury operations, reserve movements, or reconciliation runbooks.
  • Raw customer identity data, card/bank details, or provider payloads.
  • Settlement SLAs, payout timing, or live availability that is not approved for the partner and market.
  • Internal ledger table names, admin routes, or operator-only dashboards.

Support escalation package

When contacting support@0bit.io, include support-safe values:

  • Partner account or environment.
  • Your order id or user_reference.
  • 0Gate session id.
  • Transaction ref if present.
  • Local-rail transaction id if present.
  • Webhook event id and delivery id if relevant.
  • Timestamp and symptom.
  • Redacted request id or error code.

On this page