v1.0.0  ·  OpenAPI 3.1

Cross-border payments,
programmatically.

VirtuaBroker is payments infrastructure for partners and B2B clients. Collect locally, pay out locally across international corridors — settlement is handled for you, over stable JSON contracts.

PRODapi.virtuabroker.com STAGEapi-stage.virtuabroker.com
first-call.sh
# 1 · get a token   2 · lock a quote
curl https://api.virtuabroker.com/v1/quotes \
  -H "Authorization: Bearer $VB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "originCurrency": "EUR",
    "destinationCurrency": "BRL",
    "originAmount": 1000
  }'

Core concepts

Four primitives power every integration.

Quote

A real-time price lock for a currency pair. No customer identity needed. Expires after a short window.

Order

Binds a quote to a customer: collect origin funds, convert at the locked rate, pay out to the destination.

Deposit

How funds enter. Fiat returns a reference or IBAN; crypto an on-chain address. Balance credits on receipt.

Withdrawal

A standalone payout from an existing balance to a fiat or crypto destination.

The payment lifecycle

A cross-border payment moves through five observable states. You drive the first two; you observe the rest via order status and webhooks.

Quote

Lock a rate + fees.

Order

Commit with a destination.

Collection

Funds collected locally.

Settlement

Handled internally.

Payout

Beneficiary paid locally.

Start here

The fastest paths to a working integration.

Base URLs & responses

Base URLs

PROD  https://api.virtuabroker.com

STAGE  https://api-stage.virtuabroker.com

Common responses

200 Success  ·  400 Validation error

404 Not found  ·  503 Operational / upstream error

Errors carry a stable error type — see the taxonomy →

Need credentials? The API is onboarded per workspace — request access & book an onboarding call to get your keys. All examples in these docs use placeholders — no real secrets or data.