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.
Base URLs
| Environment | Base URL |
|---|
| Sandbox | https://api.sandbox.nxos.io |
| Production | https://api.nxos.io |
Authentication
All requests require a Bearer token in the Authorization header:
Authorization: Bearer nxos_sk_test_...
- 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")
- 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
| Method | Path | Description |
|---|
GET | /v1/accounts | List accounts |
GET | /v1/accounts/{accountId} | Get account with balances |
Quotes
| Method | Path | Description |
|---|
POST | /v1/quotes | Create a quote |
GET | /v1/quotes/{quoteId} | Get a quote |
POST | /v1/quotes/{quoteId}/execute | Execute a quote |
Beneficiaries
| Method | Path | Description |
|---|
GET | /v1/beneficiaries | List beneficiaries |
POST | /v1/beneficiaries/crypto | Create crypto beneficiary |
POST | /v1/beneficiaries/bank | Create bank beneficiary |
GET | /v1/beneficiaries/{beneficiaryId} | Get beneficiary |
PATCH | /v1/beneficiaries/{beneficiaryId} | Update beneficiary |
DELETE | /v1/beneficiaries/{beneficiaryId} | Archive beneficiary |
Payouts
| Method | Path | Description |
|---|
POST | /v1/transactions/fiat-payouts | Initiate fiat payout |
POST | /v1/transactions/crypto-payouts | Execute crypto payout |
