Request a withdrawal to return funds back to the owner or to a requoted processing address.
This endpoint should be used when a payment cannot be completed and funds need to be returned.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Option 1
Option 2
Identify the funds to withdraw with withdraw_from, passed through exactly as returned by
POST /payments/issues or POST /payments/balances. Either a non-null withdraw_from or the
deprecated payment_id must be provided.
Authorization data to sign. For EIP712, this is a JSON string to parse and pass to signTypedData. For EIP191, pass this string directly to signMessage.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Halliday","colors":{"primary":"#DDA2FF","light":"#DDA2FF","dark":"#DDA2FF"},"logo":{"light":"https://mintcdn.com/halliday/hq55KYeh-6LQtBNf/public/img/HallidayLogo_Color.png?fit=max\u0026auto=format\u0026n=hq55KYeh-6LQtBNf\u0026q=85\u0026s=486868ed309a361db91db1034289ee57","dark":"https://mintcdn.com/halliday/hq55KYeh-6LQtBNf/public/img/HallidayLogo_White.png?fit=max\u0026auto=format\u0026n=hq55KYeh-6LQtBNf\u0026q=85\u0026s=9ad14e1dc685e47fa07a382b14667a14"},"favicon":"https://mintcdn.com/halliday/hq55KYeh-6LQtBNf/public/favicon.ico?fit=max\u0026auto=format\u0026n=hq55KYeh-6LQtBNf\u0026q=85\u0026s=90797886eb509d21e8d5403d4e9ffc0a","navbar":{"links":[{"href":"mailto:support@halliday.xyz","label":"Support"}],"primary":{"type":"button","label":"Book a Sales Call","href":"https://calendly.com/dante-halliday/30min"}},"footer":{"socials":{"x":"https://x.com/HallidayHQ","linkedin":"https://www.linkedin.com/company/halliday"}},"contextual":{"options":["chatgpt","claude","copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://blog.halliday.xyz/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"halliday","hasAudioNarration":false,"actualSubdomain":"halliday","customDomains":["docs.halliday.xyz"],"gitSource":{"type":"github","owner":"hallidayinc","repo":"hallidaydocs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ada78fcbe8cb2c2b49b4c5b","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Guides","count":24},{"language":"default","tag":"API Reference","count":22},{"language":"default","tag":"Payments","count":10},{"language":"default","tag":"Concepts \u0026 Info","count":6},{"language":"default","tag":"SDK Integrations","count":6},{"language":"default","tag":"Webhooks","count":6},{"language":"default","tag":"API Integrations","count":5},{"language":"default","tag":"Example Apps","count":4},{"language":"default","tag":"Assets","count":3},{"language":"default","tag":"Frequently Asked Questions","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#topbar-cta-button>a>div>span{margin:0px}#topbar-cta-button>a>div>svg{display:none}"}],"page":{"pagePath":"api-reference/payments/return-funds-to-owner-or-retry-payment","slug":"/api-reference/payments/return-funds-to-owner-or-retry-payment","pageMetadata":{"title":"Return funds to owner or retry payment","description":"Request a withdrawal to return funds back to the owner or to a requoted processing address.\nThis endpoint should be used when a payment cannot be completed and funds need to be returned.\n","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/withdraw","href":"/api-reference/payments/return-funds-to-owner-or-retry-payment","autogeneratedByOpenApi":true},"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: \"Request a withdrawal to return funds back to the owner or to a requoted processing address.\\nThis endpoint should be used when a payment cannot be completed and funds need to be returned.\"\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":"Return funds to owner or retry payment","description":"Request a withdrawal to return funds back to the owner or to a requoted processing address.\nThis endpoint should be used when a payment cannot be completed and funds need to be returned.\n","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/withdraw","href":"/api-reference/payments/return-funds-to-owner-or-retry-payment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Return funds to owner or retry payment","description":"Request a withdrawal to return funds back to the owner or to a requoted processing address.\nThis endpoint should be used when a payment cannot be completed and funds need to be returned.\n","operationId":"withdrawPayment","tags":["Payments"],"requestBody":"ea597c51-b774-40ee-80a8-ca5057fecd3a","responses":{"200":"0813b700-dd4e-4f7c-b82b-6585444111ef","400":"3ed33ddd-3c37-43f0-9771-e980b81e7bfc","401":"0d274cca-46c4-4f46-9248-12d15a485ec9","403":"a84bd603-90fe-4dfb-a3e1-e53dba6d1b85","404":"09f42f8f-fb10-47d1-8ba7-c0d0982eb165"},"method":"post","type":"path","servers":["b724eecd-a4ed-42fa-9a0c-8ff6407a392e"],"security":["05a97edf-e9d6-4de7-bdbe-ae97d91998f6"],"path":"/payments/withdraw","baseUrlOptions":["https://v2.prod.halliday.xyz"],"title":"Return funds to owner or retry payment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Identify the funds to withdraw with `withdraw_from`, passed through exactly as returned by\n`POST /payments/issues` or `POST /payments/balances`. Either a non-null `withdraw_from` or the\ndeprecated `payment_id` must be provided.\n","required":["token_amounts","recipient_address","withdraw_from"],"properties":{"withdraw_from":{"oneOf":[{"type":"object","description":"Where to withdraw from, passed through exactly as returned in `withdraw_from` by `POST /payments/issues` or `POST /payments/balances`.","required":["withdraw_type","payment_id","withdraw_account"],"properties":{"withdraw_type":{"type":"string","enum":["PAYMENT"],"isRequired":true,"uniqueKey":"oneOf.0.withdraw_from.oneOf.0.withdraw_type","typeLabel":"enum\u003cstring>"},"payment_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.withdraw_from.oneOf.0.payment_id","typeLabel":"string\u003cuuid>"},"withdraw_account":{"type":"string","enum":["INTENT","SPW","RDW"],"isRequired":true,"uniqueKey":"oneOf.0.withdraw_from.oneOf.0.withdraw_account","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"oneOf.0.withdraw_from.oneOf.0","typeLabel":"object"},{"type":"object","description":"Where to withdraw from, passed through exactly as returned in `withdraw_from` by `POST /payments/issues` or `POST /payments/balances`.","required":["withdraw_type","rdw_address"],"properties":{"withdraw_type":{"type":"string","enum":["EXTRA_RDW_BALANCE"],"isRequired":true,"uniqueKey":"oneOf.0.withdraw_from.oneOf.1.withdraw_type","typeLabel":"enum\u003cstring>"},"rdw_address":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.withdraw_from.oneOf.1.rdw_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.withdraw_from.oneOf.1","typeLabel":"object"},{"type":"null","description":"Where to withdraw from, passed through exactly as returned in `withdraw_from` by `POST /payments/issues` or `POST /payments/balances`.","isRequired":true,"uniqueKey":"oneOf.0.withdraw_from.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.withdraw_from","typeLabel":"object · object · null"},"token_amounts":{"type":"array","items":{"type":"object","required":["token","amount"],"properties":{"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"oneOf.0.token_amounts.items.[INDEX].token","typeLabel":"string"},"amount":{"type":"string","description":"Amount of the token to withdraw, represented as a string to preserve precision","isRequired":true,"uniqueKey":"oneOf.0.token_amounts.items.[INDEX].amount","typeLabel":"string"}},"uniqueKey":"oneOf.0.token_amounts.items.[INDEX]","typeLabel":"object"},"description":"List of token amounts to withdraw back to the owner or to a requoted processing address","isRequired":true,"uniqueKey":"oneOf.0.token_amounts","typeLabel":"object[]"},"recipient_address":{"type":"string","description":"Onchain address to withdraw the funds to. The assets will go to the address on the same chain the assets are on.","isRequired":true,"uniqueKey":"oneOf.0.recipient_address","typeLabel":"string"},"payment_id":{"type":"string","deprecated":true,"description":"ID of the payment to withdraw.","uniqueKey":"oneOf.0.payment_id","typeLabel":"string"},"withdraw_account":{"type":"string","enum":["INTENT","SPW","RDW"],"deprecated":true,"description":"Type of account to withdraw from.","uniqueKey":"oneOf.0.withdraw_account","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Identify the funds to withdraw with `withdraw_from`, passed through exactly as returned by\n`POST /payments/issues` or `POST /payments/balances`. Either a non-null `withdraw_from` or the\ndeprecated `payment_id` must be provided.\n","required":["token_amounts","recipient_address","payment_id"],"properties":{"token_amounts":{"type":"array","items":{"type":"object","required":["token","amount"],"properties":{"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"oneOf.1.token_amounts.items.[INDEX].token","typeLabel":"string"},"amount":{"type":"string","description":"Amount of the token to withdraw, represented as a string to preserve precision","isRequired":true,"uniqueKey":"oneOf.1.token_amounts.items.[INDEX].amount","typeLabel":"string"}},"uniqueKey":"oneOf.1.token_amounts.items.[INDEX]","typeLabel":"object"},"description":"List of token amounts to withdraw back to the owner or to a requoted processing address","isRequired":true,"uniqueKey":"oneOf.1.token_amounts","typeLabel":"object[]"},"recipient_address":{"type":"string","description":"Onchain address to withdraw the funds to. The assets will go to the address on the same chain the assets are on.","isRequired":true,"uniqueKey":"oneOf.1.recipient_address","typeLabel":"string"},"payment_id":{"type":"string","deprecated":true,"description":"ID of the payment to withdraw.","isRequired":true,"uniqueKey":"oneOf.1.payment_id","typeLabel":"string"},"withdraw_from":{"oneOf":[{"type":"object","description":"Where to withdraw from, passed through exactly as returned in `withdraw_from` by `POST /payments/issues` or `POST /payments/balances`.","required":["withdraw_type","payment_id","withdraw_account"],"properties":{"withdraw_type":{"type":"string","enum":["PAYMENT"],"isRequired":true,"uniqueKey":"oneOf.1.withdraw_from.oneOf.0.withdraw_type","typeLabel":"enum\u003cstring>"},"payment_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.withdraw_from.oneOf.0.payment_id","typeLabel":"string\u003cuuid>"},"withdraw_account":{"type":"string","enum":["INTENT","SPW","RDW"],"isRequired":true,"uniqueKey":"oneOf.1.withdraw_from.oneOf.0.withdraw_account","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.withdraw_from.oneOf.0","typeLabel":"object"},{"type":"object","description":"Where to withdraw from, passed through exactly as returned in `withdraw_from` by `POST /payments/issues` or `POST /payments/balances`.","required":["withdraw_type","rdw_address"],"properties":{"withdraw_type":{"type":"string","enum":["EXTRA_RDW_BALANCE"],"isRequired":true,"uniqueKey":"oneOf.1.withdraw_from.oneOf.1.withdraw_type","typeLabel":"enum\u003cstring>"},"rdw_address":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.withdraw_from.oneOf.1.rdw_address","typeLabel":"string"}},"uniqueKey":"oneOf.1.withdraw_from.oneOf.1","typeLabel":"object"},{"type":"null","description":"Where to withdraw from, passed through exactly as returned in `withdraw_from` by `POST /payments/issues` or `POST /payments/balances`.","uniqueKey":"oneOf.1.withdraw_from.oneOf.2","typeLabel":"null"}],"uniqueKey":"oneOf.1.withdraw_from","typeLabel":"object · object · null"},"withdraw_account":{"type":"string","enum":["INTENT","SPW","RDW"],"deprecated":true,"description":"Type of account to withdraw from.","uniqueKey":"oneOf.1.withdraw_account","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"example":{"withdraw_from":{"withdraw_type":"PAYMENT","payment_id":"41b16a6f-704e-44ba-9964-2b66df8a73e8","withdraw_account":"SPW"},"token_amounts":[{"token":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","amount":"25.5"}],"recipient_address":"0xabc1234567890abcdef1234567890abcdef1234"},"examples":{"Example":{"title":"Example","value":{"withdraw_from":{"withdraw_type":"PAYMENT","payment_id":"41b16a6f-704e-44ba-9964-2b66df8a73e8","withdraw_account":"SPW"},"token_amounts":[{"token":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","amount":"25.5"}],"recipient_address":"0xabc1234567890abcdef1234567890abcdef1234"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"0813b700-dd4e-4f7c-b82b-6585444111ef":{"description":"Withdrawal initiated successfully","content":{"application/json":{"schema":{"type":"object","required":["signature_type","withdraw_id","withdraw_authorization","state_token"],"properties":{"signature_type":{"type":"string","enum":["EIP712","EIP191"],"description":"Signature type required for the withdrawal authorization.","isRequired":true,"uniqueKey":"signature_type","typeLabel":"enum\u003cstring>"},"withdraw_id":{"type":"string","format":"uuid","description":"ID of the withdrawal. Use it with `GET /payments/withdraw/status` to poll for completion.","isRequired":true,"uniqueKey":"withdraw_id","typeLabel":"string\u003cuuid>"},"withdraw_authorization":{"type":"string","description":"Authorization data to sign. For EIP712, this is a JSON string to parse and pass to signTypedData. For EIP191, pass this string directly to signMessage.\n","isRequired":true,"uniqueKey":"withdraw_authorization","typeLabel":"string"},"state_token":{"type":"string","description":"Opaque state token to pass back when confirming the withdrawal.","isRequired":true,"uniqueKey":"state_token","typeLabel":"string"},"payment_id":{"type":"string","description":"ID of the payment the withdrawal belongs to.","uniqueKey":"payment_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"signature_type":"EIP712","withdraw_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","withdraw_authorization":"\u003cstring>","state_token":"\u003cstring>","payment_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3ed33ddd-3c37-43f0-9771-e980b81e7bfc":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"oneOf":[{"type":"object","required":["kind","asset","given","limits","source","message","reason"],"properties":{"kind":{"type":"string","enum":["amount"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.kind","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Identifier in the token format (\"chain:address\") or fiat currency code (\"USD\")","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.asset","typeLabel":"string"},"given":{"type":"string","description":"A decimal amount string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.given","typeLabel":"string"},"limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.max","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.limits","typeLabel":"object"},"source":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.source","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.message","typeLabel":"string"},"reason":{"type":"string","enum":["TOO_LOW","TOO_HIGH","UNEXPECTEDLY_LOW","UNEXPECTEDLY_HIGH","NO_VALID_AMOUNT","UNKNOWN"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.reason","typeLabel":"enum\u003cstring>"},"downstream_limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.max","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["kind","token","balance"],"properties":{"kind":{"type":"string","enum":["funding"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Balance amount as a decimal string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance.#","typeLabel":"string"}},"description":"Current token balance at the funding address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["kind","message","mitigation"],"properties":{"kind":{"type":"string","enum":["owner"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.message","typeLabel":"string"},"mitigation":{"type":"string","enum":["change","verify"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.mitigation","typeLabel":"enum\u003cstring>"}},"uniqueKey":"errors.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["geolocation"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["provider"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payin_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["other"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["unknown"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["org_configuration"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.message","typeLabel":"string"},"rev_share_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.rev_share_pct","typeLabel":"string"},"total_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.total_pct","typeLabel":"string"},"threshold":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.threshold","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","description":"Funds are held at a deposit address associated with the owner and are not being processed.","required":["kind","token","balance","classification","severity","payment_gist","withdraw_from"],"properties":{"kind":{"type":"string","enum":["parked_fund"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Integer amount in the token's smallest unit, serialized as a string.","example":"25500000","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance.#","typeLabel":"string"}},"description":"Token balance parked at the address, as an integer in the token's smallest unit. The `{\"#\": \"...\"}`\nwrapper is how the API serializes integers too large for a JSON number. Divide by the token's\n`decimals` from `GET /assets` to display it, for example `{\"#\": \"25500000\"}` is 25.5 USDC.\nNote that `POST /payments/balances` reports the same funds as a plain decimal string (`\"25.5\"`).\n","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance","typeLabel":"object"},"classification":{"type":"string","enum":["MISSENT","STUCK","UNDERFUNDED","STALLED","EXTRA","SLIPPED","DELAYED"],"description":"Why the funds are parked.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.classification","typeLabel":"enum\u003cstring>"},"severity":{"type":"string","enum":["HIGH","LOW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.severity","typeLabel":"enum\u003cstring>"},"payment_gist":{"oneOf":[{"type":"object","description":"Summary of the payment the funds were intended for, or null.","required":["op","destination_address","destination_token"],"properties":{"op":{"type":"string","enum":["buy"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.op","typeLabel":"enum\u003cstring>"},"destination_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_address","typeLabel":"string"},"destination_token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_token","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0","typeLabel":"object"},{"type":"null","description":"Summary of the payment the funds were intended for, or null.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist","typeLabel":"object | null"},"withdraw_from":{"oneOf":[{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","payment_id","withdraw_account"],"properties":{"withdraw_type":{"type":"string","enum":["PAYMENT"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_type","typeLabel":"enum\u003cstring>"},"payment_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.payment_id","typeLabel":"string\u003cuuid>"},"withdraw_account":{"type":"string","enum":["INTENT","SPW","RDW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_account","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0","typeLabel":"object"},{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","rdw_address"],"properties":{"withdraw_type":{"type":"string","enum":["EXTRA_RDW_BALANCE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.withdraw_type","typeLabel":"enum\u003cstring>"},"rdw_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.rdw_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1","typeLabel":"object"},{"type":"null","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from","typeLabel":"object · object · null"}},"uniqueKey":"errors.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["destination"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.10","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payout_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.11","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["kyc"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.message","typeLabel":"string"},"provider_id":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.12.provider_id","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.12","typeLabel":"object"}],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"description":"Error response for known errors","uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"kind":"other","message":"Missing field 'token_amounts'."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"kind":"other","message":"Missing field 'token_amounts'."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"0d274cca-46c4-4f46-9248-12d15a485ec9":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"oneOf":[{"type":"object","required":["kind","asset","given","limits","source","message","reason"],"properties":{"kind":{"type":"string","enum":["amount"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.kind","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Identifier in the token format (\"chain:address\") or fiat currency code (\"USD\")","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.asset","typeLabel":"string"},"given":{"type":"string","description":"A decimal amount string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.given","typeLabel":"string"},"limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.max","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.limits","typeLabel":"object"},"source":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.source","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.message","typeLabel":"string"},"reason":{"type":"string","enum":["TOO_LOW","TOO_HIGH","UNEXPECTEDLY_LOW","UNEXPECTEDLY_HIGH","NO_VALID_AMOUNT","UNKNOWN"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.reason","typeLabel":"enum\u003cstring>"},"downstream_limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.max","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["kind","token","balance"],"properties":{"kind":{"type":"string","enum":["funding"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Balance amount as a decimal string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance.#","typeLabel":"string"}},"description":"Current token balance at the funding address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["kind","message","mitigation"],"properties":{"kind":{"type":"string","enum":["owner"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.message","typeLabel":"string"},"mitigation":{"type":"string","enum":["change","verify"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.mitigation","typeLabel":"enum\u003cstring>"}},"uniqueKey":"errors.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["geolocation"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["provider"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payin_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["other"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["unknown"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["org_configuration"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.message","typeLabel":"string"},"rev_share_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.rev_share_pct","typeLabel":"string"},"total_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.total_pct","typeLabel":"string"},"threshold":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.threshold","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","description":"Funds are held at a deposit address associated with the owner and are not being processed.","required":["kind","token","balance","classification","severity","payment_gist","withdraw_from"],"properties":{"kind":{"type":"string","enum":["parked_fund"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Integer amount in the token's smallest unit, serialized as a string.","example":"25500000","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance.#","typeLabel":"string"}},"description":"Token balance parked at the address, as an integer in the token's smallest unit. The `{\"#\": \"...\"}`\nwrapper is how the API serializes integers too large for a JSON number. Divide by the token's\n`decimals` from `GET /assets` to display it, for example `{\"#\": \"25500000\"}` is 25.5 USDC.\nNote that `POST /payments/balances` reports the same funds as a plain decimal string (`\"25.5\"`).\n","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance","typeLabel":"object"},"classification":{"type":"string","enum":["MISSENT","STUCK","UNDERFUNDED","STALLED","EXTRA","SLIPPED","DELAYED"],"description":"Why the funds are parked.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.classification","typeLabel":"enum\u003cstring>"},"severity":{"type":"string","enum":["HIGH","LOW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.severity","typeLabel":"enum\u003cstring>"},"payment_gist":{"oneOf":[{"type":"object","description":"Summary of the payment the funds were intended for, or null.","required":["op","destination_address","destination_token"],"properties":{"op":{"type":"string","enum":["buy"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.op","typeLabel":"enum\u003cstring>"},"destination_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_address","typeLabel":"string"},"destination_token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_token","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0","typeLabel":"object"},{"type":"null","description":"Summary of the payment the funds were intended for, or null.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist","typeLabel":"object | null"},"withdraw_from":{"oneOf":[{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","payment_id","withdraw_account"],"properties":{"withdraw_type":{"type":"string","enum":["PAYMENT"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_type","typeLabel":"enum\u003cstring>"},"payment_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.payment_id","typeLabel":"string\u003cuuid>"},"withdraw_account":{"type":"string","enum":["INTENT","SPW","RDW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_account","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0","typeLabel":"object"},{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","rdw_address"],"properties":{"withdraw_type":{"type":"string","enum":["EXTRA_RDW_BALANCE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.withdraw_type","typeLabel":"enum\u003cstring>"},"rdw_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.rdw_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1","typeLabel":"object"},{"type":"null","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from","typeLabel":"object · object · null"}},"uniqueKey":"errors.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["destination"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.10","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payout_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.11","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["kyc"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.message","typeLabel":"string"},"provider_id":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.12.provider_id","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.12","typeLabel":"object"}],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"description":"Error response for known errors","uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"kind":"other","message":"Invalid or missing API key"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"kind":"other","message":"Invalid or missing API key"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"a84bd603-90fe-4dfb-a3e1-e53dba6d1b85":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"oneOf":[{"type":"object","required":["kind","asset","given","limits","source","message","reason"],"properties":{"kind":{"type":"string","enum":["amount"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.kind","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Identifier in the token format (\"chain:address\") or fiat currency code (\"USD\")","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.asset","typeLabel":"string"},"given":{"type":"string","description":"A decimal amount string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.given","typeLabel":"string"},"limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.max","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.limits","typeLabel":"object"},"source":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.source","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.message","typeLabel":"string"},"reason":{"type":"string","enum":["TOO_LOW","TOO_HIGH","UNEXPECTEDLY_LOW","UNEXPECTEDLY_HIGH","NO_VALID_AMOUNT","UNKNOWN"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.reason","typeLabel":"enum\u003cstring>"},"downstream_limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.max","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["kind","token","balance"],"properties":{"kind":{"type":"string","enum":["funding"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Balance amount as a decimal string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance.#","typeLabel":"string"}},"description":"Current token balance at the funding address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["kind","message","mitigation"],"properties":{"kind":{"type":"string","enum":["owner"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.message","typeLabel":"string"},"mitigation":{"type":"string","enum":["change","verify"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.mitigation","typeLabel":"enum\u003cstring>"}},"uniqueKey":"errors.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["geolocation"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["provider"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payin_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["other"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["unknown"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["org_configuration"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.message","typeLabel":"string"},"rev_share_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.rev_share_pct","typeLabel":"string"},"total_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.total_pct","typeLabel":"string"},"threshold":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.threshold","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","description":"Funds are held at a deposit address associated with the owner and are not being processed.","required":["kind","token","balance","classification","severity","payment_gist","withdraw_from"],"properties":{"kind":{"type":"string","enum":["parked_fund"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Integer amount in the token's smallest unit, serialized as a string.","example":"25500000","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance.#","typeLabel":"string"}},"description":"Token balance parked at the address, as an integer in the token's smallest unit. The `{\"#\": \"...\"}`\nwrapper is how the API serializes integers too large for a JSON number. Divide by the token's\n`decimals` from `GET /assets` to display it, for example `{\"#\": \"25500000\"}` is 25.5 USDC.\nNote that `POST /payments/balances` reports the same funds as a plain decimal string (`\"25.5\"`).\n","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance","typeLabel":"object"},"classification":{"type":"string","enum":["MISSENT","STUCK","UNDERFUNDED","STALLED","EXTRA","SLIPPED","DELAYED"],"description":"Why the funds are parked.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.classification","typeLabel":"enum\u003cstring>"},"severity":{"type":"string","enum":["HIGH","LOW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.severity","typeLabel":"enum\u003cstring>"},"payment_gist":{"oneOf":[{"type":"object","description":"Summary of the payment the funds were intended for, or null.","required":["op","destination_address","destination_token"],"properties":{"op":{"type":"string","enum":["buy"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.op","typeLabel":"enum\u003cstring>"},"destination_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_address","typeLabel":"string"},"destination_token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_token","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0","typeLabel":"object"},{"type":"null","description":"Summary of the payment the funds were intended for, or null.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist","typeLabel":"object | null"},"withdraw_from":{"oneOf":[{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","payment_id","withdraw_account"],"properties":{"withdraw_type":{"type":"string","enum":["PAYMENT"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_type","typeLabel":"enum\u003cstring>"},"payment_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.payment_id","typeLabel":"string\u003cuuid>"},"withdraw_account":{"type":"string","enum":["INTENT","SPW","RDW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_account","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0","typeLabel":"object"},{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","rdw_address"],"properties":{"withdraw_type":{"type":"string","enum":["EXTRA_RDW_BALANCE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.withdraw_type","typeLabel":"enum\u003cstring>"},"rdw_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.rdw_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1","typeLabel":"object"},{"type":"null","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from","typeLabel":"object · object · null"}},"uniqueKey":"errors.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["destination"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.10","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payout_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.11","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["kyc"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.message","typeLabel":"string"},"provider_id":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.12.provider_id","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.12","typeLabel":"object"}],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"description":"Error response for known errors","uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"kind":"other","message":"You are not authorized to withdraw funds from this payment"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"kind":"other","message":"You are not authorized to withdraw funds from this payment"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"09f42f8f-fb10-47d1-8ba7-c0d0982eb165":{"description":"Payment not found","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"oneOf":[{"type":"object","required":["kind","asset","given","limits","source","message","reason"],"properties":{"kind":{"type":"string","enum":["amount"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.kind","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Identifier in the token format (\"chain:address\") or fiat currency code (\"USD\")","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.asset","typeLabel":"string"},"given":{"type":"string","description":"A decimal amount string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.given","typeLabel":"string"},"limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.max","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.limits","typeLabel":"object"},"source":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.source","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.message","typeLabel":"string"},"reason":{"type":"string","enum":["TOO_LOW","TOO_HIGH","UNEXPECTEDLY_LOW","UNEXPECTEDLY_HIGH","NO_VALID_AMOUNT","UNKNOWN"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.reason","typeLabel":"enum\u003cstring>"},"downstream_limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.max","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["kind","token","balance"],"properties":{"kind":{"type":"string","enum":["funding"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Balance amount as a decimal string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance.#","typeLabel":"string"}},"description":"Current token balance at the funding address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["kind","message","mitigation"],"properties":{"kind":{"type":"string","enum":["owner"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.message","typeLabel":"string"},"mitigation":{"type":"string","enum":["change","verify"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.mitigation","typeLabel":"enum\u003cstring>"}},"uniqueKey":"errors.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["geolocation"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["provider"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payin_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["other"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["unknown"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["org_configuration"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.message","typeLabel":"string"},"rev_share_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.rev_share_pct","typeLabel":"string"},"total_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.total_pct","typeLabel":"string"},"threshold":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.threshold","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","description":"Funds are held at a deposit address associated with the owner and are not being processed.","required":["kind","token","balance","classification","severity","payment_gist","withdraw_from"],"properties":{"kind":{"type":"string","enum":["parked_fund"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Integer amount in the token's smallest unit, serialized as a string.","example":"25500000","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance.#","typeLabel":"string"}},"description":"Token balance parked at the address, as an integer in the token's smallest unit. The `{\"#\": \"...\"}`\nwrapper is how the API serializes integers too large for a JSON number. Divide by the token's\n`decimals` from `GET /assets` to display it, for example `{\"#\": \"25500000\"}` is 25.5 USDC.\nNote that `POST /payments/balances` reports the same funds as a plain decimal string (`\"25.5\"`).\n","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance","typeLabel":"object"},"classification":{"type":"string","enum":["MISSENT","STUCK","UNDERFUNDED","STALLED","EXTRA","SLIPPED","DELAYED"],"description":"Why the funds are parked.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.classification","typeLabel":"enum\u003cstring>"},"severity":{"type":"string","enum":["HIGH","LOW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.severity","typeLabel":"enum\u003cstring>"},"payment_gist":{"oneOf":[{"type":"object","description":"Summary of the payment the funds were intended for, or null.","required":["op","destination_address","destination_token"],"properties":{"op":{"type":"string","enum":["buy"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.op","typeLabel":"enum\u003cstring>"},"destination_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_address","typeLabel":"string"},"destination_token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_token","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0","typeLabel":"object"},{"type":"null","description":"Summary of the payment the funds were intended for, or null.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist","typeLabel":"object | null"},"withdraw_from":{"oneOf":[{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","payment_id","withdraw_account"],"properties":{"withdraw_type":{"type":"string","enum":["PAYMENT"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_type","typeLabel":"enum\u003cstring>"},"payment_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.payment_id","typeLabel":"string\u003cuuid>"},"withdraw_account":{"type":"string","enum":["INTENT","SPW","RDW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_account","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0","typeLabel":"object"},{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","rdw_address"],"properties":{"withdraw_type":{"type":"string","enum":["EXTRA_RDW_BALANCE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.withdraw_type","typeLabel":"enum\u003cstring>"},"rdw_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.rdw_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1","typeLabel":"object"},{"type":"null","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from","typeLabel":"object · object · null"}},"uniqueKey":"errors.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["destination"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.10","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payout_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.11","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["kyc"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.message","typeLabel":"string"},"provider_id":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.12.provider_id","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.12","typeLabel":"object"}],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"description":"Error response for known errors","uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"kind":"other","message":"Payment 'pay_def456' not found"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"kind":"other","message":"Payment 'pay_def456' not found"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"05a97edf-e9d6-4de7-bdbe-ae97d91998f6":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"API_KEY","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"b724eecd-a4ed-42fa-9a0c-8ff6407a392e":{"url":"https://v2.prod.halliday.xyz","description":"Base domain"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API_KEY","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"public/openapi.yaml"},"subdomain":"halliday","siteName":"Halliday","title":"Return funds to owner or retry payment - Halliday","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T20:58:42.639Z","originalFileLocation":"api-reference/payments/return-funds-to-owner-or-retry-payment.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=\"Request a withdrawal to return funds back to the owner or to a requoted processing address. This endpoint should be used when a payment cannot be completed and funds need to be returned.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Halliday\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Return funds to owner or retry payment - Halliday\">\u003cmeta data-mint-head property=\"og:description\" content=\"Request a withdrawal to return funds back to the owner or to a requoted processing address. This endpoint should be used when a payment cannot be completed and funds need to be returned.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Halliday\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.halliday.xyz/api-reference/payments/return-funds-to-owner-or-retry-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://halliday.mintlify.site/_mintlify/api/og/v2?division=Payments\u0026amp;title=Return+funds+to+owner+or+retry+payment\u0026amp;description=Request+a+withdrawal+to+return+funds+back+to+the+owner+or+to+a+requoted+processing+address.%0AThis+endpoint+should+be+used+when+a+payment+cannot+be+completed+and+\u0026amp;theme=e9b080815c8cb7f41ee5a38d\u0026amp;signature=7c676dbb5305f2c19dd2760dfab8cd7c46607578caf8e55d8e252164271264b2\">\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=\"Return funds to owner or retry payment - Halliday\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Request a withdrawal to return funds back to the owner or to a requoted processing address. This endpoint should be used when a payment cannot be completed and funds need to be returned.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://halliday.mintlify.site/_mintlify/api/og/v2?division=Payments\u0026amp;title=Return+funds+to+owner+or+retry+payment\u0026amp;description=Request+a+withdrawal+to+return+funds+back+to+the+owner+or+to+a+requoted+processing+address.%0AThis+endpoint+should+be+used+when+a+payment+cannot+be+completed+and+\u0026amp;theme=e9b080815c8cb7f41ee5a38d\u0026amp;signature=7c676dbb5305f2c19dd2760dfab8cd7c46607578caf8e55d8e252164271264b2\">\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/halliday/_TQmu18IvjSU-Uvs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Halliday\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#DDA2FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.halliday.xyz/api-reference/payments/return-funds-to-owner-or-retry-payment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payments/return-funds-to-owner-or-retry-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.halliday.xyz/#organization\",\"name\":\"Halliday\",\"url\":\"https://docs.halliday.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/halliday/hq55KYeh-6LQtBNf/public/img/HallidayLogo_Color.png?fit=max\u0026auto=format\u0026n=hq55KYeh-6LQtBNf\u0026q=85\u0026s=486868ed309a361db91db1034289ee57\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.halliday.xyz#website\",\"name\":\"Halliday\",\"url\":\"https://docs.halliday.xyz\",\"publisher\":{\"@id\":\"https://docs.halliday.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.halliday.xyz/api-reference/payments/return-funds-to-owner-or-retry-payment#webpage\",\"url\":\"https://docs.halliday.xyz/api-reference/payments/return-funds-to-owner-or-retry-payment\",\"name\":\"Return funds to owner or retry payment\",\"description\":\"Request a withdrawal to return funds back to the owner or to a requoted processing address. This endpoint should be used when a payment cannot be completed and funds need to be returned.\",\"dateModified\":\"2026-10-22T20:58:42.639Z\",\"isPartOf\":{\"@id\":\"https://docs.halliday.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.halliday.xyz/api-reference/payments/return-funds-to-owner-or-retry-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.halliday.xyz/api-reference/payments/return-funds-to-owner-or-retry-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments\",\"item\":\"https://docs.halliday.xyz/api-reference/payments/get-payment-status\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Return funds to owner or retry payment\",\"item\":\"https://docs.halliday.xyz/api-reference/payments/return-funds-to-owner-or-retry-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.halliday.xyz/api-reference/payments/return-funds-to-owner-or-retry-payment#apireference\",\"headline\":\"Return funds to owner or retry payment\",\"name\":\"Return funds to owner or retry payment\",\"description\":\"Request a withdrawal to return funds back to the owner or to a requoted processing address. This endpoint should be used when a payment cannot be completed and funds need to be returned.\",\"url\":\"https://docs.halliday.xyz/api-reference/payments/return-funds-to-owner-or-retry-payment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.halliday.xyz/api-reference/payments/return-funds-to-owner-or-retry-payment#webpage\"},\"dateModified\":\"2026-10-22T20:58:42.639Z\",\"publisher\":{\"@id\":\"https://docs.halliday.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.halliday.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Halliday\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Halliday","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://blog.halliday.xyz/"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/pages/home"}]},{"tab":"API Reference","groups":[{"group":"Chains","pages":[{"title":"Get supported chains","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /chains","href":"/api-reference/chains/get-supported-chains"}]},{"group":"Assets","pages":[{"title":"Get asset details","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /assets","href":"/api-reference/assets/get-asset-details"},{"title":"Get available input assets for a given output asset","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /assets/available-inputs","href":"/api-reference/assets/get-available-input-assets-for-a-given-output-asset"},{"title":"Get available output assets for a given input asset","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /assets/available-outputs","href":"/api-reference/assets/get-available-output-assets-for-a-given-input-asset"}]},{"group":"Geolocation","pages":[{"title":"Get geolocation for an IP address","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /geolocation","href":"/api-reference/geolocation/get-geolocation-for-an-ip-address"}]},{"group":"Prices","pages":[{"title":"Get token prices","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /prices","href":"/api-reference/prices/get-token-prices"}]},{"group":"Payments","pages":[{"title":"Get payment status","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /payments","href":"/api-reference/payments/get-payment-status"},{"title":"Get payment history","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /payments/history","href":"/api-reference/payments/get-payment-history"},{"title":"Get available payment methods","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /payments/methods","href":"/api-reference/payments/get-available-payment-methods"},{"title":"Get payment quotes","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/quotes","href":"/api-reference/payments/get-payment-quotes"},{"title":"Confirm a payment","description":"Confirm a previously quoted payment and receive deposit instructions.\nReturns information on how to fund the payment (widget URL, contract address, etc.).\n\nIf a payment output is >= $300 USD, the owner address will need to produce a EVM_OWNER\nsignature. The response will include a USER_VERIFY next_instruction instead of funding\ndetails. In this case, prompt the user to sign the verification payloads via signTypedData,\nthen submit a ContinueConfirmPaymentRequest to this same endpoint to complete confirmation.\nOnce an owner address has produced an EVM_OWNER signature, subsequent payments with that\nowner address will not require the signature again.\n","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/confirm","href":"/api-reference/payments/confirm-a-payment"},{"title":"Return funds to owner or retry payment","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/withdraw","href":"/api-reference/payments/return-funds-to-owner-or-retry-payment"},{"title":"Confirm withdrawal request","description":"Submit and execute the signed withdrawal request to return funds back to the owner or to a requoted processing address.\n","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/withdraw/confirm","href":"/api-reference/payments/confirm-withdrawal-request"},{"title":"Get withdrawal status","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /payments/withdraw/status","href":"/api-reference/payments/get-withdrawal-status"},{"title":"Get wallet balances","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/balances","href":"/api-reference/payments/get-wallet-balances"},{"title":"Get issues for an owner address","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/issues","href":"/api-reference/payments/get-issues-for-an-owner-address"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /orgs/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Register a webhook","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /orgs/webhooks","href":"/api-reference/webhooks/register-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/public/openapi.yaml delete /orgs/webhooks","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/public/openapi.yaml patch /orgs/webhooks","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /orgs/webhooks/rotate-secret","href":"/api-reference/webhooks/rotate-the-signing-secret"},{"title":"Workflow status changed","version":null,"deprecated":null,"openapi":"/public/openapi.yaml webhook workflowStatusChanged","href":"/api-reference/webhooks/workflow-status-changed"}]}]}]},"basePath":"","title":"Return funds to owner or retry payment - Halliday","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}