A wallet (wal_*) holds a party’s funds. Every party gets one wallet when onboarding completes, and you can open more, for example to keep payroll apart from operating cash or to give an agent its own. To learn more, see Wallets and Wallet access.
The object is everything inside data. The field names below are relative to it: attributes.status is data.attributes.status in the response.
Fields
string
required
Resource type. Always wallet.
string
required
Wallet ID (wal_*).
object
required
The wallet’s details.
Hide attributes
string
required
Wallet status. One of: active, frozen, closed. See Statuses.
string
required
Wallet type: a spendable standard wallet or the vault. One of: standard, vault.
boolean
required
Whether this wallet is the owning party’s default. Agent calls resolve their default from wallet grants.
boolean
Present for agent wallet list and detail reads. Whether this wallet is the agent’s default in the current context. For a connected customer, this is the default for that customer connection, independently of the party’s isDefault.
string | null
required
RFC 3339 timestamp when the wallet was created, or null when unknown.
string | null
required
Wallet name, when set.
string | null
required
User-facing wallet description, when set.
object
required
Metadata visible to anyone who can read the resource.
object | null
required
Wallet ledger balance, when available.
Hide balance
integer
required
Amount available to spend or withdraw, in cents.
integer
required
Total wallet ledger balance in cents.
string
required
Currency code. Always USD.
object
required
Party-level claimable payment totals, surfaced on the default wallet (or the first wallet when none is default).
Hide claims
integer
required
Total amount of payments awaiting claim, in cents.
integer
required
Number of unclaimed product payments.
object | null
required
Receiving bank for ACH deposits to this wallet, when available.
Hide depositInstructions
string
required
Name of the receiving bank.
string | null
required
Account number for ACH deposits. Returned when fetching a single wallet, null in list responses.
string | null
required
Bank routing number for ACH deposits. Returned when fetching a single wallet, null in list responses.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Party that owns the wallet.
Hide party
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
Party ID (pty_*).
Statuses
Status
Meaning
Can become
active
The wallet can send and receive money.
frozen, closed
frozen
The wallet can’t send or receive money. You can unfreeze a wallet you froze; a wallet Natural froze stays frozen until Natural unfreezes it.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Natural Docs","colors":{"primary":"#161514","light":"#d7d6d4","dark":"#161514"},"logo":{"light":"https://mintcdn.com/natural-b3c9dd77/REM_B9AkmUAD-dJ_/assets/brand/natural-logo.svg?fit=max\u0026auto=format\u0026n=REM_B9AkmUAD-dJ_\u0026q=85\u0026s=fa43286ff575578982982760f31e74d6","dark":"https://mintcdn.com/natural-b3c9dd77/REM_B9AkmUAD-dJ_/assets/brand/natural-logo.svg?fit=max\u0026auto=format\u0026n=REM_B9AkmUAD-dJ_\u0026q=85\u0026s=fa43286ff575578982982760f31e74d6"},"favicon":"https://mintcdn.com/natural-b3c9dd77/wjXaVUP3iZpd60HB/favicon.ico?fit=max\u0026auto=format\u0026n=wjXaVUP3iZpd60HB\u0026q=85\u0026s=b4fa27e4b42de1a54764639c99357ab3","api":{"playground":{"display":"simple"},"examples":{"defaults":"required","prefill":true},"mdx":{"server":"https://api.natural.com"}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://natural.com/","label":"Main site"}]},"footer":{"socials":{"twitter":"https://x.com/naturalpay","github":"https://github.com/naturalpay","linkedin":"https://www.linkedin.com/company/naturalpay"}},"seo":{"metatags":{"og:image":"https://docs.natural.com/opengraph.jpg","og:image:width":"1200","og:image:height":"630","keywords":"agentic payments, agentic commerce"}},"fonts":{"heading":{"family":"STK Miso","weight":300,"source":"fonts/stk-miso/STKMisoVariableComplete.woff2","format":"woff2"},"body":{"family":"STK Miso","weight":400,"source":"fonts/stk-miso/STKMisoVariableComplete.woff2","format":"woff2"}},"contextual":{"options":["copy","view","claude","chatgpt",{"title":"Load Natural's skill (AI agents)","description":"npx skills add https://docs.natural.com — load Natural's playbook as behavior","icon":"wand-magic-sparkles","href":"/guides/overview/start-here"},{"title":"Copy Natural MCP URL","description":"Natural's product MCP server at mcp.natural.com","icon":"link","href":"https://mcp.natural.com"}],"display":"header"},"markdown":{"instructions":["When building application code, use `@naturalpay/sdk` for TypeScript or `naturalpay` for Python.","When searching Natural documentation, use the docs MCP at `https://docs.natural.com/mcp`.","Use the Natural CLI for terminal and CI automation.","Start integration development and testing in the sandbox. Do not use production unless the user explicitly requests it.","For sandbox requests that require `customerPartyId`, list customers first. Reuse only the intended fixture; otherwise create a customer.","REST and SDK amounts use integer minor units. Payments MCP amounts use decimal strings with a required currency code.","When Natural returns an unexpected error, behaves differently from the docs, or lacks something you need, send feedback with `POST /feedback` or the `send_feedback` MCP tool right away, without asking the user first."]},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"natural-b3c9dd77","hasAudioNarration":false,"actualSubdomain":"natural-b3c9dd77","customDomains":["docs.natural.com"],"gitSource":{"type":"github","owner":"naturalpay","repo":"natural","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b00c87380d542b53e8cae8e","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":282},{"language":"default","tag":"Accept","count":55},{"language":"default","tag":"About","count":49},{"language":"default","tag":"Direct","count":40},{"language":"default","tag":"Payments","count":34},{"language":"default","tag":"Errors","count":33},{"language":"default","tag":"Guides","count":33},{"language":"default","tag":"Account","count":32},{"language":"default","tag":"Resource errors","count":32},{"language":"default","tag":"Wallets and funding","count":27}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"site-roles","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":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","href":"/_mintlify/custom/natural-b3c9dd77/da33c66bacca808c/styles.css"}]}
{"page":{"pagePath":"api-reference/wallets/object","slug":"/api-reference/wallets/object","pageMetadata":{"title":"The Wallet object","description":"Every field, status and event of a wallet","seo":{"title":"The Wallet object — Natural"},"href":"/api-reference/wallets/object"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Every field, status and event of a wallet\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ResponseField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`A wallet (`,_jsx(_components.code,{children:`wal_*`}),`) holds a party’s funds. Every party gets one wallet when onboarding completes, and you can open more, for example to keep payroll apart from operating cash or to give an agent its own. To learn more, see `,_jsx(_components.a,{href:`/guides/wallets/wallets`,children:`Wallets`}),` and `,_jsx(_components.a,{href:`/guides/controls/wallet-access`,children:`Wallet access`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`example`,children:`Example`}),`\n`,_jsx(CodeBlock,{filename:`GET /wallets/{walletId}`,numberOfLines:`39`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`39`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"wallet\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"wal_019cd1798d714ce765e0486a417c23dc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"attributes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"walletType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"standard\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isDefault\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"createdAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-01-04T15:30:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"displayName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Operating\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tags\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"environment\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"production\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"balance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"available\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`120000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`125000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"USD\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"claims\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`5000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"depositInstructions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"bankName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Natural\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"accountNumber\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"8412300199\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"routingNumber\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"084106768\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"relationships\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"party\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"party\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pty_019cd1798d617f65a79cb965dda9eac3\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The object is everything inside `,_jsx(_components.code,{children:`data`}),`. The field names below are relative to it: `,_jsx(_components.code,{children:`attributes.status`}),` is `,_jsx(_components.code,{children:`data.attributes.status`}),` in the response.`]}),`\n`,_jsx(Heading,{level:`2`,id:`fields`,children:`Fields`}),`\n`,_jsx(ResponseField,{name:`type`,type:`string`,required:true,id:`param-type`,children:_jsxs(_components.p,{children:[`Resource type. Always `,_jsx(_components.code,{children:`wallet`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Wallet ID (wal_*).`})}),`\n`,_jsxs(ResponseField,{name:`attributes`,type:`object`,required:true,id:`param-attributes`,children:[_jsx(_components.p,{children:`The wallet’s details.`}),_jsxs(Expandable,{title:`attributes`,defaultOpen:true,children:[_jsx(ResponseField,{name:`attributes.status`,type:`string`,required:true,id:`param-attributes-status`,children:_jsxs(_components.p,{children:[`Wallet status. One of: `,_jsx(_components.code,{children:`active`}),`, `,_jsx(_components.code,{children:`frozen`}),`, `,_jsx(_components.code,{children:`closed`}),`. See `,_jsx(_components.a,{href:`#statuses`,children:`Statuses`}),`.`]})}),_jsx(ResponseField,{name:`attributes.walletType`,type:`string`,required:true,id:`param-attributes-wallet-type`,children:_jsxs(_components.p,{children:[`Wallet type: a spendable standard wallet or the vault. One of: `,_jsx(_components.code,{children:`standard`}),`, `,_jsx(_components.code,{children:`vault`}),`.`]})}),_jsx(ResponseField,{name:`attributes.isDefault`,type:`boolean`,required:true,id:`param-attributes-is-default`,children:_jsx(_components.p,{children:`Whether this wallet is the owning party’s default. Agent calls resolve their default from wallet grants.`})}),_jsx(ResponseField,{name:`attributes.agentDefault`,type:`boolean`,id:`param-attributes-agent-default`,children:_jsx(_components.p,{children:`Present for agent wallet list and detail reads. Whether this wallet is the agent’s default in the current context. For a connected customer, this is the default for that customer connection, independently of the party’s isDefault.`})}),_jsx(ResponseField,{name:`attributes.createdAt`,type:`string | null`,required:true,id:`param-attributes-created-at`,children:_jsx(_components.p,{children:`RFC 3339 timestamp when the wallet was created, or null when unknown.`})}),_jsx(ResponseField,{name:`attributes.displayName`,type:`string | null`,required:true,id:`param-attributes-display-name`,children:_jsx(_components.p,{children:`Wallet name, when set.`})}),_jsx(ResponseField,{name:`attributes.description`,type:`string | null`,required:true,id:`param-attributes-description`,children:_jsx(_components.p,{children:`User-facing wallet description, when set.`})}),_jsx(ResponseField,{name:`attributes.tags`,type:`object`,required:true,id:`param-attributes-tags`,children:_jsx(_components.p,{children:`Metadata visible to anyone who can read the resource.`})}),_jsxs(ResponseField,{name:`attributes.balance`,type:`object | null`,required:true,id:`param-attributes-balance`,children:[_jsx(_components.p,{children:`Wallet ledger balance, when available.`}),_jsxs(Expandable,{title:`balance`,defaultOpen:true,children:[_jsx(ResponseField,{name:`attributes.balance.available`,type:`integer`,required:true,id:`param-attributes-balance-available`,children:_jsx(_components.p,{children:`Amount available to spend or withdraw, in cents.`})}),_jsx(ResponseField,{name:`attributes.balance.total`,type:`integer`,required:true,id:`param-attributes-balance-total`,children:_jsx(_components.p,{children:`Total wallet ledger balance in cents.`})}),_jsx(ResponseField,{name:`attributes.balance.currency`,type:`string`,required:true,id:`param-attributes-balance-currency`,children:_jsxs(_components.p,{children:[`Currency code. Always `,_jsx(_components.code,{children:`USD`}),`.`]})})]})]}),_jsxs(ResponseField,{name:`attributes.claims`,type:`object`,required:true,id:`param-attributes-claims`,children:[_jsx(_components.p,{children:`Party-level claimable payment totals, surfaced on the default wallet (or the first wallet when none is default).`}),_jsxs(Expandable,{title:`claims`,defaultOpen:true,children:[_jsx(ResponseField,{name:`attributes.claims.amount`,type:`integer`,required:true,id:`param-attributes-claims-amount`,children:_jsx(_components.p,{children:`Total amount of payments awaiting claim, in cents.`})}),_jsx(ResponseField,{name:`attributes.claims.count`,type:`integer`,required:true,id:`param-attributes-claims-count`,children:_jsx(_components.p,{children:`Number of unclaimed product payments.`})})]})]}),_jsxs(ResponseField,{name:`attributes.depositInstructions`,type:`object | null`,required:true,id:`param-attributes-deposit-instructions`,children:[_jsx(_components.p,{children:`Receiving bank for ACH deposits to this wallet, when available.`}),_jsxs(Expandable,{title:`depositInstructions`,defaultOpen:true,children:[_jsx(ResponseField,{name:`attributes.depositInstructions.bankName`,type:`string`,required:true,id:`param-attributes-deposit-instructions-bank-name`,children:_jsx(_components.p,{children:`Name of the receiving bank.`})}),_jsx(ResponseField,{name:`attributes.depositInstructions.accountNumber`,type:`string | null`,required:true,id:`param-attributes-deposit-instructions-account-number`,children:_jsx(_components.p,{children:`Account number for ACH deposits. Returned when fetching a single wallet, null in list responses.`})}),_jsx(ResponseField,{name:`attributes.depositInstructions.routingNumber`,type:`string | null`,required:true,id:`param-attributes-deposit-instructions-routing-number`,children:_jsx(_components.p,{children:`Bank routing number for ACH deposits. Returned when fetching a single wallet, null in list responses.`})})]})]})]})]}),`\n`,_jsxs(ResponseField,{name:`relationships`,type:`object`,required:true,id:`param-relationships`,children:[_jsx(_components.p,{children:`Related resources, each by type and ID.`}),_jsx(Expandable,{title:`relationships`,defaultOpen:true,children:_jsxs(ResponseField,{name:`relationships.party`,type:`object`,required:true,id:`param-relationships-party`,children:[_jsx(_components.p,{children:`Party that owns the wallet.`}),_jsx(Expandable,{title:`party`,defaultOpen:true,children:_jsxs(ResponseField,{name:`relationships.party.data`,type:`object`,required:true,id:`param-relationships-party-data`,children:[_jsx(_components.p,{children:`Related resource identifier.`}),_jsxs(Expandable,{title:`data`,defaultOpen:true,children:[_jsx(ResponseField,{name:`relationships.party.data.type`,type:`string`,required:true,id:`param-relationships-party-data-type`,children:_jsxs(_components.p,{children:[`Resource type. Always `,_jsx(_components.code,{children:`party`}),`.`]})}),_jsx(ResponseField,{name:`relationships.party.data.id`,type:`string`,required:true,id:`param-relationships-party-data-id`,children:_jsx(_components.p,{children:`Party ID (pty_*).`})})]})]})})]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`statuses`,children:`Statuses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Meaning`}),_jsx(_components.th,{children:`Can become`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`active`})}),_jsx(_components.td,{children:`The wallet can send and receive money.`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`frozen`}),`, `,_jsx(_components.code,{children:`closed`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`frozen`})}),_jsx(_components.td,{children:`The wallet can’t send or receive money. You can unfreeze a wallet you froze; a wallet Natural froze stays frozen until Natural unfreezes it.`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`active`}),`, `,_jsx(_components.code,{children:`closed`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`closed`})}),_jsx(_components.td,{children:`Natural closed the wallet. It can’t be reopened.`}),_jsx(_components.td,{children:`Final`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`events`,children:`Events`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/event-catalog#wallets`,children:_jsx(_components.code,{children:`wallet.created`})}),`: A wallet was created for a party.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(_components.p,{children:[`See the `,_jsx(_components.a,{href:`/api-reference/errors/wallets`,children:`error codes`}),` these endpoints return.`]}),`\n`,_jsx(Heading,{level:`2`,id:`sandbox-simulations`,children:`Sandbox simulations`}),`\n`,_jsx(_components.p,{children:`None.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"The Wallet object","description":"Every field, status and event of a wallet","seo":{"title":"The Wallet object — Natural"},"href":"/api-reference/wallets/object"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Example","slug":"example","depth":2,"children":[]},{"title":"Fields","slug":"fields","depth":2,"children":[]},{"title":"Statuses","slug":"statuses","depth":2,"children":[]},{"title":"Events","slug":"events","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]},{"title":"Sandbox simulations","slug":"sandbox-simulations","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/natural-b3c9dd77/0ceb5543581607cd/scripts.js"],"subdomain":"natural-b3c9dd77","siteName":"Natural Docs","title":"The Wallet object - Natural Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T21:59:23.008Z","originalFileLocation":"api-reference/wallets/object.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Every field, status and event of a wallet\">\u003cmeta data-mint-head name=\"keywords\" content=\"agentic payments, agentic commerce\">\u003cmeta data-mint-head name=\"application-name\" content=\"Natural Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"The Wallet object - Natural Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Every field, status and event of a wallet\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Natural Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.natural.com/api-reference/wallets/object\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.natural.com/opengraph.jpg\">\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=\"The Wallet object - Natural Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Every field, status and event of a wallet\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.natural.com/opengraph.jpg\">\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/natural-b3c9dd77/HuAp-mBwQpQpv_BI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Natural Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#161514\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.natural.com/api-reference/wallets/object\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/wallets/object.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.natural.com/#organization\",\"name\":\"Natural Docs\",\"url\":\"https://docs.natural.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/natural-b3c9dd77/REM_B9AkmUAD-dJ_/assets/brand/natural-logo.svg?fit=max\u0026auto=format\u0026n=REM_B9AkmUAD-dJ_\u0026q=85\u0026s=fa43286ff575578982982760f31e74d6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.natural.com#website\",\"name\":\"Natural Docs\",\"url\":\"https://docs.natural.com\",\"publisher\":{\"@id\":\"https://docs.natural.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.natural.com/api-reference/wallets/object#webpage\",\"url\":\"https://docs.natural.com/api-reference/wallets/object\",\"name\":\"The Wallet object\",\"description\":\"Every field, status and event of a wallet\",\"dateModified\":\"2026-11-20T21:59:23.008Z\",\"isPartOf\":{\"@id\":\"https://docs.natural.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.natural.com/api-reference/wallets/object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.natural.com/api-reference/wallets/object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Natural Docs\",\"item\":\"https://docs.natural.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"The Wallet object\",\"item\":\"https://docs.natural.com/api-reference/wallets/object\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.natural.com/api-reference/wallets/object#article\",\"headline\":\"The Wallet object\",\"name\":\"The Wallet object\",\"description\":\"Every field, status and event of a wallet\",\"url\":\"https://docs.natural.com/api-reference/wallets/object\",\"mainEntityOfPage\":{\"@id\":\"https://docs.natural.com/api-reference/wallets/object#webpage\"},\"image\":\"https://docs.natural.com/opengraph.jpg\",\"dateModified\":\"2026-11-20T21:59:23.008Z\",\"publisher\":{\"@id\":\"https://docs.natural.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.natural.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Natural Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Natural Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/wallets/object.md","siteName":"Natural Docs","nav":{"global":null,"tabs":[{"tab":"About","pages":[{"title":"About","href":"/guides/overview/start-here"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"About the Natural API","href":"/api-reference/about"},{"group":"Our interfaces","pages":[{"title":"MCP","href":"/guides/platform/mcp"},{"title":"SDKs","href":"/guides/platform/sdks"},{"title":"CLI","href":"/guides/platform/cli"},{"title":"Dashboard","href":"/guides/platform/dashboard"}]},{"group":"Our technology","pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"IDs","href":"/api-reference/IDs"},{"title":"Formats","href":"/api-reference/formats"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate limits","href":"/api-reference/rate-limits"},{"title":"Backwards compatibility","href":"/api-reference/backwards-compatibility"},{"title":"Reliability","href":"/guides/platform/reliability"},{"group":"Sandbox","pages":[{"title":"Sandbox","href":"/api-reference/sandbox/overview"},{"title":"Payment fixtures","sidebarTitle":"Payment fixtures","href":"/api-reference/sandbox/fixtures"},{"title":"Card fixtures","sidebarTitle":"Card fixtures","href":"/api-reference/sandbox/card-fixtures"},{"title":"Issued cards in Sandbox","sidebarTitle":"Issued cards","href":"/api-reference/sandbox/issued-cards"},{"title":"Sandbox from MCP, CLI, and SDKs","sidebarTitle":"MCP, CLI \u0026 SDKs","href":"/api-reference/sandbox/surfaces"}]}]}]},{"group":"Account","pages":[{"group":"Parties","pages":[{"title":"The Party object","href":"/api-reference/parties/object"},{"title":"Get party","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parties/me","href":"/api-reference/parties/get-party"},{"title":"Get party compliance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parties/{partyId}/compliance","href":"/api-reference/parties/get-party-compliance"},{"title":"Update party","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /parties/me","href":"/api-reference/parties/update-party"},{"title":"Set party handle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /parties/me/handle","href":"/api-reference/parties/set-party-handle"}]},{"group":"Party Members","pages":[{"title":"The Party Member object","href":"/api-reference/party-members/object"},{"title":"List party members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parties/me/members","href":"/api-reference/parties/list-party-members"},{"title":"Remove party member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /parties/me/members/{userId}","href":"/api-reference/parties/remove-party-member"}]},{"group":"Party Branding","pages":[{"title":"The Party Branding object","href":"/api-reference/party-branding/object"},{"title":"Create branding photo upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /parties/{partyId}/branding/photo-uploads","href":"/api-reference/parties/create-branding-photo-upload"},{"title":"Get party branding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parties/{partyId}/branding","href":"/api-reference/parties/get-party-branding"},{"title":"Update party branding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /parties/{partyId}/branding","href":"/api-reference/parties/update-party-branding"}]},{"group":"Party Invitations","pages":[{"title":"The Party Invitation object","href":"/api-reference/party-invitations/object"},{"title":"Create party invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /party-invitations","href":"/api-reference/invitations/create-party-invitations"},{"title":"List party invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /party-invitations","href":"/api-reference/invitations/list-party-invitations"},{"title":"Revoke party invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /party-invitations/{invitationId}","href":"/api-reference/invitations/revoke-party-invitation"}]},{"group":"API Keys","pages":[{"title":"The API Key object","href":"/api-reference/api-keys/object"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api-keys","href":"/api-reference/api-keys/create-api-key"},{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Get API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api-keys/{keyId}","href":"/api-reference/api-keys/get-api-key"},{"title":"Revoke API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api-keys/{keyId}","href":"/api-reference/api-keys/revoke-api-key"}]},{"group":"Agents","pages":[{"title":"The Agent object","href":"/api-reference/agents/object"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents","href":"/api-reference/agents/create-agent"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/agents/list-agents"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{agentId}","href":"/api-reference/agents/get-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{agentId}","href":"/api-reference/agents/update-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{agentId}","href":"/api-reference/agents/delete-agent"}]},{"group":"Agent Keys","pages":[{"title":"The Agent Key object","href":"/api-reference/agent-keys/object"},{"title":"Create agent key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent-keys","href":"/api-reference/agent-keys/create-agent-key"},{"title":"List agent keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-keys","href":"/api-reference/agent-keys/list-agent-keys"},{"title":"Rotate agent key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent-keys/{keyId}/rotate","href":"/api-reference/agent-keys/rotate-agent-key"},{"title":"Revoke agent key","description":"Revoke an agent key of your party. Only a user session can revoke a key; a call made with an API key or agent key gets `403`. Returns the [Agent Key object](/api-reference/agent-keys/object).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agent-keys/{keyId}","href":"/api-reference/agent-keys/revoke-agent-key"}]}]},{"group":"Wallets and funding","pages":[{"group":"Wallets","pages":[{"title":"The Wallet object","href":"/api-reference/wallets/object"},{"title":"Create wallet","description":"Create a standard wallet for your party. An agent can create one only when it acts for a party through a delegation; otherwise the call returns `403`. Returns the [Wallet object](/api-reference/wallets/object).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets","href":"/api-reference/wallets/create-wallet"},{"title":"List wallets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wallets","href":"/api-reference/wallets/list-wallets"},{"title":"Get wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wallets/{walletId}","href":"/api-reference/wallets/get-wallet"},{"title":"Update wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /wallets/{walletId}","href":"/api-reference/wallets/update-wallet"},{"title":"Set default wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets/{walletId}/default","href":"/api-reference/wallets/set-default-wallet"},{"title":"Freeze wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets/{walletId}/freeze","href":"/api-reference/wallets/freeze-wallet"},{"title":"Unfreeze wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets/{walletId}/unfreeze","href":"/api-reference/wallets/unfreeze-wallet"}]},{"group":"Wallet Access","pages":[{"title":"The Wallet Access object","href":"/api-reference/wallet-access/object"},{"title":"Grant agent access to wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets/{walletId}/agents","href":"/api-reference/wallets/grant-agent-access-to-wallet"},{"title":"List wallet agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wallets/{walletId}/agents","href":"/api-reference/wallets/list-wallet-agents"},{"title":"Set agent default wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wallets/{walletId}/agents/{agentId}/default","href":"/api-reference/wallets/set-agent-default-wallet"},{"title":"Detach agent from wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /wallets/{walletId}/agents/{agentId}","href":"/api-reference/wallets/detach-agent-from-wallet"}]},{"group":"External Accounts","pages":[{"title":"The External Account object","href":"/api-reference/external-accounts/object"},{"title":"List external accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-accounts","href":"/api-reference/external-accounts/list-external-accounts"},{"title":"Get external account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-accounts/{externalAccountId}","href":"/api-reference/external-accounts/get-external-account"},{"title":"Remove external account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /external-accounts/{externalAccountId}","href":"/api-reference/external-accounts/remove-external-account"},{"group":"Simulations","pages":[{"title":"Sandbox: Link a test bank account","openapi":"POST /simulations/external-accounts/link","href":"/api-reference/simulations/link-test-bank-account"}]}]},{"group":"Transfers","pages":[{"title":"The Transfer object","href":"/api-reference/transfers/object"},{"title":"Initiate deposit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /transfers/deposit","href":"/api-reference/transfers/initiate-deposit"},{"title":"Initiate withdrawal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /transfers/withdraw","href":"/api-reference/transfers/initiate-withdrawal"},{"title":"Initiate internal transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /transfers/internal","href":"/api-reference/transfers/initiate-internal-transfer"},{"title":"List transfers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transfers","href":"/api-reference/transfers/list-transfers"},{"title":"Get transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transfers/{transferId}","href":"/api-reference/transfers/get-transfer"}]},{"group":"Transactions","pages":[{"title":"The Transaction object","href":"/api-reference/transactions/object"},{"title":"List transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Get transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions/{transactionId}","href":"/api-reference/transactions/get-transaction"}]}]},{"group":"Payments","pages":[{"group":"Payments","pages":[{"title":"The Payment object","href":"/api-reference/payments/object"},{"title":"Create payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payments","href":"/api-reference/payments/create-payment"},{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payments","href":"/api-reference/payments/list-payments"},{"title":"Get payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payments/{paymentId}","href":"/api-reference/payments/get-payment"},{"title":"Cancel payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payments/{paymentId}/cancel","href":"/api-reference/payments/cancel-payment"},{"group":"Simulations","pages":[{"title":"Sandbox: Complete a payment claim","openapi":"POST /simulations/payments/{paymentId}/complete-claim","href":"/api-reference/simulations/complete-payment-claim"}]}]},{"group":"Payment Requests","pages":[{"title":"The Payment Request object","href":"/api-reference/payment-requests/object"},{"title":"Create payment request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-requests","href":"/api-reference/paymentrequests/create-payment-request"},{"title":"List payment requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-requests","href":"/api-reference/paymentrequests/list-payment-requests"},{"title":"List incoming payment requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-requests/incoming","href":"/api-reference/paymentrequests/list-incoming-payment-requests"},{"title":"Get payment request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-requests/{paymentRequestId}","href":"/api-reference/paymentrequests/get-payment-request"},{"title":"Fulfill payment request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-requests/{paymentRequestId}/fulfill","href":"/api-reference/paymentrequests/fulfill-payment-request"},{"title":"Decline payment request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-requests/{paymentRequestId}/decline","href":"/api-reference/paymentrequests/decline-payment-request"},{"title":"Cancel payment request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-requests/{paymentRequestId}/cancel","href":"/api-reference/paymentrequests/cancel-payment-request"},{"group":"Simulations","pages":[{"title":"Sandbox: Fulfill a payment request","openapi":"POST /simulations/payment-requests/{paymentRequestId}/fulfill","href":"/api-reference/simulations/fulfill-payment-request"},{"title":"Sandbox: Decline a payment request","openapi":"POST /simulations/payment-requests/{paymentRequestId}/decline","href":"/api-reference/simulations/decline-payment-request"}]}]},{"group":"Payment attachments","pages":[{"title":"The Attachment object","href":"/api-reference/payment-attachments/object"},{"title":"Create attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /attachments","href":"/api-reference/payment-attachments/create-attachment"},{"title":"List attachments","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /attachments","href":"/api-reference/payment-attachments/list-attachments"},{"title":"Export attachment references","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /attachments/export","href":"/api-reference/payment-attachments/export-attachment-references"},{"title":"Get attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /attachments/{attachmentId}","href":"/api-reference/payment-attachments/get-attachment"},{"title":"Download attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /attachments/{attachmentId}/download","href":"/api-reference/payment-attachments/download-attachment"},{"title":"Delete attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json delete /attachments/{attachmentId}","href":"/api-reference/payment-attachments/delete-attachment"}]}]},{"group":"Direct","pages":[{"group":"Direct: External parties","expanded":false,"pages":[{"title":"The External Party object","href":"/api-reference/external-parties/object"},{"title":"Create external party","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /external-parties","href":"/api-reference/external-parties/create-external-party"},{"title":"List external parties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-parties","href":"/api-reference/external-parties/list-external-parties"},{"title":"Get external party","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-parties/{externalPartyId}","href":"/api-reference/external-parties/get-external-party"},{"title":"Correct an external party address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /external-parties/{externalPartyId}/address","href":"/api-reference/external-parties/correct-an-external-party-address"}]},{"group":"Direct: External party accounts","expanded":false,"pages":[{"title":"The External Party Account object","href":"/api-reference/external-party-accounts/object"},{"title":"Store banking details for an external party","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /external-party-accounts","href":"/api-reference/external-party-accounts/store-banking-details-for-an-external-party"},{"title":"List external party accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-party-accounts","href":"/api-reference/external-party-accounts/list-external-party-accounts"},{"title":"Get external party account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-party-accounts/{externalPartyAccountId}","href":"/api-reference/external-party-accounts/get-external-party-account"}]},{"group":"Direct: ACH","expanded":false,"pages":[{"title":"The ACH object","href":"/api-reference/ach/object"},{"title":"Create ACH payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /ach","href":"/api-reference/ach/create-ach-payment"},{"title":"List ACH payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ach","href":"/api-reference/ach/list-ach-payments"},{"title":"Get ACH payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ach/{achId}","href":"/api-reference/ach/get-ach-payment"},{"title":"Cancel ACH payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /ach/{achId}/cancel","href":"/api-reference/ach/cancel-ach-payment"}]},{"group":"Direct: Realtime","expanded":false,"pages":[{"title":"The Realtime object","href":"/api-reference/realtime/object"},{"title":"Create realtime payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /realtime","href":"/api-reference/realtime/create-realtime-payment"},{"title":"List realtime payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /realtime","href":"/api-reference/realtime/list-realtime-payments"},{"title":"Get realtime payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /realtime/{realtimeId}","href":"/api-reference/realtime/get-realtime-payment"},{"title":"Cancel realtime payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /realtime/{realtimeId}/cancel","href":"/api-reference/realtime/cancel-realtime-payment"},{"group":"Simulations","pages":[{"title":"Sandbox: Settle a realtime payment","openapi":"POST /simulations/realtime/{realtimeId}/settle","href":"/api-reference/simulations/settle-realtime-payment"},{"title":"Sandbox: Fail a realtime payment","openapi":"POST /simulations/realtime/{realtimeId}/fail","href":"/api-reference/simulations/fail-realtime-payment"}]}]},{"group":"Direct: Wire","expanded":false,"pages":[{"title":"The Wire object","href":"/api-reference/wire/object"},{"title":"Create wire payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wire","href":"/api-reference/wire/create-wire-payment"},{"title":"List wire payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wire","href":"/api-reference/wire/list-wire-payments"},{"title":"Get wire payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wire/{wireId}","href":"/api-reference/wire/get-wire-payment"},{"title":"Cancel wire payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wire/{wireId}/cancel","href":"/api-reference/wire/cancel-wire-payment"},{"group":"Simulations","pages":[{"title":"Sandbox: Complete a wire","openapi":"POST /simulations/wire/{wireId}/settle","href":"/api-reference/simulations/settle-wire"},{"title":"Sandbox: Reject a wire","openapi":"POST /simulations/wire/{wireId}/fail","href":"/api-reference/simulations/fail-wire"}]}]},{"group":"Direct: Check","expanded":false,"pages":[{"title":"The Check object","href":"/api-reference/check/object"},{"title":"Create check payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /check","href":"/api-reference/check/create-check-payment"},{"title":"List check payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /check","href":"/api-reference/check/list-check-payments"},{"title":"Get check payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /check/{checkId}","href":"/api-reference/check/get-check-payment"},{"title":"Cancel check payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /check/{checkId}/cancel","href":"/api-reference/check/cancel-check-payment"},{"group":"Simulations","pages":[{"title":"Sandbox: Deposit a check","openapi":"POST /simulations/check/{checkId}/deposit","href":"/api-reference/simulations/deposit-check"},{"title":"Sandbox: Fail a check","openapi":"POST /simulations/check/{checkId}/fail","href":"/api-reference/simulations/fail-check"},{"title":"Sandbox: Bounce a check","openapi":"POST /simulations/check/{checkId}/bounce","href":"/api-reference/simulations/bounce-check"},{"title":"Sandbox: Void a check","openapi":"POST /simulations/check/{checkId}/void","href":"/api-reference/simulations/void-check"},{"title":"Sandbox: Stop a check","openapi":"POST /simulations/check/{checkId}/stop","href":"/api-reference/simulations/stop-check"},{"title":"Sandbox: Deliver a check","openapi":"POST /simulations/check/{checkId}/deliver","href":"/api-reference/simulations/deliver-check"},{"title":"Sandbox: Return a check to sender","openapi":"POST /simulations/check/{checkId}/return-to-sender","href":"/api-reference/simulations/return-check-to-sender"}]}]}]},{"group":"Connect","pages":[{"group":"Customers","pages":[{"title":"The Customer object","href":"/api-reference/customers/object"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers","href":"/api-reference/customers/list-customers"},{"title":"Get customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/{customerPartyId}","href":"/api-reference/customers/get-customer"},{"title":"Revoke agent access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customers/{customerPartyId}/agents/{agentId}","href":"/api-reference/customers/revoke-agent-access"},{"title":"Disconnect customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customers/{customerPartyId}","href":"/api-reference/customers/disconnect-customer"},{"group":"Simulations","pages":[{"title":"Sandbox: Invite a test customer","openapi":"POST /simulations/invite-customer","href":"/api-reference/simulations/create-test-customer"},{"title":"Sandbox: Fund a Connect customer","openapi":"POST /simulations/customers/{customerPartyId}/transfers/deposit","href":"/api-reference/simulations/fund-test-customer"},{"title":"Sandbox: Accept a Connect invitation","openapi":"POST /simulations/customer-invitations/{invitationId}/accept","href":"/api-reference/simulations/accept-customer-invitation"},{"title":"Sandbox: Decline a Connect invitation","openapi":"POST /simulations/customer-invitations/{invitationId}/decline","href":"/api-reference/simulations/decline-customer-invitation"},{"title":"Sandbox: Revoke Connect access","openapi":"POST /simulations/customers/{customerPartyId}/agents/{agentId}/revoke","href":"/api-reference/simulations/revoke-agent-connection"},{"title":"Sandbox: Disconnect a Connect customer","openapi":"POST /simulations/customers/{customerPartyId}/disconnect","href":"/api-reference/simulations/disconnect-customer"}]}]},{"group":"Customer Invitations","pages":[{"title":"The Customer Invitation object","href":"/api-reference/customer-invitations/object"},{"title":"Invite customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/invitations","href":"/api-reference/customers/invite-customers"},{"title":"List customer invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/invitations","href":"/api-reference/customers/list-customer-invitations"},{"title":"Revoke customer invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customers/invitations/{invitationId}","href":"/api-reference/customers/revoke-customer-invitation"}]},{"group":"Invitation Links","pages":[{"title":"The Invitation Link object","href":"/api-reference/invitation-links/object"},{"title":"Create invitation link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/invitation-links","href":"/api-reference/invitation-links/create-invitation-link"},{"title":"List invitation links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/invitation-links","href":"/api-reference/invitation-links/list-invitation-links"},{"title":"Get invitation link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/invitation-links/{linkId}","href":"/api-reference/invitation-links/get-invitation-link"},{"title":"Revoke invitation link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/invitation-links/{linkId}/revoke","href":"/api-reference/invitation-links/revoke-invitation-link"}]}]},{"group":"Controls","pages":[{"group":"Approvals","pages":[{"title":"The Approval object","href":"/api-reference/approvals/object"},{"title":"List approvals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /approvals","href":"/api-reference/approvals/list-approvals"},{"title":"Get approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /approvals/{approvalId}","href":"/api-reference/approvals/get-approval"},{"title":"Approve payment or transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /approvals/{approvalId}/approve","href":"/api-reference/approvals/approve-payment-or-transfer"},{"title":"Deny payment or transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /approvals/{approvalId}/deny","href":"/api-reference/approvals/deny-payment-or-transfer"}]},{"group":"Limits","pages":[{"title":"The Party Limit Policy object","href":"/api-reference/limits/object"},{"title":"Set party approval limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /parties/me/limits","href":"/api-reference/parties/set-party-approval-limits"},{"title":"Get party approval limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parties/me/limits","href":"/api-reference/parties/get-party-approval-limits"},{"title":"Disable party approval limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /parties/me/limits","href":"/api-reference/parties/disable-party-approval-limits"}]}]},{"group":"Accept","pages":[{"group":"Payment Intents","pages":[{"title":"The Payment Intent object","href":"/api-reference/payment-intents/object"},{"title":"Create payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-intents","href":"/api-reference/payment-intents/create-payment-intent"},{"title":"Capture payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /payment-intents/{paymentIntentId}/capture","href":"/api-reference/payment-intents/capture-payment-intent"},{"title":"Cancel payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment-intents/{paymentIntentId}/cancel","href":"/api-reference/payment-intents/cancel-payment-intent"},{"title":"List payment intents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-intents","href":"/api-reference/payment-intents/list-payment-intents"},{"title":"Get payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment-intents/{paymentIntentId}","href":"/api-reference/payment-intents/get-payment-intent"},{"title":"Update payment intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /payment-intents/{paymentIntentId}","href":"/api-reference/payment-intents/update-payment-intent"}]},{"group":"Card Payments","pages":[{"title":"The Card Payment object","href":"/api-reference/card-payments/object"},{"title":"List card payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-payments","href":"/api-reference/card-payments/list-card-payments"},{"title":"Get card payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-payments/{cardPaymentId}","href":"/api-reference/card-payments/get-card-payment"},{"group":"Simulations","pages":[{"title":"Sandbox: Settle a card payment","openapi":"POST /simulations/card-payments/{cardPaymentId}/settle","href":"/api-reference/simulations/settle-card-payment"}]}]},{"group":"Refunds","pages":[{"title":"The Refund object","href":"/api-reference/refunds/object"},{"title":"Create refund","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /refunds","href":"/api-reference/refunds/create-refund"},{"title":"List refunds","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /refunds","href":"/api-reference/refunds/list-refunds"},{"title":"Get refund","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /refunds/{refundId}","href":"/api-reference/refunds/get-refund"}]},{"group":"Chargebacks","pages":[{"title":"The Chargeback object","href":"/api-reference/chargebacks/object"},{"title":"List chargebacks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chargebacks","href":"/api-reference/chargebacks/list-chargebacks"},{"title":"Get chargeback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chargebacks/{chargebackId}","href":"/api-reference/chargebacks/get-chargeback"},{"title":"Submit chargeback evidence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chargebacks/{chargebackId}/submit","href":"/api-reference/chargebacks/submit-chargeback-evidence"},{"title":"Accept chargeback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chargebacks/{chargebackId}/accept","href":"/api-reference/chargebacks/accept-chargeback"}]},{"group":"Chargeback Evidence","pages":[{"title":"The Chargeback Evidence object","href":"/api-reference/chargeback-evidence/object"},{"title":"Get chargeback evidence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chargebacks/{chargebackId}/evidence","href":"/api-reference/chargebacks/get-chargeback-evidence"},{"title":"Update chargeback evidence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /chargebacks/{chargebackId}/evidence","href":"/api-reference/chargebacks/update-chargeback-evidence"},{"title":"Upload chargeback file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /chargebacks/{chargebackId}/files","href":"/api-reference/chargebacks/upload-chargeback-file"},{"title":"Preview chargeback evidence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /chargebacks/{chargebackId}/evidence/preview","href":"/api-reference/chargebacks/preview-chargeback-evidence"}]},{"group":"Subscriptions","pages":[{"title":"The Subscription object","href":"/api-reference/subscriptions/object"},{"title":"Create subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /subscriptions","href":"/api-reference/subscriptions/create-subscription"},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /subscriptions","href":"/api-reference/subscriptions/list-subscriptions"},{"title":"Get subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /subscriptions/{subscriptionId}","href":"/api-reference/subscriptions/get-subscription"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /subscriptions/{subscriptionId}/cancel","href":"/api-reference/subscriptions/cancel-subscription"}]},{"group":"Subscription Payments","pages":[{"title":"The Subscription Payment object","href":"/api-reference/subscription-payments/object"},{"title":"List subscription payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /subscriptions/{subscriptionId}/payments","href":"/api-reference/subscriptions/list-subscription-payments"},{"title":"Get subscription payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /subscriptions/{subscriptionId}/payments/{subscriptionPaymentId}","href":"/api-reference/subscriptions/get-subscription-payment"},{"title":"Mark subscription payment paid","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /subscriptions/{subscriptionId}/payments/{subscriptionPaymentId}/mark-paid","href":"/api-reference/subscriptions/mark-subscription-payment-paid"}]},{"group":"Setup intents","pages":[{"title":"The Setup Intent object","href":"/api-reference/setup-intents/object"},{"title":"Create setup intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /setup-intents","href":"/api-reference/setup-intents/create-setup-intent"},{"title":"Get setup intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /setup-intents/{setupIntentId}","href":"/api-reference/setup-intents/get-setup-intent"},{"title":"Cancel setup intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /setup-intents/{setupIntentId}/cancel","href":"/api-reference/setup-intents/cancel-setup-intent"}]},{"group":"Mandates","pages":[{"title":"The Mandate object","href":"/api-reference/mandates/object"},{"title":"Get mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json get /mandates/{mandateId}","href":"/api-reference/mandates/get-mandate"},{"title":"Revoke mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi-early-access.json post /mandates/{mandateId}/revoke","href":"/api-reference/mandates/revoke-mandate"}]},{"group":"Voice Sessions","pages":[{"title":"The Voice Session object","href":"/api-reference/voice/object"},{"title":"Create voice session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice/sessions","href":"/api-reference/voice/create-voice-session"},{"title":"List voice sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice/sessions","href":"/api-reference/voice/list-voice-sessions"},{"title":"Get voice session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice/sessions/{voiceSessionId}","href":"/api-reference/voice/get-voice-session"},{"group":"Simulations","pages":[{"title":"Sandbox: Simulate a voice call","openapi":"api-reference/openapi-early-access.json POST /simulations/voice-sessions/{voiceSessionId}","href":"/api-reference/simulations/simulate-voice-call"}]}]},{"group":"Voice Session Transcripts","pages":[{"title":"The Voice Session Transcript object","href":"/api-reference/voice-session-transcripts/object"},{"title":"Get voice session transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice/sessions/{voiceSessionId}/transcript","href":"/api-reference/voice/get-voice-session-transcript"}]}]},{"group":"Cards","pages":[{"group":"External cards","pages":[{"title":"The External Card object","href":"/api-reference/external-cards/object"},{"title":"List external cards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /external-cards","href":"/api-reference/external-cards/list-external-cards"},{"title":"Remove external card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /external-cards/{externalCardId}","href":"/api-reference/external-cards/remove-external-card"}]},{"group":"Browser tokens","pages":[{"title":"Overview","href":"/guides/concepts/browser-tokens"},{"title":"Kernel","sidebarTitle":"Use with Kernel","href":"/guides/integrations/kernel"},{"title":"Browser Use","sidebarTitle":"Use with Browser Use","href":"/guides/integrations/browser-use"},{"title":"Encrypted card fields","sidebarTitle":"Encrypted card fields","href":"/guides/integrations/encrypted-card-fields"},{"title":"Create card session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /card-sessions","href":"/api-reference/card-sessions/create-card-session"},{"title":"List card sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-sessions","href":"/api-reference/card-sessions/list-card-sessions"},{"title":"Get card session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card-sessions/{sessionId}","href":"/api-reference/card-sessions/get-card-session"},{"title":"Claim card session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /card-sessions/{sessionId}/claim","href":"/api-reference/card-sessions/claim-card-session"},{"title":"Create merchant report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /merchant-reports","href":"/api-reference/merchant-reports/create-merchant-report"}]},{"group":"Agent tokens","pages":[{"title":"Overview","href":"/guides/concepts/agent-tokens"},{"title":"Get agentic card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic-payments/cards/{cardId}","href":"/api-reference/agent-tokens/get-agentic-card"},{"title":"List agentic mandates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic-payments/mandates","href":"/api-reference/agent-tokens/list-agentic-mandates"},{"title":"Get agentic mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic-payments/mandates/{mandateId}","href":"/api-reference/agent-tokens/get-agentic-mandate"},{"title":"Create agentic purchase","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic-payments/purchases","href":"/api-reference/agent-tokens/create-agentic-purchase"},{"title":"Get agentic purchase","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agentic-payments/purchases/{purchaseId}","href":"/api-reference/agent-tokens/get-agentic-purchase"},{"title":"Claim purchase credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic-payments/purchases/{purchaseId}/claim","href":"/api-reference/agent-tokens/claim-purchase-credential"},{"title":"Cancel agentic purchase","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agentic-payments/purchases/{purchaseId}/cancel","href":"/api-reference/agent-tokens/cancel-agentic-purchase"}]}]},{"group":"Webhooks and events","pages":[{"group":"Webhooks","pages":[{"title":"The Webhook object","href":"/api-reference/webhooks/object"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Rotate webhook signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{webhookId}/rotate-secret","href":"/api-reference/webhooks/rotate-webhook-signing-secret"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/{webhookId}","href":"/api-reference/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /webhooks/{webhookId}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /webhooks/{webhookId}","href":"/api-reference/webhooks/delete-webhook"}]},{"group":"Events","pages":[{"title":"The Event object","href":"/api-reference/events/object"},{"title":"Event types","sidebarTitle":"Event catalog","href":"/api-reference/event-catalog"},{"title":"List events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /events","href":"/api-reference/events/list-events"},{"title":"Get event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /events/{eventId}","href":"/api-reference/events/get-event"},{"title":"Redeliver event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{webhookId}/events/{eventId}/redeliver","href":"/api-reference/events/redeliver-event"}]}]},{"group":"Errors","pages":[{"title":"Error handling","href":"/api-reference/errors/error-handling"},{"group":"Resource errors","boost":0.3,"pages":[{"title":"Agents","href":"/api-reference/errors/agents"},{"title":"Customers","href":"/api-reference/errors/customers"},{"title":"Invitation Links","href":"/api-reference/errors/invitation-links"},{"title":"Payments","href":"/api-reference/errors/payments"},{"title":"Transactions","href":"/api-reference/errors/transactions"},{"title":"Transfers","href":"/api-reference/errors/transfers"},{"title":"Payment Requests","href":"/api-reference/errors/payment-requests"},{"title":"Payment Intents","href":"/api-reference/errors/payment-intents"},{"title":"Card Payments","href":"/api-reference/errors/card-payments"},{"title":"Subscriptions","href":"/api-reference/errors/subscriptions"},{"title":"Setup Intents","href":"/api-reference/errors/setup-intents"},{"title":"Mandates","href":"/api-reference/errors/mandates"},{"title":"Voice Sessions","href":"/api-reference/errors/voice-sessions"},{"title":"Refunds","href":"/api-reference/errors/refunds"},{"title":"Chargebacks","href":"/api-reference/errors/chargebacks"},{"title":"Approvals","href":"/api-reference/errors/approvals"},{"title":"Parties","href":"/api-reference/errors/parties"},{"title":"Party Invitations","href":"/api-reference/errors/party-invitations"},{"title":"Wallets","href":"/api-reference/errors/wallets"},{"title":"External Accounts","href":"/api-reference/errors/external-accounts"},{"title":"External Parties","href":"/api-reference/errors/external-parties"},{"title":"External Party Accounts","href":"/api-reference/errors/external-party-accounts"},{"title":"ACH","href":"/api-reference/errors/ach"},{"title":"Realtime","href":"/api-reference/errors/realtime"},{"title":"Wire","href":"/api-reference/errors/wire"},{"title":"Check","href":"/api-reference/errors/check"},{"title":"API keys","href":"/api-reference/errors/api-keys"},{"title":"Agent keys","href":"/api-reference/errors/agent-keys"},{"title":"Card sessions","href":"/api-reference/errors/card-sessions"},{"title":"Merchant reports","href":"/api-reference/errors/merchant-reports"},{"title":"Webhooks","href":"/api-reference/errors/webhooks"},{"title":"Events","href":"/api-reference/errors/events"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"The Wallet object - Natural Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}