Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nxos.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

An account is the central resource in the Nxos platform. Every organization starts with one primary account created automatically during onboarding. Accounts hold multi-currency balances and are the source and destination for all financial operations — trades, payouts, and deposits.

​
Account structure

{
  "object": "account",
  "accountId": "acct_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "name": "Main",
  "description": null,
  "isPrimary": true,
  "status": "ACTIVE",
  "fundingMethods": [],
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

​
Statuses

StatusDescription
ACTIVENormal operation. Can hold balances and process transactions.
SUSPENDEDTemporarily frozen. Balances are preserved but no new transactions are allowed.
CLOSEDPermanently closed. Cannot be reopened.

​
Balances

Retrieve an account by ID to see its current balances: 
curl https://api.sandbox.nxos.io/v1/accounts/acct_a1b2c3d4... \
  -H "Authorization: Bearer nxos_sk_test_..."

{
  "object": "account",
  "accountId": "acct_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "name": "Main",
  "isPrimary": true,
  "status": "ACTIVE",
  "balances": [
    { "object": "balance", "asset": "USD", "amount": "15000.00" },
    { "object": "balance", "asset": "USDC", "amount": "5000.000000" }
  ],
  "fundingMethods": [],
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}
Each balance entry includes the asset code and the amount in major units. Balances are fetched from the ledger in real time — the response always reflects the current state. An account only shows balances for assets it has held at some point. A newly created account with no deposits returns an empty balances array.

​
Funding methods

Funding methods represent the rails through which money enters an account — bank accounts for fiat deposits, crypto wallets for on-chain receives. They are provisioned during account setup and attached to the account automatically. 
{
  "object": "funding_method",
  "fundingMethodId": "funding_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "name": "USD Wire",
  "type": "BANK_ACCOUNT",
  "status": "ACTIVE",
  "createdAt": "2025-01-15T10:30:00.000Z"
}

​
Ownership

Accounts belong to an organization. Your API key is scoped to a single organization, so you can only access accounts within that organization. All operations that reference an accountId — creating quotes, listing beneficiaries, initiating payouts — verify ownership before proceeding.