Nxosnet

Get nxosnet settings

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.

This endpoint reads the in-scope organization’s nxosnet settings: whether receiving is enabled, the claimed handle, and name visibility. Supports Nxos-On-Behalf-Of to read a customer org’s settings.

GET

organizations

nxosnet

cURL

curl --request GET \
  --url https://api.nxos.io/v1/organizations/nxosnet \
  --header 'Authorization: <authorization>'

{
  "object": "nxosnet_settings",
  "enabled": true,
  "handle": "acme",
  "showOrganizationName": true
}

Headers

Authorization

string

required

Bearer token. Format: Bearer <api_key>

Response

The request has succeeded.

nxosnet settings for an organization.

object

enum<string>

required

Always nxosnet_settings.

Available options:

nxosnet_settings

enabled

boolean

required

Whether this organization can receive nxosnet transfers. Requires a handle to be set.

handle

string | null

required

The organization's globally-unique nxosnet handle, or null if none has been claimed yet.

showOrganizationName

boolean

required

Whether the organization's name is shown to senders who look up its handle.

Execute crypto payout

Update nxosnet settings

cURL

curl --request GET \
  --url https://api.nxos.io/v1/organizations/nxosnet \
  --header 'Authorization: <authorization>'

{
  "object": "nxosnet_settings",
  "enabled": true,
  "handle": "acme",
  "showOrganizationName": true
}