Skip to main content

Account

An Account is a virtual financial entity within the platform — a balance holder. It can represent any party that needs to hold balance: a marketplace seller, an affiliate, or the platform's own revenue account.

An Account is not a blockchain wallet, does not imply verified legal identity, and is not the same as a human user of the admin panel (that's Member) — Account participates in money, Member operates the Organization.

External ID

An Account is referenced by an External ID — an identifier you define to correlate it with your own system, without needing to send personal data. Unique per Organization, not globally.

Balance

An Account's balance is made up of three views of the same accounting record:

  • Available — can be moved freely.
  • Pending — being confirmed (e.g., a deposit awaiting network confirmations).
  • Reserved — committed to an active Transaction.

Every transition between these three components is a new ledger entry, never a direct value edit — see Ledger. A beneficiary of a Settlement/Payout has two more views beyond these three — Payable (owed, not yet paid) and Delivered (already paid out) — read via getPayableSummary, never mixed into Available (see Transaction, Settlement, Split, and Refund).

Routes