Skip to main content

Atlas Wallet Service

The Atlas Wallet Service provides core account and multi-currency ledger management for your platform entity and client sub-companies.

With Atlas wallets, businesses can hold balances across 100+ global fiat currencies, fund cross-border FX trades, collect inbound virtual IBAN deposits, disburse payouts, and query real-time running balance statements.

flowchart TD
subgraph Inbound["Inbound Funding"]
IBAN["Virtual IBAN Deposit (EUR/GBP/USD)"]
FX["FX Trade Settlement (Buy Currency)"]
TopUp["Internal Liquidity Top-Up"]
end

subgraph WalletCore["Atlas Wallet Engine"]
Wallet["Multi-Currency Wallet (e.g. USD, EUR, GBP)"]
Ledger["Double-Entry Statement Ledger"]
Split["Split Payment Guardrails"]
end

subgraph Outbound["Outbound Uses"]
Payout["External Bank Payout (/payments/create)"]
Transfer["Inter-Wallet Sweep (/transfer)"]
Sell["FX Conversion Source (/fx/payments)"]
end

IBAN --> Wallet
FX --> Wallet
TopUp --> Wallet
Wallet <--> Ledger
Wallet --> Split
Split --> Payout
Wallet --> Transfer
Wallet --> Sell

Key Features

  • Multi-Currency Treasury: Create segregated wallets for major and exotic currencies (e.g. USD, EUR, GBP, AED, CAD, SGD).
  • Real-Time Balances: Distinctly track totalBalance and availableBalance to prevent overdrafts while settlement holds are active.
  • Wallet Types:
    • standard: General treasury and operating balance wallet.
    • fx_balance: Specialized wallet dedicated to FX trade conversions and exchange liquidity.
  • Split Payments & Limits: Configure wallets with isSplitPaymentEnabled and splitPaymentLimit for automated multi-source settlement.
  • Ledger Statements: Extract paginated statement transaction histories with exact timestamps, descriptions, references, and running balances.

Wallet Types & Funding Classifications

ParameterValuesDescription
typestandard, fx_balanceFunctional wallet category (standard operating wallet vs fx_balance dedicated exchange balance).
fundingTypeaccount, smartWallet, pooled, nullUnderlying account backing structure.
isBillingWallettrue, falseSpecifies whether platform billing and subscription fees debit from this wallet.
isDefaulttrue, falseDefault settlement wallet designated for the given currency.

Available Endpoints

EndpointMethodOperation IDDescription
/{companyId}/walletsGETget_company_walletsFetch all wallets for a company with currency, type, and balance filters
/{companyId}/walletsPOSTcreate_walletProvision a new multi-currency wallet with custom reference label
/wallets/{walletId}/fetch-statementsGETfetch_wallet_statementsRetrieve historical transaction statements and running balances

Authentication

All endpoints require a valid JWT Bearer access token obtained via the Atlas Login endpoint:

Authorization: Bearer <your_jwt_access_token>