Reference

Glossary

The shared vocabulary of the VirtuaBroker API. These are the domain terms you'll meet across quotes, orders, deposits, and payouts — defined the way the platform uses them, so requests and responses read the same everywhere.

Term	Definition
`Workspace`	The top-level tenant scope for an integrator. A workspace groups the accounts, entities, configuration, balances, and credentials your API key operates within — every request is workspace-scoped.
`Account`	An actor-level record inside a workspace — an individual user, an organisation representative, or a workspace administrator. Accounts carry roles and permissions, and are distinct from the compliance identity behind them.
`Entity`	The compliance and identity object representing a real-world individual or organisation. Entities are separate from accounts — several accounts may map to one entity — and are what KYC/KYB is performed against.
`Quote`	A time-bound price for converting one currency into another across a `corridor`, including the rate, fees, and expected amounts. A quote is workspace-scoped, needs no recipient identity, and expires after a short window — commit it by creating an `order`.
`Order`	An execution intent that turns a `quote` into a real payment, linking the pricing, destination, and lifecycle state of a single cross-border transfer. An order moves through observable statuses until it completes or fails.
`Deposit`	The reception of funds into the platform. A deposit can fund an `order` directly, top up a `balance`, or create liquidity for later use, depending on the flow.
`Trade`	The conversion step within an order where value is exchanged between currencies or assets (for example EUR → stablecoin → BRL). An order may involve one or more trades depending on the route.
`Withdrawal`	An outgoing movement of funds from a platform `balance` to an external destination. Withdrawals may settle over a fiat `rail` or a blockchain network depending on the asset.
`Payin`	The inbound leg of a transfer: local collection of funds from the payer in the origin currency and country, over a local `rail`. It is the "money in" side that funds an `order` or a `balance`.
`Payout`	The outbound leg of a transfer: local disbursement to the beneficiary in the destination currency and country. It is the "money out" side that completes the flow.
`Rail`	A specific operational path used to move funds — such as SEPA, PIX, a local bank transfer, or a blockchain network. The same currency can be reachable over multiple rails; the corridor and destination fields determine which applies.
`Provider`	The underlying bank or liquidity partner that executes part of a flow — collection, conversion, or payout — on the platform's behalf. Providers are an internal implementation detail: their identity is never exposed in the public API, which returns abstract rail and method types instead.
`Corridor`	A supported origin → destination pairing of currency and country the platform can route between, such as EUR → BRL. The available corridors determine which quotes and orders you can create.
`Settlement`	The effective completion of the transfer of value across the operational chain. Settlement can span local receipt, reconciliation, internal ledger updates, conversion, and payout — ending when the beneficiary is paid.
`Balance`	The amount of a given currency or asset the platform holds for a workspace, account, or entity context. Balances let you receive, store, and later convert or pay out funds without an immediate end-to-end transfer.
`KYC`	Know Your Customer — the identity verification performed on an individual `entity` before it can transact. It is a prerequisite compliance check, not a payment step.
`KYB`	Know Your Business — the equivalent verification for an organisation `entity`, covering the business and its ownership. Like KYC, it gates whether the entity may transact.

Use these terms exactly as defined here. The API speaks in workspace, account, and entity — not "customer", "user", or "client" — and never names the underlying bank or liquidity partner behind a rail.