# Nxos

> Nxos API documentation — programmatic access to fiat and crypto accounts, quotes, beneficiaries, and payouts.

- [Nxos API documentation](https://docs.nxos.io/index.md): Programmatic access to accounts, quotes, trades, and payouts.
- [Authentication](https://docs.nxos.io/concepts/authentication.md): API key management and request authentication.
- [Conventions](https://docs.nxos.io/concepts/conventions.md): Amounts, pagination, timestamps, and other API-wide patterns.
- [Accounts](https://docs.nxos.io/concepts/accounts.md): Accounts hold balances and serve as the source for all transactions.
- [Assets and amounts](https://docs.nxos.io/concepts/assets-and-amounts.md): How the API represents currencies, amounts, and precision.
- [Beneficiaries](https://docs.nxos.io/concepts/beneficiaries.md): Recipients for payouts — crypto wallets and bank accounts.
- [Idempotency and rate limits](https://docs.nxos.io/concepts/idempotency-and-rate-limits.md): Safe retries with the Idempotency-Key header, and the per-organization request quota.
- [Errors](https://docs.nxos.io/concepts/errors.md): Error response format and error codes.
- [Webhooks](https://docs.nxos.io/concepts/webhooks.md): Receive nxos events in real time, verify them, and handle retries.
- [Onramp: fiat to crypto](https://docs.nxos.io/guides/onramp.md): Accept fiat currency, convert to a stablecoin, and send it on-chain.
- [Offramp: crypto to fiat](https://docs.nxos.io/guides/offramp.md): Receive crypto, convert to fiat currency, and pay out to a bank account.
- [Verification: bringing an org through KYB](https://docs.nxos.io/guides/verification.md): Start, check, and complete an organization's verification flow using Sumsub-backed sessions.
- [Cross-org access: brokers acting on customer accounts](https://docs.nxos.io/guides/cross-org-access.md): How Letters of Authorization let one organization operate the API on behalf of another.
- [Partner sign-up links: send your customers to nxos](https://docs.nxos.io/guides/partner-sign-up-links.md): Issue a sign-up link bound to your customer's email, so the nxos account opens on exactly that address and is attributed to you.
- [API reference](https://docs.nxos.io/api-reference/introduction.md): Complete reference for all Nxos API endpoints.
- [Get organization](https://docs.nxos.io/api-reference/organizations/get.md): Retrieve the organization currently in scope.
- [Create organization](https://docs.nxos.io/api-reference/organizations/create.md): Create a child organization owned by the calling org.
- [Get verification](https://docs.nxos.io/api-reference/organizations/get-verification.md): Read the verification record for the in-scope organization.
- [Start verification](https://docs.nxos.io/api-reference/organizations/start-verification.md): Start (or refresh) a verification session for the in-scope organization. Returns a Sumsub-hosted URL plus a short-lived access token for embedding the WebSDK in your own UI.
- [Import verification](https://docs.nxos.io/api-reference/organizations/import-verification.md): Import a verification for the in-scope organization from a donor's Sumsub share token (Reusable KYC).
- [List accounts](https://docs.nxos.io/api-reference/accounts/list.md): List all active accounts belonging to your organization, including their attached funding methods. Results are ordered by creation date, newest first.
- [Get account](https://docs.nxos.io/api-reference/accounts/get.md): Retrieve a single account by ID, including its current balances and attached funding methods. Balances are fetched from the ledger in real time.
- [List available assets](https://docs.nxos.io/api-reference/assets/list.md): List the assets your organization can receive. Any asset returned here can be passed to `POST /v1/funding-methods` to get its deposit details.
- [List funding methods](https://docs.nxos.io/api-reference/funding-methods/list.md): List funding methods for an account, with full deposit details (crypto address + wire instructions) for each.
- [Get a funding method](https://docs.nxos.io/api-reference/funding-methods/get.md): Retrieve a single funding method by ID.
- [Create a funding method](https://docs.nxos.io/api-reference/funding-methods/create.md): Create the funding methods for an asset on an account. This provisions the receiving methods it needs (deriving crypto deposit addresses per chain and/or wiring the bank virtual accounts that serve the asset) and enables the ledger balance.
- [Create quote](https://docs.nxos.io/api-reference/quotes/create.md): Create an exchange quote between two assets. Specify either `fromAmount` (how much to sell) or `toAmount` (how much to receive), not both. Quotes expire after 5 minutes.
- [Get quote](https://docs.nxos.io/api-reference/quotes/get.md): Retrieve a quote by its identifier.
- [Execute quote](https://docs.nxos.io/api-reference/quotes/execute.md): Execute a pending quote. The quote must not be expired or already executed. On success, the trade is completed atomically and the balances are updated.
- [List beneficiaries](https://docs.nxos.io/api-reference/beneficiaries/list.md): List beneficiaries for an account, optionally filtered by type. Returns crypto and bank beneficiaries in a single flat list.
- [Create crypto beneficiary](https://docs.nxos.io/api-reference/beneficiaries/create-crypto.md): Create a crypto beneficiary for an account.
- [Create bank beneficiary](https://docs.nxos.io/api-reference/beneficiaries/create-bank.md): Create a bank beneficiary for an account.
- [Create nxosnet beneficiary](https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet.md): Create an internal NXOS→NXOS beneficiary for an account, resolved by the target organization's nxosnet handle. The target must have NXOS transfers enabled. Use the returned beneficiary as the recipient for `POST /v1/transactions/nxosnet-transfers`.
- [Get beneficiary](https://docs.nxos.io/api-reference/beneficiaries/get.md): Retrieve a beneficiary by its identifier. The beneficiary type is resolved automatically.
- [Update beneficiary](https://docs.nxos.io/api-reference/beneficiaries/update.md): Update a beneficiary's details.
- [Archive beneficiary](https://docs.nxos.io/api-reference/beneficiaries/archive.md): Archive (soft-delete) a beneficiary. The record is preserved for audit purposes.
- [List transactions](https://docs.nxos.io/api-reference/transactions/list.md): List transactions across one or more of your accounts.
- [Get a transaction](https://docs.nxos.io/api-reference/transactions/get.md): Retrieve a single transaction by ID. Returns 404 if the transaction doesn't exist or isn't on one of your accounts.
- [Initiate fiat payout](https://docs.nxos.io/api-reference/fiat-payouts/initiate.md): Initiate a fiat payout from an account to a bank beneficiary. Funds are debited and locked immediately. The transaction enters LOCKED status and awaits provider execution.
- [Get fiat payout options](https://docs.nxos.io/api-reference/fiat-payouts/options.md): List the values a fiat payout can be built from.
- [Execute crypto payout](https://docs.nxos.io/api-reference/crypto-payouts/execute.md): Execute a crypto payout from an account to a crypto beneficiary. Funds are debited immediately and the payout is processed on-chain. The response `status` is `LOCKED` (pending); `txHash` is present once the transaction is broadcast. Chain confirmation is asynchronous: clients should poll `GET /v1/tr…
- [Get nxosnet settings](https://docs.nxos.io/api-reference/organizations/get-nxosnet.md): nxosnet is the internal NXOS-to-NXOS transfer network: an organization claims a unique handle and enables nxosnet to receive instant, ledger-settled transfers from other NXOS organizations: no external rails. Senders resolve a handle, add it as a beneficiary, and send.
- [Update nxosnet settings](https://docs.nxos.io/api-reference/organizations/update-nxosnet.md): Enable or disable nxosnet for the in-scope organization, claim or change its handle, and set name visibility. Every field is optional.
- [Resolve nxosnet handle](https://docs.nxos.io/api-reference/nxosnet-transfers/resolve-handle.md): Resolve a nxosnet handle to its owning organization. Call this before creating a beneficiary to confirm who a handle belongs to and whether they can currently receive transfers.
- [Send nxosnet transfer](https://docs.nxos.io/api-reference/nxosnet-transfers/send.md): Send an internal Nxosnet transfer from an account to an `NXOSNET` beneficiary. Funds move directly between the two Nxosnet accounts as ledger entries — there is no external rail — so the transfer settles instantly and the response `status` is `COMPLETED`.
- [Crypto payout fee](https://docs.nxos.io/api-reference/fees/crypto-payout.md): Fee schedule for a crypto payout on a given chain and asset. Use at quote/display time; echo the returned `fixed` + `bps` on the payout submit as `expectedFeeSchedule` to guard against config drift.
- [Fiat payout fee](https://docs.nxos.io/api-reference/fees/fiat-payout.md): Fee schedule for a fiat payout. Use at quote/display time to show the user what they'll be charged. Echo the returned `fixed` + `bps` on the payout submit as `expectedFeeSchedule` to guard against config drift between quote and submit.
- [List endpoints](https://docs.nxos.io/api-reference/webhooks/list.md): List the calling organization's webhook endpoints.
- [Create endpoint](https://docs.nxos.io/api-reference/webhooks/create.md): Register a webhook endpoint for the calling organization.
- [Get endpoint](https://docs.nxos.io/api-reference/webhooks/get.md): Retrieve a webhook endpoint by id.
- [Update endpoint](https://docs.nxos.io/api-reference/webhooks/update.md): Update a webhook endpoint.
- [Delete endpoint](https://docs.nxos.io/api-reference/webhooks/delete.md): Delete a webhook endpoint.
- [Get signing secret](https://docs.nxos.io/api-reference/webhooks/get-secret.md): Fetch an endpoint's signing secret, used to verify webhook signatures.
- [Rotate signing secret](https://docs.nxos.io/api-reference/webhooks/rotate-secret.md): Rotate an endpoint's signing secret. The previous secret stops verifying immediately.
- [List authorizations](https://docs.nxos.io/api-reference/authorizations/list.md): List authorizations the caller is a party to (either side), newest first. Use `role` to split the two intuitive views:
- [Revoke authorization](https://docs.nxos.io/api-reference/authorizations/revoke.md): Revoke a previously-issued authorization between two organizations.
- [Create referral invite](https://docs.nxos.io/api-reference/referral-invites/create.md): Issue a sign-up link for one of your customers.
- [List referral links](https://docs.nxos.io/api-reference/referral-links/list.md): List your referral links.
- [Fund a test balance](https://docs.nxos.io/api-reference/sandbox/faucet.md): Simulate a crypto deposit into an account's provisioned deposit address. Credits the ledger immediately and returns a `COMPLETED` `CRYPTO_PAYIN` transaction — no real on-chain transfer is required. Use it to fund test accounts and exercise the full pay-in → balance → pay-out loop.

## OpenAPI Specs

- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.