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.
Arbitrary metadata (max 50 keys, max 4 KB serialized).
Show child attributes
Response
The request has succeeded.
A beneficiary (recipient) registered for payouts from an account.
All responses share this shape — the type field indicates which detail
object (crypto or bank) is populated; the other will be null.
Shared identity fields may be null in list and create responses.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Nxos","description":"Nxos API documentation — programmatic access to fiat and crypto accounts, quotes, beneficiaries, and payouts.","colors":{"primary":"#38bdf8","light":"#38bdf8","dark":"#06b6d4"},"logo":{"light":"https://mintcdn.com/nxos-f4022d2e/1BbvSIMfTEn6iDBa/logo/light.svg?fit=max\u0026auto=format\u0026n=1BbvSIMfTEn6iDBa\u0026q=85\u0026s=cfc2eecff02a32cd44c0881bd70c3a30","dark":"https://mintcdn.com/nxos-f4022d2e/1BbvSIMfTEn6iDBa/logo/dark.svg?fit=max\u0026auto=format\u0026n=1BbvSIMfTEn6iDBa\u0026q=85\u0026s=033a925c67253f47202d17ebeb53a176","href":"https://nxos.io"},"favicon":"https://mintcdn.com/nxos-f4022d2e/1BbvSIMfTEn6iDBa/favicon.svg?fit=max\u0026auto=format\u0026n=1BbvSIMfTEn6iDBa\u0026q=85\u0026s=ce7e79c898639fe2510ebe1f9b3bb268","api":{"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":["https://api.sandbox.nxos.io","https://api.nxos.io"]}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.nxos.io"}},"footer":{},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nxos-f4022d2e","hasAudioNarration":false,"actualSubdomain":"nxos-f4022d2e","customDomains":["docs.nxos.io"],"gitSource":{"type":"github","owner":"nxosio","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad207aa206131ce55e48732","collectionId":"06a479dc-b2e9-4100-9f7b-364becff6fa9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad207aa206131ce55e48732"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae42d85005ec163c6a97813","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API reference","count":55},{"language":"default","tag":"Move money","count":19},{"language":"default","tag":"Track","count":19},{"language":"default","tag":"Documentation","count":15},{"language":"default","tag":"Setup","count":11},{"language":"default","tag":"Beneficiaries","count":7},{"language":"default","tag":"Webhooks","count":7},{"language":"default","tag":"Core concepts","count":6},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Payouts","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/beneficiaries/create-nxosnet","slug":"/api-reference/beneficiaries/create-nxosnet","pageMetadata":{"title":"Create nxosnet beneficiary","openapi":"POST /v1/beneficiaries/nxosnet","description":"Create an internal NXOS→NXOS beneficiary for an account, resolved by the\ntarget organization's nxosnet handle. The target must have NXOS transfers\nenabled. Use the returned beneficiary as the recipient for\n`POST /v1/transactions/nxosnet-transfers`.","href":"/api-reference/beneficiaries/create-nxosnet"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Create an internal NXOS→NXOS beneficiary for an account, resolved by the\\ntarget organization’s nxosnet handle. The target must have NXOS transfers\\nenabled. Use the returned beneficiary as the recipient for\\n\", _jsx(_components.code, {\n children: \"POST /v1/transactions/nxosnet-transfers\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create nxosnet beneficiary","openapi":"POST /v1/beneficiaries/nxosnet","description":"Create an internal NXOS→NXOS beneficiary for an account, resolved by the\ntarget organization's nxosnet handle. The target must have NXOS transfers\nenabled. Use the returned beneficiary as the recipient for\n`POST /v1/transactions/nxosnet-transfers`.","href":"/api-reference/beneficiaries/create-nxosnet"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"Beneficiaries_createNxosnet","description":"Create an internal NXOS→NXOS beneficiary for an account, resolved by the\ntarget organization's nxosnet handle. The target must have NXOS transfers\nenabled. Use the returned beneficiary as the recipient for\n`POST /v1/transactions/nxosnet-transfers`.","parameters":["cf9ede13-b37d-4b81-b6d4-93729e8bda04","7c747ca3-fccf-411c-afb8-e4ea38ba0b1b"],"responses":{"200":"bec6ab70-3939-459b-b6ef-8ef696df660d","400":"c7365c44-0735-4358-b882-158f610ab114","401":"d9846847-7de3-4b37-ad23-82f947e00ea5","403":"089bc133-4e13-4020-aaeb-9a00fd41baf2","404":"be01e239-286c-4f5d-92f7-3cde89d0c45f","409":"23f26954-5f82-4101-8f89-29263fe82f27","422":"9e63816f-4d31-415a-9917-eabe0ba82e4e","429":"bbaf6b4a-0ad8-4295-9f7b-2244f85fd020","500":"6354c828-8d24-4201-b269-13651f3ee5de"},"tags":["Beneficiaries"],"requestBody":"daabe11a-5da0-4847-8747-02dfdeb061db","method":"post","type":"path","servers":["5080e5aa-085b-455e-be8f-c1c3b3837b09","e8851a56-d3fb-4a47-b75d-91f511378ca3"],"security":[],"path":"/v1/beneficiaries/nxosnet","baseUrlOptions":["https://api.nxos.io","https://api.sandbox.nxos.io"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cf9ede13-b37d-4b81-b6d4-93729e8bda04":{"name":"Authorization","in":"header","required":true,"description":"Bearer token. Format: `Bearer \u003capi_key>`","schema":{"type":"string","isRequired":true,"description":"Bearer token. Format: `Bearer \u003capi_key>`","uniqueKey":"","typeLabel":"string"}},"7c747ca3-fccf-411c-afb8-e4ea38ba0b1b":{"name":"Idempotency-Key","in":"header","required":false,"description":"Unique key per logical operation. UUID v4 recommended. Max 255 characters.","schema":{"type":"string","isRequired":false,"description":"Unique key per logical operation. UUID v4 recommended. Max 255 characters.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId","nickname","targetHandle"],"properties":{"accountId":{"type":"string","description":"Account to register this beneficiary for.","isRequired":true,"uniqueKey":"accountId","typeLabel":"string"},"nickname":{"type":"string","description":"Display name for the beneficiary.","isRequired":true,"uniqueKey":"nickname","typeLabel":"string"},"targetHandle":{"type":"string","description":"The target organization's claimed nxosnet handle.","isRequired":true,"uniqueKey":"targetHandle","typeLabel":"string"},"entityType":{"type":"string","enum":["INDIVIDUAL","BUSINESS"],"description":"Entity type.","uniqueKey":"entityType","typeLabel":"enum\u003cstring>"},"email":{"type":"string","description":"Email address.","uniqueKey":"email","typeLabel":"string"},"phoneNumber":{"type":"string","description":"Phone number.","uniqueKey":"phoneNumber","typeLabel":"string"},"firstName":{"type":"string","description":"First name (individuals).","uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Last name (individuals).","uniqueKey":"lastName","typeLabel":"string"},"legalName":{"type":"string","description":"Legal name.","uniqueKey":"legalName","typeLabel":"string"},"dateOfBirth":{"type":"string","description":"Date of birth (YYYY-MM-DD).","uniqueKey":"dateOfBirth","typeLabel":"string"},"businessName":{"type":"string","description":"Business name (businesses).","uniqueKey":"businessName","typeLabel":"string"},"registrationNumber":{"type":"string","description":"Registration / incorporation number.","uniqueKey":"registrationNumber","typeLabel":"string"},"addressLine1":{"type":"string","description":"Address line 1.","uniqueKey":"addressLine1","typeLabel":"string"},"addressLine2":{"type":"string","description":"Address line 2.","uniqueKey":"addressLine2","typeLabel":"string"},"city":{"type":"string","description":"City.","uniqueKey":"city","typeLabel":"string"},"region":{"type":"string","description":"Region / state / province.","uniqueKey":"region","typeLabel":"string"},"zipCode":{"type":"string","description":"ZIP / postal code.","uniqueKey":"zipCode","typeLabel":"string"},"country":{"type":"string","description":"Country code (ISO 3166-1 alpha-2).","uniqueKey":"country","typeLabel":"string"},"taxId":{"type":"string","description":"Tax ID.","uniqueKey":"taxId","typeLabel":"string"},"taxIdType":{"type":"string","description":"Tax ID type (e.g., `SSN`, `TIN`).","uniqueKey":"taxIdType","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"description":"Free-form tags (max 20 tags, each up to 100 characters).","uniqueKey":"tags","typeLabel":"string[]"},"metadata":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.additionalProperties","typeLabel":"any"},"description":"Arbitrary metadata (max 50 keys, max 4 KB serialized).","uniqueKey":"metadata","typeLabel":"object"}},"description":"Request body for creating an internal NXOS→NXOS beneficiary.","example":{"accountId":"acct_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","nickname":"Acme Corp","targetHandle":"acme"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"accountId":"acct_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","nickname":"Acme Corp","targetHandle":"acme"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bec6ab70-3939-459b-b6ef-8ef696df660d":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"type":"object","required":["object","beneficiaryId","accountId","type","nickname","status","blockReason","entityType","email","phoneNumber","firstName","lastName","businessName","country","addressLine1","addressLine2","city","region","zipCode","crypto","bank","nxosnet","createdAt"],"properties":{"object":{"type":"string","enum":["beneficiary"],"description":"Object type. Always `beneficiary`.","isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"beneficiaryId":{"type":"string","description":"Unique beneficiary identifier.","isRequired":true,"uniqueKey":"beneficiaryId","typeLabel":"string"},"accountId":{"type":"string","description":"Account this beneficiary belongs to.","isRequired":true,"uniqueKey":"accountId","typeLabel":"string"},"type":{"type":"string","description":"Beneficiary type.","enum":["CRYPTO","BANK","NXOSNET"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"nickname":{"type":"string","description":"Display name for the beneficiary.","isRequired":true,"uniqueKey":"nickname","typeLabel":"string"},"status":{"type":"string","description":"Current status.","enum":["ACTIVE","INACTIVE","BLOCKED","ARCHIVED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"blockReason":{"oneOf":[{"type":"string","description":"Why the beneficiary is blocked. `null` when `status` is not `BLOCKED`.","enum":["COMPLIANCE_CHECK"],"isRequired":true,"uniqueKey":"blockReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"blockReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"blockReason","typeLabel":"enum\u003cstring> | null"},"entityType":{"oneOf":[{"type":"string","enum":["INDIVIDUAL","BUSINESS"],"description":"Entity type.","isRequired":true,"uniqueKey":"entityType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["INDIVIDUAL","BUSINESS"],"description":"Entity type.","isRequired":true,"uniqueKey":"entityType.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"entityType","typeLabel":"enum\u003cstring> | null"},"email":{"oneOf":[{"type":"string","description":"Email address.","isRequired":true,"uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email address.","isRequired":true,"uniqueKey":"email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"email","typeLabel":"string | null"},"phoneNumber":{"oneOf":[{"type":"string","description":"Phone number.","isRequired":true,"uniqueKey":"phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number.","isRequired":true,"uniqueKey":"phoneNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"phoneNumber","typeLabel":"string | null"},"firstName":{"oneOf":[{"type":"string","description":"First name (individuals).","isRequired":true,"uniqueKey":"firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name (individuals).","isRequired":true,"uniqueKey":"firstName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"Last name (individuals).","isRequired":true,"uniqueKey":"lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name (individuals).","isRequired":true,"uniqueKey":"lastName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"lastName","typeLabel":"string | null"},"businessName":{"oneOf":[{"type":"string","description":"Business name (businesses).","isRequired":true,"uniqueKey":"businessName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Business name (businesses).","isRequired":true,"uniqueKey":"businessName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"businessName","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Country code (ISO 3166-1 alpha-2).","isRequired":true,"uniqueKey":"country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country code (ISO 3166-1 alpha-2).","isRequired":true,"uniqueKey":"country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"country","typeLabel":"string | null"},"addressLine1":{"oneOf":[{"type":"string","description":"Address line 1.","isRequired":true,"uniqueKey":"addressLine1.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 1.","isRequired":true,"uniqueKey":"addressLine1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"type":"string","description":"Address line 2.","isRequired":true,"uniqueKey":"addressLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address line 2.","isRequired":true,"uniqueKey":"addressLine2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"addressLine2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City.","isRequired":true,"uniqueKey":"city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City.","isRequired":true,"uniqueKey":"city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"city","typeLabel":"string | null"},"region":{"oneOf":[{"type":"string","description":"Region / state / province.","isRequired":true,"uniqueKey":"region.oneOf.0","typeLabel":"string"},{"type":"null","description":"Region / state / province.","isRequired":true,"uniqueKey":"region.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"region","typeLabel":"string | null"},"zipCode":{"oneOf":[{"type":"string","description":"ZIP / postal code.","isRequired":true,"uniqueKey":"zipCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"ZIP / postal code.","isRequired":true,"uniqueKey":"zipCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"zipCode","typeLabel":"string | null"},"crypto":{"oneOf":[{"type":"object","description":"Crypto-specific details. Present when type is `CRYPTO`, otherwise `null`.","required":["chainName","chainDisplayName","platform","address"],"properties":{"chainName":{"type":"string","description":"Blockchain network name (e.g., `ethereum`, `solana`).","isRequired":true,"uniqueKey":"crypto.oneOf.0.chainName","typeLabel":"string"},"chainDisplayName":{"oneOf":[{"type":"string","description":"Human-readable chain name. May be null on create responses.","isRequired":true,"uniqueKey":"crypto.oneOf.0.chainDisplayName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable chain name. May be null on create responses.","isRequired":true,"uniqueKey":"crypto.oneOf.0.chainDisplayName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"crypto.oneOf.0.chainDisplayName","typeLabel":"string | null"},"platform":{"oneOf":[{"type":"string","description":"Chain platform (e.g., `EVM`, `SOLANA`). May be null on create responses.","isRequired":true,"uniqueKey":"crypto.oneOf.0.platform.oneOf.0","typeLabel":"string"},{"type":"null","description":"Chain platform (e.g., `EVM`, `SOLANA`). May be null on create responses.","isRequired":true,"uniqueKey":"crypto.oneOf.0.platform.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"crypto.oneOf.0.platform","typeLabel":"string | null"},"address":{"type":"string","description":"On-chain wallet address.","isRequired":true,"uniqueKey":"crypto.oneOf.0.address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"crypto.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"crypto.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"crypto","typeLabel":"object | null"},"bank":{"oneOf":[{"type":"object","description":"Bank-specific details. Present when type is `BANK`, otherwise `null`.","required":["bankName"],"properties":{"bankName":{"type":"string","description":"Bank name.","isRequired":true,"uniqueKey":"bank.oneOf.0.bankName","typeLabel":"string"},"swiftCode":{"oneOf":[{"type":"string","description":"SWIFT / BIC code.","uniqueKey":"bank.oneOf.0.swiftCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"SWIFT / BIC code.","uniqueKey":"bank.oneOf.0.swiftCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.swiftCode","typeLabel":"string | null"},"iban":{"oneOf":[{"type":"string","description":"IBAN.","uniqueKey":"bank.oneOf.0.iban.oneOf.0","typeLabel":"string"},{"type":"null","description":"IBAN.","uniqueKey":"bank.oneOf.0.iban.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.iban","typeLabel":"string | null"},"bankCountry":{"oneOf":[{"type":"string","description":"Bank country (ISO 3166-1 alpha-2).","uniqueKey":"bank.oneOf.0.bankCountry.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank country (ISO 3166-1 alpha-2).","uniqueKey":"bank.oneOf.0.bankCountry.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.bankCountry","typeLabel":"string | null"},"method":{"oneOf":[{"type":"string","description":"Transfer method (e.g., `WIRE`, `SEPA`, `ACH`).","uniqueKey":"bank.oneOf.0.method.oneOf.0","typeLabel":"string"},{"type":"null","description":"Transfer method (e.g., `WIRE`, `SEPA`, `ACH`).","uniqueKey":"bank.oneOf.0.method.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.method","typeLabel":"string | null"},"currency":{"oneOf":[{"type":"string","description":"Payout currency code (e.g., `USD`, `EUR`).","uniqueKey":"bank.oneOf.0.currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payout currency code (e.g., `USD`, `EUR`).","uniqueKey":"bank.oneOf.0.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.currency","typeLabel":"string | null"},"intermediaryBankName":{"oneOf":[{"type":"string","description":"Intermediary bank name.","uniqueKey":"bank.oneOf.0.intermediaryBankName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Intermediary bank name.","uniqueKey":"bank.oneOf.0.intermediaryBankName.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.intermediaryBankName","typeLabel":"string | null"},"intermediarySwiftCode":{"oneOf":[{"type":"string","description":"Intermediary SWIFT / BIC code.","uniqueKey":"bank.oneOf.0.intermediarySwiftCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Intermediary SWIFT / BIC code.","uniqueKey":"bank.oneOf.0.intermediarySwiftCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.intermediarySwiftCode","typeLabel":"string | null"},"intermediaryBankAddress":{"oneOf":[{"type":"string","description":"Intermediary bank address.","uniqueKey":"bank.oneOf.0.intermediaryBankAddress.oneOf.0","typeLabel":"string"},{"type":"null","description":"Intermediary bank address.","uniqueKey":"bank.oneOf.0.intermediaryBankAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.intermediaryBankAddress","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"bank.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"bank.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bank","typeLabel":"object | null"},"nxosnet":{"oneOf":[{"type":"object","description":"Internal NXOS→NXOS details. Present when type is `NXOSNET`, otherwise `null`.","required":["targetHandle","targetOrganizationName","showOrganizationName"],"properties":{"targetHandle":{"type":"string","description":"The target organization's claimed nxosnet handle.","isRequired":true,"uniqueKey":"nxosnet.oneOf.0.targetHandle","typeLabel":"string"},"targetOrganizationName":{"oneOf":[{"type":"string","description":"Target organization's display name. `null` when the target has opted out of exposing it.","isRequired":true,"uniqueKey":"nxosnet.oneOf.0.targetOrganizationName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Target organization's display name. `null` when the target has opted out of exposing it.","isRequired":true,"uniqueKey":"nxosnet.oneOf.0.targetOrganizationName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nxosnet.oneOf.0.targetOrganizationName","typeLabel":"string | null"},"showOrganizationName":{"type":"boolean","description":"Whether the target organization exposes its name to senders.","isRequired":true,"uniqueKey":"nxosnet.oneOf.0.showOrganizationName","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"nxosnet.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"nxosnet.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nxosnet","typeLabel":"object | null"},"createdAt":{"type":"string","description":"When the beneficiary was created.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"}},"description":"A beneficiary (recipient) registered for payouts from an account.\nAll responses share this shape — the `type` field indicates which detail\nobject (`crypto` or `bank`) is populated; the other will be `null`.\nShared identity fields may be `null` in list and create responses.","example":{"object":"beneficiary","beneficiaryId":"bene_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","accountId":"acct_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","type":"CRYPTO","nickname":"Treasury Wallet","status":"ACTIVE","blockReason":null,"entityType":"INDIVIDUAL","email":"[email protected]","phoneNumber":null,"firstName":"John","lastName":"Doe","businessName":null,"country":"US","addressLine1":null,"addressLine2":null,"city":null,"region":null,"zipCode":null,"crypto":{"chainName":"ethereum","chainDisplayName":"Ethereum","platform":"EVM","address":"0x1234567890abcdef1234567890abcdef12345678"},"bank":null,"nxosnet":null,"createdAt":"2025-03-10T12:00:00.000Z"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"beneficiary","beneficiaryId":"bene_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","accountId":"acct_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","type":"CRYPTO","nickname":"Treasury Wallet","status":"ACTIVE","blockReason":null,"entityType":"INDIVIDUAL","email":"[email protected]","phoneNumber":null,"firstName":"John","lastName":"Doe","businessName":null,"country":"US","addressLine1":null,"addressLine2":null,"city":null,"region":null,"zipCode":null,"crypto":{"chainName":"ethereum","chainDisplayName":"Ethereum","platform":"EVM","address":"0x1234567890abcdef1234567890abcdef12345678"},"bank":null,"nxosnet":null,"createdAt":"2025-03-10T12:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"c7365c44-0735-4358-b882-158f610ab114":{"description":"The server could not understand the request due to invalid syntax.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","description":"Machine-readable error code.","enum":["missing_api_key","authentication_failed","invalid_api_key","forbidden","acting_org_not_found","authorization_required","swap_direction_not_allowed","sub_org_tier_not_available","service_not_enabled","not_found","organization_not_found","account_not_found","quote_not_found","beneficiary_not_found","transaction_not_found","funding_method_not_found","authorization_not_found","nxosnet_handle_not_found","sub_org_tier_not_found","report_not_found","quote_expired","quote_already_used","beneficiary_already_archived","beneficiary_not_archived","beneficiary_blocked","transaction_blocked","transaction_not_held","fee_schedule_drifted","nxosnet_not_enabled","nxosnet_handle_taken","chain_send_failed","swift_copy_not_found","swift_copy_not_ready","bank_unavailable","idempotency_key_in_use","idempotency_request_in_flight","referral_invite_already_accepted","report_not_ready","too_many_pending_reports","invalid_request","insufficient_funds","trade_size_out_of_bounds","validation_error","invalid_document","too_many_documents","document_too_large","document_not_found","document_not_uploaded","share_token_invalid","verification_import_unsupported","verification_required","rate_limited","webhooks_unavailable","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Unique identifier for this request, useful for debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"description":"Standard error response returned by all endpoints on failure.","uniqueKey":"","typeLabel":"object"},"examples":{"invalid_request: Cannot create a beneficiary pointing to your own account.":{"title":"invalid_request: Cannot create a beneficiary pointing to your own account.","value":{"error":{"code":"invalid_request","message":"Cannot create a beneficiary pointing to your own account.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}},"invalid_request: Idempotency-Key must be 1–255 characters.":{"title":"invalid_request: Idempotency-Key must be 1–255 characters.","value":{"error":{"code":"invalid_request","message":"Idempotency-Key must be 1–255 characters.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}},"invalid_request: Content-Type must be application/json.":{"title":"invalid_request: Content-Type must be application/json.","value":{"error":{"code":"invalid_request","message":"Content-Type must be application/json.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}},"invalid_request: Malformed JSON in request body.":{"title":"invalid_request: Malformed JSON in request body.","value":{"error":{"code":"invalid_request","message":"Malformed JSON in request body.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d9846847-7de3-4b37-ad23-82f947e00ea5":{"description":"Access is unauthorized.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","description":"Machine-readable error code.","enum":["missing_api_key","authentication_failed","invalid_api_key","forbidden","acting_org_not_found","authorization_required","swap_direction_not_allowed","sub_org_tier_not_available","service_not_enabled","not_found","organization_not_found","account_not_found","quote_not_found","beneficiary_not_found","transaction_not_found","funding_method_not_found","authorization_not_found","nxosnet_handle_not_found","sub_org_tier_not_found","report_not_found","quote_expired","quote_already_used","beneficiary_already_archived","beneficiary_not_archived","beneficiary_blocked","transaction_blocked","transaction_not_held","fee_schedule_drifted","nxosnet_not_enabled","nxosnet_handle_taken","chain_send_failed","swift_copy_not_found","swift_copy_not_ready","bank_unavailable","idempotency_key_in_use","idempotency_request_in_flight","referral_invite_already_accepted","report_not_ready","too_many_pending_reports","invalid_request","insufficient_funds","trade_size_out_of_bounds","validation_error","invalid_document","too_many_documents","document_too_large","document_not_found","document_not_uploaded","share_token_invalid","verification_import_unsupported","verification_required","rate_limited","webhooks_unavailable","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Unique identifier for this request, useful for debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"description":"Standard error response returned by all endpoints on failure.","example":{"error":{"code":"missing_api_key","message":"Missing or invalid Authorization header. Expected: Bearer \u003capi_key>","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"missing_api_key","message":"Missing or invalid Authorization header. Expected: Bearer \u003capi_key>","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}}},"exampleType":"generated"}},"exampleType":"generated"},"089bc133-4e13-4020-aaeb-9a00fd41baf2":{"description":"Access is forbidden.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","description":"Machine-readable error code.","enum":["missing_api_key","authentication_failed","invalid_api_key","forbidden","acting_org_not_found","authorization_required","swap_direction_not_allowed","sub_org_tier_not_available","service_not_enabled","not_found","organization_not_found","account_not_found","quote_not_found","beneficiary_not_found","transaction_not_found","funding_method_not_found","authorization_not_found","nxosnet_handle_not_found","sub_org_tier_not_found","report_not_found","quote_expired","quote_already_used","beneficiary_already_archived","beneficiary_not_archived","beneficiary_blocked","transaction_blocked","transaction_not_held","fee_schedule_drifted","nxosnet_not_enabled","nxosnet_handle_taken","chain_send_failed","swift_copy_not_found","swift_copy_not_ready","bank_unavailable","idempotency_key_in_use","idempotency_request_in_flight","referral_invite_already_accepted","report_not_ready","too_many_pending_reports","invalid_request","insufficient_funds","trade_size_out_of_bounds","validation_error","invalid_document","too_many_documents","document_too_large","document_not_found","document_not_uploaded","share_token_invalid","verification_import_unsupported","verification_required","rate_limited","webhooks_unavailable","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Unique identifier for this request, useful for debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"description":"Standard error response returned by all endpoints on failure.","uniqueKey":"","typeLabel":"object"},"examples":{"verification_required: Complete identity verification before using the API.":{"title":"verification_required: Complete identity verification before using the API.","value":{"error":{"code":"verification_required","message":"Complete identity verification before using the API.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}},"acting_org_not_found":{"title":"acting_org_not_found","value":{"error":{"code":"acting_org_not_found","message":"Nxos-On-Behalf-Of points to an organization that does not exist.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}},"authorization_required":{"title":"authorization_required","value":{"error":{"code":"authorization_required","message":"No active authorization for the requested organization.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}},"verification_required: Complete identity verification before moving funds or managing clients":{"title":"verification_required: Complete identity verification before moving funds or managing clients","value":{"error":{"code":"verification_required","message":"Complete identity verification before moving funds or managing clients and recipients.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}}},"exampleType":"examples"}},"exampleType":"examples"},"be01e239-286c-4f5d-92f7-3cde89d0c45f":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","description":"Machine-readable error code.","enum":["missing_api_key","authentication_failed","invalid_api_key","forbidden","acting_org_not_found","authorization_required","swap_direction_not_allowed","sub_org_tier_not_available","service_not_enabled","not_found","organization_not_found","account_not_found","quote_not_found","beneficiary_not_found","transaction_not_found","funding_method_not_found","authorization_not_found","nxosnet_handle_not_found","sub_org_tier_not_found","report_not_found","quote_expired","quote_already_used","beneficiary_already_archived","beneficiary_not_archived","beneficiary_blocked","transaction_blocked","transaction_not_held","fee_schedule_drifted","nxosnet_not_enabled","nxosnet_handle_taken","chain_send_failed","swift_copy_not_found","swift_copy_not_ready","bank_unavailable","idempotency_key_in_use","idempotency_request_in_flight","referral_invite_already_accepted","report_not_ready","too_many_pending_reports","invalid_request","insufficient_funds","trade_size_out_of_bounds","validation_error","invalid_document","too_many_documents","document_too_large","document_not_found","document_not_uploaded","share_token_invalid","verification_import_unsupported","verification_required","rate_limited","webhooks_unavailable","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Unique identifier for this request, useful for debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"description":"Standard error response returned by all endpoints on failure.","uniqueKey":"","typeLabel":"object"},"examples":{"account_not_found":{"title":"account_not_found","value":{"error":{"code":"account_not_found","message":"Account not found.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}},"nxosnet_handle_not_found":{"title":"nxosnet_handle_not_found","value":{"error":{"code":"nxosnet_handle_not_found","message":"No NXOS organization found for handle: northwind-trading","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}}},"exampleType":"examples"}},"exampleType":"examples"},"23f26954-5f82-4101-8f89-29263fe82f27":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","description":"Machine-readable error code.","enum":["missing_api_key","authentication_failed","invalid_api_key","forbidden","acting_org_not_found","authorization_required","swap_direction_not_allowed","sub_org_tier_not_available","service_not_enabled","not_found","organization_not_found","account_not_found","quote_not_found","beneficiary_not_found","transaction_not_found","funding_method_not_found","authorization_not_found","nxosnet_handle_not_found","sub_org_tier_not_found","report_not_found","quote_expired","quote_already_used","beneficiary_already_archived","beneficiary_not_archived","beneficiary_blocked","transaction_blocked","transaction_not_held","fee_schedule_drifted","nxosnet_not_enabled","nxosnet_handle_taken","chain_send_failed","swift_copy_not_found","swift_copy_not_ready","bank_unavailable","idempotency_key_in_use","idempotency_request_in_flight","referral_invite_already_accepted","report_not_ready","too_many_pending_reports","invalid_request","insufficient_funds","trade_size_out_of_bounds","validation_error","invalid_document","too_many_documents","document_too_large","document_not_found","document_not_uploaded","share_token_invalid","verification_import_unsupported","verification_required","rate_limited","webhooks_unavailable","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Unique identifier for this request, useful for debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"description":"Standard error response returned by all endpoints on failure.","uniqueKey":"","typeLabel":"object"},"examples":{"nxosnet_not_enabled":{"title":"nxosnet_not_enabled","value":{"error":{"code":"nxosnet_not_enabled","message":"The target organization is not enabled for NXOS transfers.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}},"idempotency_request_in_flight":{"title":"idempotency_request_in_flight","value":{"error":{"code":"idempotency_request_in_flight","message":"A request with this Idempotency-Key is currently being processed. Retry shortly.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}},"idempotency_key_in_use":{"title":"idempotency_key_in_use","value":{"error":{"code":"idempotency_key_in_use","message":"This Idempotency-Key was previously used with a different request body. Use a unique key per logical operation.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9e63816f-4d31-415a-9917-eabe0ba82e4e":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","description":"Machine-readable error code.","enum":["missing_api_key","authentication_failed","invalid_api_key","forbidden","acting_org_not_found","authorization_required","swap_direction_not_allowed","sub_org_tier_not_available","service_not_enabled","not_found","organization_not_found","account_not_found","quote_not_found","beneficiary_not_found","transaction_not_found","funding_method_not_found","authorization_not_found","nxosnet_handle_not_found","sub_org_tier_not_found","report_not_found","quote_expired","quote_already_used","beneficiary_already_archived","beneficiary_not_archived","beneficiary_blocked","transaction_blocked","transaction_not_held","fee_schedule_drifted","nxosnet_not_enabled","nxosnet_handle_taken","chain_send_failed","swift_copy_not_found","swift_copy_not_ready","bank_unavailable","idempotency_key_in_use","idempotency_request_in_flight","referral_invite_already_accepted","report_not_ready","too_many_pending_reports","invalid_request","insufficient_funds","trade_size_out_of_bounds","validation_error","invalid_document","too_many_documents","document_too_large","document_not_found","document_not_uploaded","share_token_invalid","verification_import_unsupported","verification_required","rate_limited","webhooks_unavailable","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Unique identifier for this request, useful for debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"description":"Standard error response returned by all endpoints on failure.","uniqueKey":"","typeLabel":"object"},"examples":{"validation_error":{"title":"validation_error","value":{"error":{"code":"validation_error","message":"Request body failed validation.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}}},"exampleType":"examples"}},"exampleType":"examples"},"bbaf6b4a-0ad8-4295-9f7b-2244f85fd020":{"description":"Client error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","description":"Machine-readable error code.","enum":["missing_api_key","authentication_failed","invalid_api_key","forbidden","acting_org_not_found","authorization_required","swap_direction_not_allowed","sub_org_tier_not_available","service_not_enabled","not_found","organization_not_found","account_not_found","quote_not_found","beneficiary_not_found","transaction_not_found","funding_method_not_found","authorization_not_found","nxosnet_handle_not_found","sub_org_tier_not_found","report_not_found","quote_expired","quote_already_used","beneficiary_already_archived","beneficiary_not_archived","beneficiary_blocked","transaction_blocked","transaction_not_held","fee_schedule_drifted","nxosnet_not_enabled","nxosnet_handle_taken","chain_send_failed","swift_copy_not_found","swift_copy_not_ready","bank_unavailable","idempotency_key_in_use","idempotency_request_in_flight","referral_invite_already_accepted","report_not_ready","too_many_pending_reports","invalid_request","insufficient_funds","trade_size_out_of_bounds","validation_error","invalid_document","too_many_documents","document_too_large","document_not_found","document_not_uploaded","share_token_invalid","verification_import_unsupported","verification_required","rate_limited","webhooks_unavailable","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Unique identifier for this request, useful for debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"description":"Standard error response returned by all endpoints on failure.","example":{"error":{"code":"rate_limited","message":"Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limited","message":"Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6354c828-8d24-4201-b269-13651f3ee5de":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","description":"Machine-readable error code.","enum":["missing_api_key","authentication_failed","invalid_api_key","forbidden","acting_org_not_found","authorization_required","swap_direction_not_allowed","sub_org_tier_not_available","service_not_enabled","not_found","organization_not_found","account_not_found","quote_not_found","beneficiary_not_found","transaction_not_found","funding_method_not_found","authorization_not_found","nxosnet_handle_not_found","sub_org_tier_not_found","report_not_found","quote_expired","quote_already_used","beneficiary_already_archived","beneficiary_not_archived","beneficiary_blocked","transaction_blocked","transaction_not_held","fee_schedule_drifted","nxosnet_not_enabled","nxosnet_handle_taken","chain_send_failed","swift_copy_not_found","swift_copy_not_ready","bank_unavailable","idempotency_key_in_use","idempotency_request_in_flight","referral_invite_already_accepted","report_not_ready","too_many_pending_reports","invalid_request","insufficient_funds","trade_size_out_of_bounds","validation_error","invalid_document","too_many_documents","document_too_large","document_not_found","document_not_uploaded","share_token_invalid","verification_import_unsupported","verification_required","rate_limited","webhooks_unavailable","internal_error"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Unique identifier for this request, useful for debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"description":"Standard error response returned by all endpoints on failure.","example":{"error":{"code":"internal_error","message":"An unexpected error occurred.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal_error","message":"An unexpected error occurred.","requestId":"req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"5080e5aa-085b-455e-be8f-c1c3b3837b09":{"url":"https://api.nxos.io","description":"Production","variables":{}},"e8851a56-d3fb-4a47-b75d-91f511378ca3":{"url":"https://api.sandbox.nxos.io","description":"Sandbox","variables":{}}}},"originalFileLocation":"openapi.yaml"},"subdomain":"nxos-f4022d2e","siteName":"Nxos","title":"Create nxosnet beneficiary - Nxos","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-15T11:39:28.970Z","originalFileLocation":"api-reference/beneficiaries/create-nxosnet.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create an internal NXOS→NXOS beneficiary for an account, resolved by the target organization\u0026#x27;s nxosnet handle. The target must have NXOS transfers enabled. Use the returned beneficiary as the recipient for POST /v1/transactions/nxosnet-transfers.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nxos\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nxos-f4022d2e/90KjkNkfbw9xtcVN/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/nxos-f4022d2e/90KjkNkfbw9xtcVN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nxos-f4022d2e/90KjkNkfbw9xtcVN/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nxos-f4022d2e/90KjkNkfbw9xtcVN/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nxos-f4022d2e/90KjkNkfbw9xtcVN/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nxos-f4022d2e/90KjkNkfbw9xtcVN/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nxos-f4022d2e/90KjkNkfbw9xtcVN/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/nxos-f4022d2e/90KjkNkfbw9xtcVN/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/nxos-f4022d2e/90KjkNkfbw9xtcVN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create nxosnet beneficiary - Nxos\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create an internal NXOS→NXOS beneficiary for an account, resolved by the target organization\u0026#x27;s nxosnet handle. The target must have NXOS transfers enabled. Use the returned beneficiary as the recipient for POST /v1/transactions/nxosnet-transfers.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nxos\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nxos-f4022d2e.mintlify.app/_mintlify/api/og/v2?division=Beneficiaries\u0026amp;title=Create+nxosnet+beneficiary\u0026amp;description=Create+an+internal+NXOS%E2%86%92NXOS+beneficiary+for+an+account%2C+resolved+by+the%0Atarget+organization%27s+nxosnet+handle.+The+target+must+have+NXOS+transfers%0Aenabled.+Use+\u0026amp;theme=e95154c898ac3503117a4076\u0026amp;signature=cb24e284b206b1f13f1c9f1af9821cd9813971053383efe7c9866cda031395a5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create nxosnet beneficiary - Nxos\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create an internal NXOS→NXOS beneficiary for an account, resolved by the target organization\u0026#x27;s nxosnet handle. The target must have NXOS transfers enabled. Use the returned beneficiary as the recipient for POST /v1/transactions/nxosnet-transfers.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nxos-f4022d2e.mintlify.app/_mintlify/api/og/v2?division=Beneficiaries\u0026amp;title=Create+nxosnet+beneficiary\u0026amp;description=Create+an+internal+NXOS%E2%86%92NXOS+beneficiary+for+an+account%2C+resolved+by+the%0Atarget+organization%27s+nxosnet+handle.+The+target+must+have+NXOS+transfers%0Aenabled.+Use+\u0026amp;theme=e95154c898ac3503117a4076\u0026amp;signature=cb24e284b206b1f13f1c9f1af9821cd9813971053383efe7c9866cda031395a5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/nxos-f4022d2e/90KjkNkfbw9xtcVN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nxos\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#38bdf8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/beneficiaries/create-nxosnet.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nxos.io/#organization\",\"name\":\"Nxos\",\"url\":\"https://docs.nxos.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nxos-f4022d2e/1BbvSIMfTEn6iDBa/logo/light.svg?fit=max\u0026auto=format\u0026n=1BbvSIMfTEn6iDBa\u0026q=85\u0026s=cfc2eecff02a32cd44c0881bd70c3a30\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nxos.io#website\",\"name\":\"Nxos\",\"url\":\"https://docs.nxos.io\",\"publisher\":{\"@id\":\"https://docs.nxos.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet#webpage\",\"url\":\"https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet\",\"name\":\"Create nxosnet beneficiary\",\"description\":\"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.\",\"dateModified\":\"2026-06-15T11:39:28.970Z\",\"isPartOf\":{\"@id\":\"https://docs.nxos.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Move money\",\"item\":\"https://docs.nxos.io/api-reference/quotes/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Beneficiaries\",\"item\":\"https://docs.nxos.io/api-reference/beneficiaries/list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create nxosnet beneficiary\",\"item\":\"https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet#apireference\",\"headline\":\"Create nxosnet beneficiary\",\"name\":\"Create nxosnet beneficiary\",\"description\":\"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.\",\"url\":\"https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nxos.io/api-reference/beneficiaries/create-nxosnet#webpage\"},\"dateModified\":\"2026-06-15T11:39:28.970Z\",\"publisher\":{\"@id\":\"https://docs.nxos.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nxos.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nxos\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nxos","nav":{"global":{},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Setup","pages":[{"group":"Organizations","pages":[{"title":"Get organization","openapi":"GET /v1/organizations","href":"/api-reference/organizations/get"},{"title":"Create organization","openapi":"POST /v1/organizations","href":"/api-reference/organizations/create"},{"title":"Get verification","openapi":"GET /v1/organizations/verification","href":"/api-reference/organizations/get-verification"},{"title":"Start verification","openapi":"POST /v1/organizations/verification","href":"/api-reference/organizations/start-verification"},{"title":"Import verification","openapi":"POST /v1/organizations/verification/import","href":"/api-reference/organizations/import-verification"}]},{"group":"Accounts","pages":[{"title":"List accounts","openapi":"GET /v1/accounts","href":"/api-reference/accounts/list"},{"title":"Get account","openapi":"GET /v1/accounts/{accountId}","href":"/api-reference/accounts/get"}]},{"group":"Assets","pages":[{"title":"List available assets","openapi":"GET /v1/assets","href":"/api-reference/assets/list"}]},{"group":"Funding methods","pages":[{"title":"List funding methods","openapi":"GET /v1/funding-methods","href":"/api-reference/funding-methods/list"},{"title":"Get a funding method","openapi":"GET /v1/funding-methods/{fundingMethodId}","href":"/api-reference/funding-methods/get"},{"title":"Create a funding method","openapi":"POST /v1/funding-methods","href":"/api-reference/funding-methods/create"}]}]},{"group":"Move money","pages":[{"group":"Quotes","pages":[{"title":"Create quote","openapi":"POST /v1/quotes","href":"/api-reference/quotes/create"},{"title":"Get quote","openapi":"GET /v1/quotes/{quoteId}","href":"/api-reference/quotes/get"},{"title":"Execute quote","openapi":"POST /v1/quotes/{quoteId}/execute","href":"/api-reference/quotes/execute"}]},{"group":"Beneficiaries","pages":[{"title":"List beneficiaries","openapi":"GET /v1/beneficiaries","href":"/api-reference/beneficiaries/list"},{"title":"Get beneficiary","openapi":"GET /v1/beneficiaries/{beneficiaryId}","href":"/api-reference/beneficiaries/get"},{"title":"Create bank beneficiary","openapi":"POST /v1/beneficiaries/bank","href":"/api-reference/beneficiaries/create-bank"},{"title":"Create crypto beneficiary","openapi":"POST /v1/beneficiaries/crypto","description":"Create a crypto beneficiary for an account.","href":"/api-reference/beneficiaries/create-crypto"},{"title":"Create nxosnet beneficiary","openapi":"POST /v1/beneficiaries/nxosnet","href":"/api-reference/beneficiaries/create-nxosnet"},{"title":"Update beneficiary","openapi":"PATCH /v1/beneficiaries/{beneficiaryId}","description":"Update a beneficiary's details.","href":"/api-reference/beneficiaries/update"},{"title":"Archive beneficiary","openapi":"DELETE /v1/beneficiaries/{beneficiaryId}","href":"/api-reference/beneficiaries/archive"}]},{"group":"Payouts","pages":[{"title":"Get fiat payout options","openapi":"GET /v1/transactions/fiat-payouts/options","href":"/api-reference/fiat-payouts/options"},{"title":"Fiat payout fee","openapi":"GET /v1/fees/fiat-payout","href":"/api-reference/fees/fiat-payout"},{"title":"Initiate fiat payout","openapi":"POST /v1/transactions/fiat-payouts","href":"/api-reference/fiat-payouts/initiate"},{"title":"Crypto payout fee","openapi":"GET /v1/fees/crypto-payout","href":"/api-reference/fees/crypto-payout"},{"title":"Execute crypto payout","openapi":"POST /v1/transactions/crypto-payouts","href":"/api-reference/crypto-payouts/execute"}]},{"group":"Nxosnet","pages":[{"title":"Get nxosnet settings","openapi":"GET /v1/organizations/nxosnet","href":"/api-reference/organizations/get-nxosnet"},{"title":"Update nxosnet settings","openapi":"PATCH /v1/organizations/nxosnet","href":"/api-reference/organizations/update-nxosnet"},{"title":"Resolve nxosnet handle","openapi":"GET /v1/nxosnet/handles/{handle}","href":"/api-reference/nxosnet-transfers/resolve-handle"},{"title":"Send nxosnet transfer","openapi":"POST /v1/transactions/nxosnet-transfers","href":"/api-reference/nxosnet-transfers/send"}]}]},{"group":"Track","pages":[{"group":"Transactions","pages":[{"title":"List transactions","api":"GET /v1/transactions","href":"/api-reference/transactions/list"},{"title":"Get a transaction","api":"GET /v1/transactions/{transactionId}","href":"/api-reference/transactions/get"},{"title":"Download a SWIFT copy","openapi":"GET /v1/transactions/{transactionId}/swift-copy","href":"/api-reference/transactions/swift-copy"}]},{"group":"Reports","pages":[{"title":"List reports","openapi":"GET /v1/reports","href":"/api-reference/reports/list"},{"title":"Get a report","openapi":"GET /v1/reports/{reportId}","href":"/api-reference/reports/get"},{"title":"Request a report","openapi":"POST /v1/reports","href":"/api-reference/reports/create"},{"title":"Download a report","openapi":"GET /v1/reports/{reportId}/download","href":"/api-reference/reports/download"}]},{"group":"Webhooks","pages":[{"title":"List endpoints","openapi":"GET /v1/webhooks/endpoints","href":"/api-reference/webhooks/list"},{"title":"Get endpoint","openapi":"GET /v1/webhooks/endpoints/{endpointId}","href":"/api-reference/webhooks/get"},{"title":"Create endpoint","openapi":"POST /v1/webhooks/endpoints","href":"/api-reference/webhooks/create"},{"title":"Update endpoint","openapi":"PATCH /v1/webhooks/endpoints/{endpointId}","href":"/api-reference/webhooks/update"},{"title":"Delete endpoint","openapi":"DELETE /v1/webhooks/endpoints/{endpointId}","href":"/api-reference/webhooks/delete"},{"title":"Get signing secret","openapi":"GET /v1/webhooks/endpoints/{endpointId}/secret","href":"/api-reference/webhooks/get-secret"},{"title":"Rotate signing secret","openapi":"POST /v1/webhooks/endpoints/{endpointId}/secret/rotate","href":"/api-reference/webhooks/rotate-secret"}]},{"group":"Webhook events","pages":[{"title":"organization.verification.updated","href":"/api-reference/webhooks/events/organization-verification-updated"},{"title":"transaction.status.updated","href":"/api-reference/webhooks/events/transaction-status-updated"},{"title":"transaction.action_required","href":"/api-reference/webhooks/events/transaction-action-required"},{"title":"report.ready","href":"/api-reference/webhooks/events/report-ready"},{"title":"report.failed","href":"/api-reference/webhooks/events/report-failed"}]}]},{"group":"Broker","pages":[{"group":"Client access","pages":[{"title":"List authorizations","openapi":"GET /v1/authorizations","href":"/api-reference/authorizations/list"},{"title":"Activate authorization","openapi":"POST /v1/authorizations/activate","href":"/api-reference/authorizations/activate"},{"title":"Revoke authorization","openapi":"POST /v1/authorizations/revoke","href":"/api-reference/authorizations/revoke"}]},{"group":"Client pricing","pages":[{"title":"List your pricing tiers","openapi":"GET /v1/sub-org-tiers","href":"/api-reference/broker-tiers/list"},{"title":"Set a client's tier","openapi":"PUT /v1/organizations/sub-org-tier","href":"/api-reference/organizations/set-sub-org-tier"}]}]},{"group":"Referrals","pages":[{"group":"Referral links","pages":[{"title":"Create referral invite","openapi":"POST /v1/referral-invites","href":"/api-reference/referral-invites/create"},{"title":"List referral links","openapi":"GET /v1/referral-links","href":"/api-reference/referral-links/list"}]}]},{"group":"Testing","pages":[{"group":"Sandbox","pages":[{"title":"Fund a test balance","openapi":"POST /v1/transactions/faucet","href":"/api-reference/sandbox/faucet"}]}]}]}]},"title":"Create nxosnet beneficiary - Nxos","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CT9uE8Ip.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}