Skip to main content

​
Base URLs

EnvironmentBase URL
Sandboxhttps://api.sandbox.nxos.io
Productionhttps://api.nxos.io
Both environments expose the same endpoints. Use sandbox for development and testing — no real funds are involved.

​
Authentication

All requests require a Bearer token in the Authorization header: 
Authorization: Bearer nxos_sk_test_...
See Authentication for details on key management.

​
Request format

  • Request bodies use Content-Type: application/json
  • All IDs are prefixed strings (e.g., acct_, bene_, quote_, txn_)
  • Amounts are decimal strings in major units (e.g., "10.50")

​
Response format

  • Successful responses return the resource directly (single object) or a paginated list
  • Error responses follow a standard envelope with code, message, and requestId
  • Every object includes an object field identifying its type

​
Endpoints

​
Accounts

MethodPathDescription
GET/v1/accountsList accounts
GET/v1/accounts/{accountId}Get account with balances

​
Quotes

MethodPathDescription
POST/v1/quotesCreate a quote
GET/v1/quotes/{quoteId}Get a quote
POST/v1/quotes/{quoteId}/executeExecute a quote

​
Beneficiaries

MethodPathDescription
GET/v1/beneficiariesList beneficiaries
POST/v1/beneficiaries/cryptoCreate crypto beneficiary
POST/v1/beneficiaries/bankCreate bank beneficiary
GET/v1/beneficiaries/{beneficiaryId}Get beneficiary
PATCH/v1/beneficiaries/{beneficiaryId}Update beneficiary
DELETE/v1/beneficiaries/{beneficiaryId}Archive beneficiary

​
Payouts

MethodPathDescription
POST/v1/transactions/fiat-payoutsInitiate fiat payout
POST/v1/transactions/crypto-payoutsExecute crypto payout