{
"type": "INTERNAL_SERVER_ERROR",
"message": "An internal server error occurred"
}
{"docsConfig":{"theme":"almond","$schema":"https://hifi.com/docs.json","name":"HIFI Docs","description":"Developer Documentation for HIFI","colors":{"primary":"#222222","light":"#F2FF66","dark":"#222222"},"logo":{"light":"https://mintcdn.com/hifi/VzHynFYCLt9TATAK/logo/light.svg?fit=max\u0026auto=format\u0026n=VzHynFYCLt9TATAK\u0026q=85\u0026s=3b0ca085dfd9860bd27ab9c039b6c2cc","dark":"https://mintcdn.com/hifi/VzHynFYCLt9TATAK/logo/dark.svg?fit=max\u0026auto=format\u0026n=VzHynFYCLt9TATAK\u0026q=85\u0026s=446f537c67643be9fcdc464104047053"},"favicon":"https://mintcdn.com/hifi/VzHynFYCLt9TATAK/favicon.svg?fit=max\u0026auto=format\u0026n=VzHynFYCLt9TATAK\u0026q=85\u0026s=864a854c55ec15e3f66405d20572a370","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.hifi.com"}},"footer":{"socials":{"x":"https://x.com/hifiHQ","github":"https://github.com/Hifi-Bridge","linkedin":"https://www.linkedin.com/company/hifibridge"}},"seo":{"metatags":{"title":"HIFI Docs","description":"Build modern payment workflows and automate money movement.","keywords":"HIFI, payments API, programmable money, payment orchestration, payment workflows, automated flows, composable payments, workflow builder, payment automation, orchestration layer, flow composition, fintech API, stablecoins, USDC, USDT, bank transfers, ACH, SWIFT, RTP, KYC, KYB, compliance, virtual accounts, payouts, webhooks, developer documentation","author":"HIFI","robots":"index,follow,max-snippet:-1,max-image-preview:large,max-video-preview:-1","og:title":"HIFI Docs","og:type":"website","og:url":"https://docs.hifi.com/","og:description":"Build modern payment workflows and automate money movement.","og:site_name":"HIFI Docs","og:locale":"en_US","twitter:card":"summary","twitter:site":"@hifiHQ","twitter:title":"HIFI Docs","twitter:description":"Build modern payment workflows and automate money movement.","theme-color":"#33171E","application-name":"HIFI Docs","apple-mobile-web-app-title":"HIFI Docs"}},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hifi","hasAudioNarration":false,"actualSubdomain":"hifi","customDomains":["docs.hifi.com"],"gitSource":{"type":"github","owner":"hifi-bridge","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5df8bb736e9e018578bf2","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":235},{"language":"default","tag":"Endpoints","count":231},{"language":"default","tag":"Docs","count":132},{"language":"default","tag":"Core concepts","count":60},{"language":"default","tag":"Guides","count":40},{"language":"default","tag":"Compliance","count":34},{"language":"default","tag":"References","count":29},{"language":"default","tag":"Wallets","count":22},{"language":"default","tag":"Migration Guide","count":22},{"language":"default","tag":"Migrate from v2","count":22}]},"assistantConfig":{},"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":"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}],"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:\"Space Mono\";src:url(\"http://app.hifi.com/fonts/rhithmic/SpaceMono-Regular.woff2\")\n format(\"woff2\");font-weight:normal;font-style:normal;font-display:swap}*{box-sizing:border-box}body,html{font-family:-apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, sans-serif}h1,h2,h3,h4,h5,h6{font-family:-apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, sans-serif;font-weight:400!important}code,pre,.code,.code-block,.highlight,.language-*{font-family:\"Space Mono\", \"SF Mono\", \"Monaco\", \"Inconsolata\", \"Roboto Mono\",\n \"Source Code Pro\", monospace;font-weight:400}.dark table th{color:white!important}"}],"page":{"pagePath":"v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account","slug":"/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account","pageMetadata":{"title":"Remove the settlement rule from a virtual account","description":"Detach the settlement rule currently applied to a virtual account.","deprecated":null,"version":null,"sidebarTitle":"Remove the settlement rule from a virtual account","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/virtual-accounts/{virtualAccountId}/settlement-rules","href":"/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account","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: \"Detach the settlement rule currently applied to a virtual account.\"\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":"Remove the settlement rule from a virtual account","description":"Detach the settlement rule currently applied to a virtual account.","deprecated":null,"version":null,"sidebarTitle":"Remove the settlement rule from a virtual account","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/virtual-accounts/{virtualAccountId}/settlement-rules","href":"/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/hifi/5e51763843a3bb92/homepage.js"],"openApiReferenceData":{"operation":{"summary":"Remove the settlement rule from a virtual account","operationId":"v3RemoveVirtualAccountSettlementRule","x-mint":{"href":"/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account"},"description":"Detach the settlement rule currently applied to a virtual account.","tags":["Virtual Account"],"parameters":["76b7cfc9-8c02-4575-a7b8-e7eae31bb5de"],"responses":{"200":"1dc8f47e-31e6-4d5f-b808-e30fcb3035af","401":"a9532978-c01b-477f-b5e9-cac9e401ccab","404":"f7a38850-2f69-49da-9cde-9bc309f5e5e7","500":"0f291ee5-d4c9-4b77-9ce7-4ad278409ea5"},"method":"delete","type":"path","servers":["613b2f7c-74f9-4248-aa31-5afa4db9b655","2f1f57c9-2e67-4f35-b8a0-04d50331e040"],"security":["644f16d5-8798-47fb-a04d-f0ab8bd19e5b"],"path":"/v3/virtual-accounts/{virtualAccountId}/settlement-rules","baseUrlOptions":["https://production.hifi.com","https://sandbox.hifi.com"],"title":"Remove the settlement rule from a virtual account","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"76b7cfc9-8c02-4575-a7b8-e7eae31bb5de":{"name":"virtualAccountId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Public ID of the virtual account (prefixed with `va_`)","uniqueKey":"","typeLabel":"string"},"description":"Public ID of the virtual account (prefixed with `va_`)","example":"va_5Kf9dQ2mNpXwZ7bV1aLcs"}},"responses":{"1dc8f47e-31e6-4d5f-b808-e30fcb3035af":{"description":"Virtual account retrieved successfully.","content":{"application/json":{"schema":{"type":"object","description":"A virtual account.","properties":{"id":{"type":"string","description":"Public ID of the virtual account (prefixed with `va_`).","example":"va_5Kf9dQ2mNpXwZ7bV1aLcs","uniqueKey":"id","typeLabel":"string"},"userId":{"type":"string","description":"Public ID of the user this virtual account belongs to (prefixed with `usr_`).","example":"usr_3Kf9dQ2mNpXwZ7bV1aLcs","uniqueKey":"userId","typeLabel":"string"},"source":{"type":"object","description":"Fiat source configuration of the virtual account.","properties":{"transferTypes":{"type":"array","description":"Fiat transfer rails accepted by this virtual account.","items":{"type":"string","enum":["ACH","WIRE","RTP"],"uniqueKey":"source.transferTypes.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["ACH","WIRE","RTP"],"uniqueKey":"source.transferTypes","typeLabel":"enum\u003cstring>[]"},"currency":{"type":"string","enum":["USD"],"example":"USD","uniqueKey":"source.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"source","typeLabel":"object"},"destination":{"type":"object","description":"Stablecoin destination of the virtual account.","properties":{"chain":{"type":"string","description":"Blockchain the destination stablecoin is delivered on.","enum":["ETHEREUM","POLYGON","SOLANA","BASE","FLOW_EVM","ARBITRUM","BSC","TRON","CANTON","ARC"],"example":"POLYGON","uniqueKey":"destination.chain","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["USDC","USDT","PYUSD","USDG","PYUSD0","USDCX"],"example":"USDC","uniqueKey":"destination.currency","typeLabel":"enum\u003cstring>"},"walletAddress":{"type":"string","description":"On-chain address funds are delivered to.","example":"0x1234567890abcdef1234567890abcdef12345678","uniqueKey":"destination.walletAddress","typeLabel":"string"},"walletId":{"oneOf":[{"type":"string","description":"Public ID of the HIFI custodial wallet, if the destination is a HIFI wallet (prefixed with `wlt_`).","example":"wlt_1aLcs3Kf9dQ2mNpXwZ7bV","uniqueKey":"destination.walletId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Public ID of the HIFI custodial wallet, if the destination is a HIFI wallet (prefixed with `wlt_`).","example":"wlt_1aLcs3Kf9dQ2mNpXwZ7bV","uniqueKey":"destination.walletId.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.walletId","typeLabel":"string | null"},"externalWalletId":{"oneOf":[{"type":"string","description":"Public ID of the external wallet, if the destination is an external wallet (prefixed with `extw_`).","example":null,"uniqueKey":"destination.externalWalletId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Public ID of the external wallet, if the destination is an external wallet (prefixed with `extw_`).","example":null,"uniqueKey":"destination.externalWalletId.oneOf.1","typeLabel":"null"}],"uniqueKey":"destination.externalWalletId","typeLabel":"string | null"}},"uniqueKey":"destination","typeLabel":"object"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"],"example":"ACTIVE","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"microDeposits":{"oneOf":[{"type":"object","description":"Deposits received into the virtual account.","properties":{"count":{"type":"integer","example":0,"uniqueKey":"microDeposits.oneOf.0.count","typeLabel":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","example":"2026-07-01T10:35:00.000Z","uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"currency":{"type":"string","example":"USD","uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].currency","typeLabel":"string"},"amount":{"type":"number","example":100,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].amount","typeLabel":"number"},"sourceBankInfo":{"type":"object","description":"Details of the bank that sent a deposit.","properties":{"bankName":{"type":"string","example":"Example Bank","uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.bankName","typeLabel":"string"},"senderName":{"type":"string","example":"Jane Doe","uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.senderName","typeLabel":"string"},"routingNumber":{"type":"string","example":"021000021","uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.routingNumber","typeLabel":"string"},"accountNumber":{"type":"string","example":"123456789","uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.accountNumber","typeLabel":"string"},"accountType":{"type":"string","example":"CHECKING","uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.accountType","typeLabel":"string"},"fedBatchId":{"oneOf":[{"type":"string","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.fedBatchId.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.fedBatchId.oneOf.1","typeLabel":"null"}],"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.fedBatchId","typeLabel":"string | null"},"imad":{"oneOf":[{"type":"string","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.imad.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.imad.oneOf.1","typeLabel":"null"}],"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.imad","typeLabel":"string | null"},"omad":{"oneOf":[{"type":"string","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.omad.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.omad.oneOf.1","typeLabel":"null"}],"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.omad","typeLabel":"string | null"},"traceNumber":{"oneOf":[{"type":"string","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.traceNumber.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.traceNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.traceNumber","typeLabel":"string | null"},"bankAddress":{"oneOf":[{"type":"string","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.bankAddress.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.bankAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.bankAddress","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.description.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.description","typeLabel":"string | null"},"references":{"oneOf":[{"type":"object","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.references.oneOf.0","typeLabel":"object"},{"type":"null","example":null,"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.references.oneOf.1","typeLabel":"null"}],"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.references","typeLabel":"object | null"},"paymentRail":{"type":"string","example":"ach","uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo.paymentRail","typeLabel":"string"}},"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX].sourceBankInfo","typeLabel":"object"}},"uniqueKey":"microDeposits.oneOf.0.data.items.[INDEX]","typeLabel":"object"},"example":[],"uniqueKey":"microDeposits.oneOf.0.data","typeLabel":"object[]"}},"uniqueKey":"microDeposits.oneOf.0","typeLabel":"object"},{"type":"null","description":"Deposits received into the virtual account.","properties":{"count":{"type":"integer","example":0},"data":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","example":"2026-07-01T10:35:00.000Z"},"currency":{"type":"string","example":"USD"},"amount":{"type":"number","example":100},"sourceBankInfo":{"type":"object","description":"Details of the bank that sent a deposit.","properties":{"bankName":{"type":"string","example":"Example Bank"},"senderName":{"type":"string","example":"Jane Doe"},"routingNumber":{"type":"string","example":"021000021"},"accountNumber":{"type":"string","example":"123456789"},"accountType":{"type":"string","example":"CHECKING"},"fedBatchId":{"oneOf":[{"type":"string","example":null},{"type":"null","example":null}]},"imad":{"oneOf":[{"type":"string","example":null},{"type":"null","example":null}]},"omad":{"oneOf":[{"type":"string","example":null},{"type":"null","example":null}]},"traceNumber":{"oneOf":[{"type":"string","example":null},{"type":"null","example":null}]},"bankAddress":{"oneOf":[{"type":"string","example":null},{"type":"null","example":null}]},"description":{"oneOf":[{"type":"string","example":null},{"type":"null","example":null}]},"references":{"oneOf":[{"type":"object","example":null},{"type":"null","example":null}]},"paymentRail":{"type":"string","example":"ach"}}}}},"example":[]}},"uniqueKey":"microDeposits.oneOf.1","typeLabel":"null"}],"uniqueKey":"microDeposits","typeLabel":"object | null"},"depositInstructions":{"oneOf":[{"type":"object","description":"Bank details for funding the virtual account. Null until the account is\nactive.\n","properties":{"bankName":{"type":"string","example":"Example Bank","uniqueKey":"depositInstructions.oneOf.0.bankName","typeLabel":"string"},"bankAddress":{"type":"string","example":"123 Main Street, New York, NY 10001","uniqueKey":"depositInstructions.oneOf.0.bankAddress","typeLabel":"string"},"beneficiary":{"type":"object","properties":{"name":{"type":"string","example":"ACME Corp","uniqueKey":"depositInstructions.oneOf.0.beneficiary.name","typeLabel":"string"},"address":{"type":"string","example":"123 Main Street, New York, NY 10001, USA","uniqueKey":"depositInstructions.oneOf.0.beneficiary.address","typeLabel":"string"}},"uniqueKey":"depositInstructions.oneOf.0.beneficiary","typeLabel":"object"},"ach":{"type":"object","properties":{"routingNumber":{"type":"string","example":"021000021","uniqueKey":"depositInstructions.oneOf.0.ach.routingNumber","typeLabel":"string"},"accountNumber":{"type":"string","example":"123456789012","uniqueKey":"depositInstructions.oneOf.0.ach.accountNumber","typeLabel":"string"}},"uniqueKey":"depositInstructions.oneOf.0.ach","typeLabel":"object"},"wire":{"type":"object","properties":{"routingNumber":{"type":"string","example":"021000021","uniqueKey":"depositInstructions.oneOf.0.wire.routingNumber","typeLabel":"string"},"accountNumber":{"type":"string","example":"123456789012","uniqueKey":"depositInstructions.oneOf.0.wire.accountNumber","typeLabel":"string"}},"uniqueKey":"depositInstructions.oneOf.0.wire","typeLabel":"object"},"rtp":{"type":"object","properties":{"routingNumber":{"type":"string","example":"021000021","uniqueKey":"depositInstructions.oneOf.0.rtp.routingNumber","typeLabel":"string"},"accountNumber":{"type":"string","example":"123456789012","uniqueKey":"depositInstructions.oneOf.0.rtp.accountNumber","typeLabel":"string"}},"uniqueKey":"depositInstructions.oneOf.0.rtp","typeLabel":"object"},"reference":{"oneOf":[{"type":"string","example":null,"uniqueKey":"depositInstructions.oneOf.0.reference.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"depositInstructions.oneOf.0.reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"depositInstructions.oneOf.0.reference","typeLabel":"string | null"},"depositBy":{"oneOf":[{"type":"string","format":"date-time","example":null,"uniqueKey":"depositInstructions.oneOf.0.depositBy.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":null,"uniqueKey":"depositInstructions.oneOf.0.depositBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"depositInstructions.oneOf.0.depositBy","typeLabel":"string\u003cdate-time> | null"},"instruction":{"type":"string","example":"Please deposit USD to the bank account provided.","uniqueKey":"depositInstructions.oneOf.0.instruction","typeLabel":"string"}},"uniqueKey":"depositInstructions.oneOf.0","typeLabel":"object"},{"type":"null","description":"Bank details for funding the virtual account. Null until the account is\nactive.\n","properties":{"bankName":{"type":"string","example":"Example Bank"},"bankAddress":{"type":"string","example":"123 Main Street, New York, NY 10001"},"beneficiary":{"type":"object","properties":{"name":{"type":"string","example":"ACME Corp"},"address":{"type":"string","example":"123 Main Street, New York, NY 10001, USA"}}},"ach":{"type":"object","properties":{"routingNumber":{"type":"string","example":"021000021"},"accountNumber":{"type":"string","example":"123456789012"}}},"wire":{"type":"object","properties":{"routingNumber":{"type":"string","example":"021000021"},"accountNumber":{"type":"string","example":"123456789012"}}},"rtp":{"type":"object","properties":{"routingNumber":{"type":"string","example":"021000021"},"accountNumber":{"type":"string","example":"123456789012"}}},"reference":{"oneOf":[{"type":"string","example":null},{"type":"null","example":null}]},"depositBy":{"oneOf":[{"type":"string","format":"date-time","example":null},{"type":"null","format":"date-time","example":null}]},"instruction":{"type":"string","example":"Please deposit USD to the bank account provided."}},"uniqueKey":"depositInstructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"depositInstructions","typeLabel":"object | null"},"settlementRuleId":{"oneOf":[{"type":"string","description":"Public ID of the applied settlement rule (prefixed with `sr_`), if any.","example":null,"uniqueKey":"settlementRuleId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Public ID of the applied settlement rule (prefixed with `sr_`), if any.","example":null,"uniqueKey":"settlementRuleId.oneOf.1","typeLabel":"null"}],"uniqueKey":"settlementRuleId","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","example":"2026-07-01T10:30:00.000Z","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","example":"2026-07-01T10:30:00.000Z","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"va_5Kf9dQ2mNpXwZ7bV1aLcs","userId":"usr_3Kf9dQ2mNpXwZ7bV1aLcs","source":{"transferTypes":["ACH","WIRE","RTP"],"currency":"USD"},"destination":{"chain":"POLYGON","currency":"USDC","walletAddress":"0x1234567890abcdef1234567890abcdef12345678","walletId":"wlt_1aLcs3Kf9dQ2mNpXwZ7bV","externalWalletId":null},"status":"ACTIVE","microDeposits":{"count":1,"data":[{"createdAt":"2026-07-01T10:35:00.000Z","currency":"USD","amount":100,"sourceBankInfo":{"bankName":"Example Bank","senderName":"Jane Doe","routingNumber":"021000021","accountNumber":"123456789","accountType":"CHECKING","fedBatchId":null,"imad":null,"omad":null,"traceNumber":null,"bankAddress":null,"description":null,"references":null,"paymentRail":"ach"}}]},"depositInstructions":{"bankName":"Example Bank","bankAddress":"123 Main Street, New York, NY 10001","beneficiary":{"name":"ACME Corp","address":"123 Main Street, New York, NY 10001, USA"},"ach":{"routingNumber":"021000021","accountNumber":"123456789012"},"wire":{"routingNumber":"021000021","accountNumber":"123456789012"},"rtp":{"routingNumber":"021000021","accountNumber":"123456789012"},"reference":null,"depositBy":null,"instruction":"Please deposit USD to the bank account provided."},"settlementRuleId":null,"createdAt":"2026-07-01T10:30:00.000Z","updatedAt":"2026-07-01T10:30:00.000Z"},"examples":{"Example":{"title":"Example","value":{"id":"va_5Kf9dQ2mNpXwZ7bV1aLcs","userId":"usr_3Kf9dQ2mNpXwZ7bV1aLcs","source":{"transferTypes":["ACH","WIRE","RTP"],"currency":"USD"},"destination":{"chain":"POLYGON","currency":"USDC","walletAddress":"0x1234567890abcdef1234567890abcdef12345678","walletId":"wlt_1aLcs3Kf9dQ2mNpXwZ7bV","externalWalletId":null},"status":"ACTIVE","microDeposits":{"count":1,"data":[{"createdAt":"2026-07-01T10:35:00.000Z","currency":"USD","amount":100,"sourceBankInfo":{"bankName":"Example Bank","senderName":"Jane Doe","routingNumber":"021000021","accountNumber":"123456789","accountType":"CHECKING","fedBatchId":null,"imad":null,"omad":null,"traceNumber":null,"bankAddress":null,"description":null,"references":null,"paymentRail":"ach"}}]},"depositInstructions":{"bankName":"Example Bank","bankAddress":"123 Main Street, New York, NY 10001","beneficiary":{"name":"ACME Corp","address":"123 Main Street, New York, NY 10001, USA"},"ach":{"routingNumber":"021000021","accountNumber":"123456789012"},"wire":{"routingNumber":"021000021","accountNumber":"123456789012"},"rtp":{"routingNumber":"021000021","accountNumber":"123456789012"},"reference":null,"depositBy":null,"instruction":"Please deposit USD to the bank account provided."},"settlementRuleId":null,"createdAt":"2026-07-01T10:30:00.000Z","updatedAt":"2026-07-01T10:30:00.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"a9532978-c01b-477f-b5e9-cac9e401ccab":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Unauthorized enum","example":"UNAUTHORIZED","uniqueKey":"type","typeLabel":"string"},"message":{"type":"string","description":"Unauthorized message","example":"Authentication required","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"UNAUTHORIZED","message":"Authentication required"}}},"exampleType":"generated"}},"exampleType":"generated"},"f7a38850-2f69-49da-9cde-9bc309f5e5e7":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","example":"RESOURCE_NOT_FOUND","description":"The error type, e.g., RESOURCE_NOT_FOUND","uniqueKey":"type","typeLabel":"string"},"message":{"type":"string","description":"A descriptive error message","uniqueKey":"message","typeLabel":"string"},"fields":{"type":"array","description":"List of specific field errors","items":{"type":"object","properties":{"code":{"type":"string","description":"Error code related to the field issue","uniqueKey":"fields.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Error message for the specific issue","uniqueKey":"fields.items.[INDEX].message","typeLabel":"string"},"field":{"type":"string","description":"The name of the field that has an issue","uniqueKey":"fields.items.[INDEX].field","typeLabel":"string"}},"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"RESOURCE_NOT_FOUND","message":"\u003cstring>","fields":[{"code":"\u003cstring>","message":"\u003cstring>","field":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"0f291ee5-d4c9-4b77-9ce7-4ad278409ea5":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","example":"INTERNAL_SERVER_ERROR","description":"Internal server error enum","uniqueKey":"type","typeLabel":"string"},"message":{"type":"string","example":"An internal server error occurred","description":"Internal server error message","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"INTERNAL_SERVER_ERROR","message":"An internal server error occurred"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"644f16d5-8798-47fb-a04d-f0ab8bd19e5b":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"613b2f7c-74f9-4248-aa31-5afa4db9b655":{"url":"https://production.hifi.com","description":"Production server"},"2f1f57c9-2e67-4f35-b8a0-04d50331e040":{"url":"https://sandbox.hifi.com","description":"Sandbox server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"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":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://production.hifi.com/api/v3/openapi.json"},"subdomain":"hifi","siteName":"HIFI Docs","title":"HIFI Docs","navMaps":{"firstHrefInVersion":{"v3":{"href":"/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account","matchLevel":0},"v2":{"href":"/","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T14:17:16.703Z","originalFileLocation":"v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account.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=\"Detach the settlement rule currently applied to a virtual account.\">\u003cmeta data-mint-head name=\"keywords\" content=\"HIFI, payments API, programmable money, payment orchestration, payment workflows, automated flows, composable payments, workflow builder, payment automation, orchestration layer, flow composition, fintech API, stablecoins, USDC, USDT, bank transfers, ACH, SWIFT, RTP, KYC, KYB, compliance, virtual accounts, payouts, webhooks, developer documentation\">\u003cmeta data-mint-head name=\"application-name\" content=\"HIFI Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index,follow,max-snippet:-1,max-image-preview:large,max-video-preview:-1\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hifi/4JvTHTX5k6s_9z5n/_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/hifi/4JvTHTX5k6s_9z5n/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hifi/4JvTHTX5k6s_9z5n/_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/hifi/4JvTHTX5k6s_9z5n/_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/hifi/4JvTHTX5k6s_9z5n/_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/hifi/4JvTHTX5k6s_9z5n/_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/hifi/4JvTHTX5k6s_9z5n/_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/hifi/4JvTHTX5k6s_9z5n/_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/hifi/4JvTHTX5k6s_9z5n/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"HIFI Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Build modern payment workflows and automate money movement.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HIFI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hifi.mintlify.site/_mintlify/api/og/v2?division=Settlement+Rules\u0026amp;title=Remove+the+settlement+rule+from+a+virtual+account\u0026amp;description=Detach+the+settlement+rule+currently+applied+to+a+virtual+account.\u0026amp;theme=445d8ece64587b97bc363e93\u0026amp;signature=28e7e3ed58d0ab5010a494aef3c15d14f63be1e1fb4b78ff59b437d2d32c0e91\">\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=\"HIFI Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Build modern payment workflows and automate money movement.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hifi.mintlify.site/_mintlify/api/og/v2?division=Settlement+Rules\u0026amp;title=Remove+the+settlement+rule+from+a+virtual+account\u0026amp;description=Detach+the+settlement+rule+currently+applied+to+a+virtual+account.\u0026amp;theme=445d8ece64587b97bc363e93\u0026amp;signature=28e7e3ed58d0ab5010a494aef3c15d14f63be1e1fb4b78ff59b437d2d32c0e91\">\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/hifi/4JvTHTX5k6s_9z5n/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HIFI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#222222\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"HIFI\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#33171E\">\u003cmeta data-mint-head name=\"application-name\" content=\"HIFI Docs\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hifi.com/#organization\",\"name\":\"HIFI Docs\",\"url\":\"https://docs.hifi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hifi/VzHynFYCLt9TATAK/logo/light.svg?fit=max\u0026auto=format\u0026n=VzHynFYCLt9TATAK\u0026q=85\u0026s=3b0ca085dfd9860bd27ab9c039b6c2cc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hifi.com#website\",\"name\":\"HIFI Docs\",\"url\":\"https://docs.hifi.com\",\"publisher\":{\"@id\":\"https://docs.hifi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account#webpage\",\"url\":\"https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account\",\"name\":\"Remove the settlement rule from a virtual account\",\"description\":\"Detach the settlement rule currently applied to a virtual account.\",\"dateModified\":\"2026-11-09T14:17:16.703Z\",\"isPartOf\":{\"@id\":\"https://docs.hifi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.hifi.com/v3/api-reference/common/ping\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Settlement Rules\",\"item\":\"https://docs.hifi.com/v3/api-reference/virtual-account/create-a-settlement-rule\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Remove the settlement rule from a virtual account\",\"item\":\"https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account#apireference\",\"headline\":\"Remove the settlement rule from a virtual account\",\"name\":\"Remove the settlement rule from a virtual account\",\"description\":\"Detach the settlement rule currently applied to a virtual account.\",\"url\":\"https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hifi.com/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account#webpage\"},\"dateModified\":\"2026-11-09T14:17:16.703Z\",\"publisher\":{\"@id\":\"https://docs.hifi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hifi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HIFI Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"HIFI Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account.md","siteName":"HIFI Docs","nav":{"global":null,"versions":[{"version":"v3","tag":"Beta","tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/v3/docs/introduction/welcome"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/v3/guides/v2v3Migration/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/v3/changelog/changelog"}]},{"tab":"API Reference","pages":[{"group":"Overview","pages":[{"title":"Authentication","href":"/v3/apiReference/authentication"},{"title":"Error Codes","href":"/v3/apiReference/errors"}]},{"group":"Endpoints","pages":[{"group":"Common","pages":[{"title":"Ping","deprecated":null,"version":null,"sidebarTitle":"Ping","openapi":"https://production.hifi.com/api/v3/openapi.json get /ping","href":"/v3/api-reference/common/ping"}]},{"group":"Users","pages":[{"title":"Create a user","deprecated":null,"version":null,"sidebarTitle":"Create a user","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/users","href":"/v3/api-reference/user/create-a-user"},{"title":"Retrieve a user","deprecated":null,"version":null,"sidebarTitle":"Retrieve a user","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/users/{userId}","href":"/v3/api-reference/user/retrieve-a-user"},{"title":"List users","deprecated":null,"version":null,"sidebarTitle":"List users","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/users","href":"/v3/api-reference/user/list-users"},{"title":"Generate a terms of service link","deprecated":null,"version":null,"sidebarTitle":"Generate a terms of service link","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/tos-link","href":"/v3/api-reference/user/generate-a-terms-of-service-link"},{"title":"Retrieve a terms of service link","deprecated":null,"version":null,"sidebarTitle":"Retrieve a terms of service link","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/tos-link/{signedAgreementId}","href":"/v3/api-reference/user/retrieve-a-terms-of-service-link"},{"title":"Accept a whitelisted terms of service link","deprecated":null,"version":null,"sidebarTitle":"Accept a whitelisted terms of service link","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/tos-link/{signedAgreementId}/accept","href":"/v3/api-reference/user/accept-a-whitelisted-terms-of-service-link"}]},{"group":"Compliance","pages":[{"title":"Retrieve the compliance profile","deprecated":null,"version":null,"sidebarTitle":"Retrieve the compliance profile","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/users/{userId}/compliance/profile","href":"/v3/api-reference/compliance/retrieve-the-compliance-profile"},{"title":"Update the compliance profile","deprecated":null,"version":null,"sidebarTitle":"Update the compliance profile","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/users/{userId}/compliance/profile","href":"/v3/api-reference/compliance/update-the-compliance-profile"},{"title":"Retrieve the compliance questionnaire","deprecated":null,"version":null,"sidebarTitle":"Retrieve the compliance questionnaire","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/users/{userId}/compliance/questionnaire","href":"/v3/api-reference/compliance/retrieve-the-compliance-questionnaire"},{"title":"Update the compliance questionnaire","deprecated":null,"version":null,"sidebarTitle":"Update the compliance questionnaire","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/users/{userId}/compliance/questionnaire","href":"/v3/api-reference/compliance/update-the-compliance-questionnaire"},{"title":"Add an associated party","deprecated":null,"version":null,"sidebarTitle":"Add an associated party","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/compliance/associated-parties","href":"/v3/api-reference/compliance/add-an-associated-party"},{"title":"Update an associated party","deprecated":null,"version":null,"sidebarTitle":"Update an associated party","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/compliance/associated-parties/{associatedPartyId}","href":"/v3/api-reference/compliance/update-an-associated-party"},{"title":"Delete an associated party","deprecated":null,"version":null,"sidebarTitle":"Delete an associated party","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/compliance/associated-parties/{associatedPartyId}","href":"/v3/api-reference/compliance/delete-an-associated-party"},{"title":"Retrieve an associated party","deprecated":null,"version":null,"sidebarTitle":"Retrieve an associated party","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/compliance/associated-parties/{associatedPartyId}","href":"/v3/api-reference/compliance/retrieve-an-associated-party"},{"title":"List associated parties","deprecated":null,"version":null,"sidebarTitle":"List associated parties","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/compliance/associated-parties","href":"/v3/api-reference/compliance/list-associated-parties"},{"title":"Add a compliance document","deprecated":null,"version":null,"sidebarTitle":"Add a compliance document","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/compliance/documents","href":"/v3/api-reference/compliance/add-a-compliance-document"},{"title":"Update a compliance document","deprecated":null,"version":null,"sidebarTitle":"Update a compliance document","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/compliance/documents/{documentId}","href":"/v3/api-reference/compliance/update-a-compliance-document"},{"title":"Delete a compliance document","deprecated":null,"version":null,"sidebarTitle":"Delete a compliance document","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/compliance/documents/{documentId}","href":"/v3/api-reference/compliance/delete-a-compliance-document"},{"title":"Retrieve a compliance document","deprecated":null,"version":null,"sidebarTitle":"Retrieve a compliance document","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/compliance/documents/{documentId}","href":"/v3/api-reference/compliance/retrieve-a-compliance-document"},{"title":"List compliance documents","deprecated":null,"version":null,"sidebarTitle":"List compliance documents","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/compliance/documents","href":"/v3/api-reference/compliance/list-compliance-documents"},{"title":"Submit compliance for review","deprecated":null,"version":null,"sidebarTitle":"Submit compliance for review","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/users/{userId}/compliance/submit","href":"/v3/api-reference/compliance/submit-compliance-for-review"},{"title":"Retrieve compliance status","deprecated":null,"version":null,"sidebarTitle":"Retrieve compliance status","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/users/{userId}/compliance/status","href":"/v3/api-reference/compliance/retrieve-compliance-status"}]},{"group":"RFI","pages":[{"title":"List RFIs","deprecated":null,"version":null,"sidebarTitle":"List rfis","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/rfis","href":"/v3/api-reference/rfi/list-rfis"},{"title":"Submit a response to an RFI","deprecated":null,"version":null,"sidebarTitle":"Submit a response to an rfi","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/rfis/{rfiId}/submissions","href":"/v3/api-reference/rfi/submit-a-response-to-an-rfi"}]},{"group":"Compliance Links","pages":[{"title":"Generate a compliance link","deprecated":null,"version":null,"sidebarTitle":"Generate a compliance link","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/compliance-links","href":"/v3/api-reference/compliance/generate-a-compliance-link"},{"title":"Retrieve a compliance link","deprecated":null,"version":null,"sidebarTitle":"Retrieve a compliance link","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/compliance-links/{complianceLinkId}","href":"/v3/api-reference/compliance/retrieve-a-compliance-link"}]},{"group":"File","pages":[{"title":"Upload a file","deprecated":null,"version":null,"sidebarTitle":"Upload a file","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/files","href":"/v3/api-reference/file/upload-a-file"}]},{"group":"Wallets","pages":[{"title":"Create wallets","deprecated":null,"version":null,"sidebarTitle":"Create wallets","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/wallets","href":"/v3/api-reference/wallet/create-wallets"},{"title":"Retrieve a wallet","deprecated":null,"version":null,"sidebarTitle":"Retrieve a wallet","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/wallets/{walletId}","href":"/v3/api-reference/wallet/retrieve-a-wallet"},{"title":"List wallet deposits","deprecated":null,"version":null,"sidebarTitle":"List wallet deposits","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/wallets/deposits","href":"/v3/api-reference/wallet/list-wallet-deposits"},{"title":"Retrieve a wallet deposit","deprecated":null,"version":null,"sidebarTitle":"Retrieve a wallet deposit","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/wallets/deposits/{depositId}","href":"/v3/api-reference/wallet/retrieve-a-wallet-deposit"},{"title":"List wallets","deprecated":null,"version":null,"sidebarTitle":"List wallets","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/wallets","href":"/v3/api-reference/wallet/list-wallets"},{"title":"Retrieve a wallet balance","deprecated":null,"version":null,"sidebarTitle":"Retrieve a wallet balance","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/wallets/{walletId}/balance","href":"/v3/api-reference/wallet/retrieve-a-wallet-balance"},{"title":"List offers","deprecated":null,"version":null,"sidebarTitle":"List offers","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/wallets/offers","href":"/v3/api-reference/wallet/list-offers"},{"title":"Retrieve an offer","deprecated":null,"version":null,"sidebarTitle":"Retrieve an offer","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/wallets/offers/{offerId}","href":"/v3/api-reference/wallet/retrieve-an-offer"},{"title":"Accept an offer","deprecated":null,"version":null,"sidebarTitle":"Accept an offer","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/wallets/offers/{offerId}/accept","href":"/v3/api-reference/wallet/accept-an-offer"},{"title":"Reject an offer","deprecated":null,"version":null,"sidebarTitle":"Reject an offer","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/wallets/offers/{offerId}/reject","href":"/v3/api-reference/wallet/reject-an-offer"}]},{"group":"Counter Parties","pages":[{"title":"Create a counter party","deprecated":null,"version":null,"sidebarTitle":"Create a counter party","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/counter-parties","href":"/v3/api-reference/counter-party/create-a-counter-party"},{"title":"Update a counter party","deprecated":null,"version":null,"sidebarTitle":"Update a counter party","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/counter-parties/{counterPartyId}","href":"/v3/api-reference/counter-party/update-a-counter-party"},{"title":"Delete a counter party","deprecated":null,"version":null,"sidebarTitle":"Delete a counter party","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/counter-parties/{counterPartyId}","href":"/v3/api-reference/counter-party/delete-a-counter-party"},{"title":"Retrieve a counter party","deprecated":null,"version":null,"sidebarTitle":"Retrieve a counter party","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/counter-parties/{counterPartyId}","href":"/v3/api-reference/counter-party/retrieve-a-counter-party"},{"title":"List counter parties","deprecated":null,"version":null,"sidebarTitle":"List counter parties","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/counter-parties","href":"/v3/api-reference/counter-party/list-counter-parties"}]},{"group":"External Accounts","pages":[{"title":"Create an external account","deprecated":null,"version":null,"sidebarTitle":"Create an external account","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/external-accounts","href":"/v3/api-reference/external-account/create-an-external-account"},{"title":"Update an external account","deprecated":null,"version":null,"sidebarTitle":"Update an external account","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/external-accounts/{externalAccountId}","href":"/v3/api-reference/external-account/update-an-external-account"},{"title":"Delete an external account","deprecated":null,"version":null,"sidebarTitle":"Delete an external account","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/external-accounts/{externalAccountId}","href":"/v3/api-reference/external-account/delete-an-external-account"},{"title":"Retrieve an external account","deprecated":null,"version":null,"sidebarTitle":"Retrieve an external account","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/external-accounts/{externalAccountId}","href":"/v3/api-reference/external-account/retrieve-an-external-account"},{"title":"List external accounts","deprecated":null,"version":null,"sidebarTitle":"List external accounts","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/external-accounts","href":"/v3/api-reference/external-account/list-external-accounts"}]},{"group":"External Cards","pages":[{"title":"Create an external card","deprecated":null,"version":null,"sidebarTitle":"Create an external card","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/external-cards","href":"/v3/api-reference/external-card/create-an-external-card"},{"title":"Update an external card","deprecated":null,"version":null,"sidebarTitle":"Update an external card","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/external-cards/{externalCardId}","href":"/v3/api-reference/external-card/update-an-external-card"},{"title":"Delete an external card","deprecated":null,"version":null,"sidebarTitle":"Delete an external card","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/external-cards/{externalCardId}","href":"/v3/api-reference/external-card/delete-an-external-card"},{"title":"Retrieve an external card","deprecated":null,"version":null,"sidebarTitle":"Retrieve an external card","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/external-cards/{externalCardId}","href":"/v3/api-reference/external-card/retrieve-an-external-card"},{"title":"List external cards","deprecated":null,"version":null,"sidebarTitle":"List external cards","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/external-cards","href":"/v3/api-reference/external-card/list-external-cards"},{"title":"Create an external card session","deprecated":null,"version":null,"sidebarTitle":"Create an external card session","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/external-card-sessions","href":"/v3/api-reference/external-card/create-an-external-card-session"},{"title":"Retrieve an external card session","deprecated":null,"version":null,"sidebarTitle":"Retrieve an external card session","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/external-card-sessions/{cardSessionId}","href":"/v3/api-reference/external-card/retrieve-an-external-card-session"}]},{"group":"External Wallets","pages":[{"title":"Add an external wallet","deprecated":null,"version":null,"sidebarTitle":"Add an external wallet","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/external-wallets","href":"/v3/api-reference/external-wallet/add-an-external-wallet"},{"title":"Update an external wallet","deprecated":null,"version":null,"sidebarTitle":"Update an external wallet","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/external-wallets/{externalWalletId}","href":"/v3/api-reference/external-wallet/update-an-external-wallet"},{"title":"Deactivate an external wallet","deprecated":null,"version":null,"sidebarTitle":"Deactivate an external wallet","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/external-wallets/{externalWalletId}","href":"/v3/api-reference/external-wallet/deactivate-an-external-wallet"},{"title":"Retrieve an external wallet","deprecated":null,"version":null,"sidebarTitle":"Retrieve an external wallet","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/external-wallets/{externalWalletId}","href":"/v3/api-reference/external-wallet/retrieve-an-external-wallet"},{"title":"List external wallets","deprecated":null,"version":null,"sidebarTitle":"List external wallets","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/external-wallets","href":"/v3/api-reference/external-wallet/list-external-wallets"}]},{"group":"Virtual Accounts","pages":[{"title":"Create a virtual account","deprecated":null,"version":null,"sidebarTitle":"Create a virtual account","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/virtual-accounts","href":"/v3/api-reference/virtual-account/create-a-virtual-account"},{"title":"Retrieve a virtual account","deprecated":null,"version":null,"sidebarTitle":"Retrieve a virtual account","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/virtual-accounts/{virtualAccountId}","href":"/v3/api-reference/virtual-account/retrieve-a-virtual-account"},{"title":"Deactivate a virtual account","deprecated":null,"version":null,"sidebarTitle":"Deactivate a virtual account","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/virtual-accounts/{virtualAccountId}","href":"/v3/api-reference/virtual-account/deactivate-a-virtual-account"},{"title":"List virtual accounts","deprecated":null,"version":null,"sidebarTitle":"List virtual accounts","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/virtual-accounts","href":"/v3/api-reference/virtual-account/list-virtual-accounts"},{"title":"Simulate a virtual account deposit","deprecated":null,"version":null,"sidebarTitle":"Simulate a virtual account deposit","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/virtual-accounts/{virtualAccountId}/simulate-deposits","href":"/v3/api-reference/virtual-account/simulate-a-virtual-account-deposit"},{"title":"List virtual account routes","deprecated":null,"version":null,"sidebarTitle":"List virtual account routes","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/virtual-accounts/routes","href":"/v3/api-reference/virtual-account/list-virtual-account-routes"},{"title":"Retrieve a virtual account route","deprecated":null,"version":null,"sidebarTitle":"Retrieve a virtual account route","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/virtual-accounts/routes/{vaRouteId}","href":"/v3/api-reference/virtual-account/retrieve-a-virtual-account-route"},{"title":"Migrate virtual accounts to v3","deprecated":null,"version":null,"sidebarTitle":"Migrate virtual accounts to v3","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/virtual-accounts/v3-migration","href":"/v3/api-reference/virtual-account/migrate-virtual-accounts-to-v3"}]},{"group":"Settlement Rules","pages":[{"title":"Create a settlement rule","deprecated":null,"version":null,"sidebarTitle":"Create a settlement rule","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/virtual-accounts/settlement-rules","href":"/v3/api-reference/virtual-account/create-a-settlement-rule"},{"title":"Retrieve a settlement rule","deprecated":null,"version":null,"sidebarTitle":"Retrieve a settlement rule","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/virtual-accounts/settlement-rules/{settlementRuleId}","href":"/v3/api-reference/virtual-account/retrieve-a-settlement-rule"},{"title":"List settlement rules","deprecated":null,"version":null,"sidebarTitle":"List settlement rules","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/virtual-accounts/settlement-rules","href":"/v3/api-reference/virtual-account/list-settlement-rules"},{"title":"Update a settlement rule","deprecated":null,"version":null,"sidebarTitle":"Update a settlement rule","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/virtual-accounts/settlement-rules/{settlementRuleId}","href":"/v3/api-reference/virtual-account/update-a-settlement-rule"},{"title":"Delete a settlement rule","deprecated":null,"version":null,"sidebarTitle":"Delete a settlement rule","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/virtual-accounts/settlement-rules/{settlementRuleId}","href":"/v3/api-reference/virtual-account/delete-a-settlement-rule"},{"title":"Apply a settlement rule to a virtual account","description":"Attach a settlement rule to a virtual account so its deposits are split accordingly.","deprecated":null,"version":null,"sidebarTitle":"Apply a settlement rule to a virtual account","openapi":"https://production.hifi.com/api/v3/openapi.json put /v3/virtual-accounts/{virtualAccountId}/settlement-rules","href":"/v3/api-reference/virtual-account/apply-a-settlement-rule-to-a-virtual-account"},{"title":"Remove the settlement rule from a virtual account","deprecated":null,"version":null,"sidebarTitle":"Remove the settlement rule from a virtual account","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/virtual-accounts/{virtualAccountId}/settlement-rules","href":"/v3/api-reference/virtual-account/remove-the-settlement-rule-from-a-virtual-account"}]},{"group":"Orchestration Addresses","pages":[{"title":"Create an orchestration address","description":"Create a persistent address that automatically offramps supported stablecoin deposits.","deprecated":null,"version":null,"sidebarTitle":"Create an orchestration address","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/orchestration-addresses","href":"/v3/api-reference/orchestration-address/create-an-orchestration-address"},{"title":"Retrieve an orchestration address","deprecated":null,"version":null,"sidebarTitle":"List orchestration addresses","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/orchestration-addresses/{orchestrationAddressId}","href":"/v3/api-reference/orchestration-address/list-orchestration-addresses"},{"title":"Retrieve an orchestration address","deprecated":null,"version":null,"sidebarTitle":"List orchestration addresses","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/orchestration-addresses/{orchestrationAddressId}","href":"/v3/api-reference/orchestration-address/list-orchestration-addresses"},{"title":"Update an orchestration address","deprecated":null,"version":null,"sidebarTitle":"Update an orchestration address","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/orchestration-addresses/{orchestrationAddressId}","href":"/v3/api-reference/orchestration-address/update-an-orchestration-address"},{"title":"Deactivate an orchestration address","deprecated":null,"version":null,"sidebarTitle":"Deactivate an orchestration address","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/orchestration-addresses/{orchestrationAddressId}","href":"/v3/api-reference/orchestration-address/deactivate-an-orchestration-address"},{"title":"Retrieve an orchestration deposit","deprecated":null,"version":null,"sidebarTitle":"List orchestration deposits","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/orchestration-addresses/deposits/{orchestrationDepositId}","href":"/v3/api-reference/orchestration-address/list-orchestration-deposits"},{"title":"Retrieve an orchestration deposit","deprecated":null,"version":null,"sidebarTitle":"List orchestration deposits","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/orchestration-addresses/deposits/{orchestrationDepositId}","href":"/v3/api-reference/orchestration-address/list-orchestration-deposits"},{"title":"Retrieve an orchestration batch","deprecated":null,"version":null,"sidebarTitle":"List orchestration batches","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/orchestration-addresses/batches/{orchestrationBatchId}","href":"/v3/api-reference/orchestration-address/list-orchestration-batches"},{"title":"Retrieve an orchestration batch","deprecated":null,"version":null,"sidebarTitle":"List orchestration batches","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/orchestration-addresses/batches/{orchestrationBatchId}","href":"/v3/api-reference/orchestration-address/list-orchestration-batches"},{"title":"Trigger orchestration","deprecated":null,"version":null,"sidebarTitle":"Trigger orchestration","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/orchestration-addresses/{orchestrationAddressId}/orchestrate","href":"/v3/api-reference/orchestration-address/trigger-orchestration"}]},{"group":"Onramps","pages":[{"title":"Get an onramp rate","deprecated":null,"version":null,"sidebarTitle":"Get an onramp rate","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/onramps/rates","href":"/v3/api-reference/onramp/get-an-onramp-rate"},{"title":"Create an onramp","deprecated":null,"version":null,"sidebarTitle":"Create an onramp","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/onramps","href":"/v3/api-reference/onramp/create-an-onramp"},{"title":"Accept an onramp quote","deprecated":null,"version":null,"sidebarTitle":"Accept an onramp quote","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/onramps/{onrampId}/quote/accept","href":"/v3/api-reference/onramp/accept-an-onramp-quote"},{"title":"Retrieve an onramp","deprecated":null,"version":null,"sidebarTitle":"Retrieve an onramp","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/onramps/{onrampId}","href":"/v3/api-reference/onramp/retrieve-an-onramp"},{"title":"List onramps","deprecated":null,"version":null,"sidebarTitle":"List onramps","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/onramps","href":"/v3/api-reference/onramp/list-onramps"},{"title":"Cancel an onramp","deprecated":null,"version":null,"sidebarTitle":"Cancel an onramp","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/onramps/{onrampId}/cancel","href":"/v3/api-reference/onramp/cancel-an-onramp"},{"title":"Simulate an onramp deposit","deprecated":null,"version":null,"sidebarTitle":"Simulate an onramp deposit","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/onramps/{onrampId}/simulate-deposits","href":"/v3/api-reference/onramp/simulate-an-onramp-deposit"}]},{"group":"Offramps","pages":[{"title":"Retrieve an offramp rate","deprecated":null,"version":null,"sidebarTitle":"Retrieve an offramp rate","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/offramps/rates","href":"/v3/api-reference/offramp/retrieve-an-offramp-rate"},{"title":"Create an offramp","deprecated":null,"version":null,"sidebarTitle":"Create an offramp","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/offramps","href":"/v3/api-reference/offramp/create-an-offramp"},{"title":"Accept an offramp quote","deprecated":null,"version":null,"sidebarTitle":"Accept an offramp quote","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/offramps/{offrampId}/quote/accept","href":"/v3/api-reference/offramp/accept-an-offramp-quote"},{"title":"Retrieve an offramp","deprecated":null,"version":null,"sidebarTitle":"Retrieve an offramp","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/offramps/{offrampId}","href":"/v3/api-reference/offramp/retrieve-an-offramp"},{"title":"List offramps","deprecated":null,"version":null,"sidebarTitle":"List offramps","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/offramps","href":"/v3/api-reference/offramp/list-offramps"},{"title":"Cancel an offramp","deprecated":null,"version":null,"sidebarTitle":"Cancel an offramp","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/offramps/{offrampId}/cancel","href":"/v3/api-reference/offramp/cancel-an-offramp"}]},{"group":"Crypto Transfers","pages":[{"title":"Create a crypto transfer","deprecated":null,"version":null,"sidebarTitle":"Create a crypto transfer","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/crypto-transfers","href":"/v3/api-reference/crypto-transfer/create-a-crypto-transfer"},{"title":"Retrieve a crypto transfer","deprecated":null,"version":null,"sidebarTitle":"Retrieve a crypto transfer","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/crypto-transfers/{cryptoTransferId}","href":"/v3/api-reference/crypto-transfer/retrieve-a-crypto-transfer"},{"title":"List crypto transfers","deprecated":null,"version":null,"sidebarTitle":"List crypto transfers","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/crypto-transfers","href":"/v3/api-reference/crypto-transfer/list-crypto-transfers"},{"title":"Create a batch crypto transfer","deprecated":null,"version":null,"sidebarTitle":"Create a batch crypto transfer","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/batch-transfers","href":"/v3/api-reference/crypto-transfer/create-a-batch-crypto-transfer"},{"title":"Retrieve a batch crypto transfer","deprecated":null,"version":null,"sidebarTitle":"Retrieve a batch crypto transfer","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/batch-transfers/{batchCryptoTransferId}","href":"/v3/api-reference/crypto-transfer/retrieve-a-batch-crypto-transfer"},{"title":"List batch crypto transfers","deprecated":null,"version":null,"sidebarTitle":"List batch crypto transfers","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/batch-transfers","href":"/v3/api-reference/crypto-transfer/list-batch-crypto-transfers"}]},{"group":"Swaps","pages":[{"title":"Create a swap","deprecated":null,"version":null,"sidebarTitle":"Create a swap","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/swaps","href":"/v3/api-reference/token-swap/create-a-swap"},{"title":"Accept a swap quote","deprecated":null,"version":null,"sidebarTitle":"Accept a swap quote","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/swaps/{swapId}/quote/accept","href":"/v3/api-reference/token-swap/accept-a-swap-quote"},{"title":"Retrieve a swap","deprecated":null,"version":null,"sidebarTitle":"Retrieve a swap","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/swaps/{swapId}","href":"/v3/api-reference/token-swap/retrieve-a-swap"},{"title":"List swaps","deprecated":null,"version":null,"sidebarTitle":"List swaps","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/swaps","href":"/v3/api-reference/token-swap/list-swaps"}]},{"group":"Bridges","pages":[{"title":"Create a bridge transfer","deprecated":null,"version":null,"sidebarTitle":"Create a bridge transfer","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/bridges","href":"/v3/api-reference/bridge/create-a-bridge-transfer"},{"title":"Retrieve a bridge transfer","deprecated":null,"version":null,"sidebarTitle":"Retrieve a bridge transfer","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/bridges/{bridgeId}","href":"/v3/api-reference/bridge/retrieve-a-bridge-transfer"},{"title":"Accept a bridge quote","deprecated":null,"version":null,"sidebarTitle":"Accept a bridge quote","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/bridges/{bridgeId}/quote/accept","href":"/v3/api-reference/bridge/accept-a-bridge-quote"},{"title":"List bridge transfers","deprecated":null,"version":null,"sidebarTitle":"List bridge transfers","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/bridges","href":"/v3/api-reference/bridge/list-bridge-transfers"}]},{"group":"Transfer Approvals","pages":[{"title":"Approve a transfer","deprecated":null,"version":null,"sidebarTitle":"Approve a transfer","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/transfer-approvals/{transferApprovalId}/approve","href":"/v3/api-reference/transfer-approval/approve-a-transfer"},{"title":"Reject a transfer","deprecated":null,"version":null,"sidebarTitle":"Reject a transfer","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/transfer-approvals/{transferApprovalId}/reject","href":"/v3/api-reference/transfer-approval/reject-a-transfer"},{"title":"List transfer approvals","deprecated":null,"version":null,"sidebarTitle":"List transfer approvals","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/transfer-approvals","href":"/v3/api-reference/transfer-approval/list-transfer-approvals"},{"title":"Retrieve a transfer approval","deprecated":null,"version":null,"sidebarTitle":"Retrieve a transfer approval","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/transfer-approvals/{transferApprovalId}","href":"/v3/api-reference/transfer-approval/retrieve-a-transfer-approval"}]},{"group":"Corridors","pages":[{"title":"Retrieve a corridor","deprecated":null,"version":null,"sidebarTitle":"Retrieve a corridor","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/corridors/{corridorId}","href":"/v3/api-reference/corridor/retrieve-a-corridor"},{"title":"List corridors","deprecated":null,"version":null,"sidebarTitle":"List corridors","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/corridors","href":"/v3/api-reference/corridor/list-corridors"}]},{"group":"Migration","pages":[{"title":"Map v2 IDs to v3 IDs","deprecated":null,"version":null,"sidebarTitle":"Map v2 ids to v3 ids","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/id-mappings","href":"/v3/api-reference/migration/map-v2-ids-to-v3-ids"}]},{"group":"Webhook Endpoints","pages":[{"title":"List webhook event types","deprecated":null,"version":null,"sidebarTitle":"List webhook event types","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/webhook-endpoints/event-types","href":"/v3/api-reference/webhook-endpoint/list-webhook-event-types"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Create a webhook endpoint","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/webhook-endpoints","href":"/v3/api-reference/webhook-endpoint/create-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Update a webhook endpoint","openapi":"https://production.hifi.com/api/v3/openapi.json patch /v3/webhook-endpoints/{webhookEndpointId}","href":"/v3/api-reference/webhook-endpoint/update-a-webhook-endpoint"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Retrieve a webhook endpoint","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/webhook-endpoints/{webhookEndpointId}","href":"/v3/api-reference/webhook-endpoint/retrieve-a-webhook-endpoint"},{"title":"List webhook endpoints","deprecated":null,"version":null,"sidebarTitle":"List webhook endpoints","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/webhook-endpoints","href":"/v3/api-reference/webhook-endpoint/list-webhook-endpoints"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Delete a webhook endpoint","openapi":"https://production.hifi.com/api/v3/openapi.json delete /v3/webhook-endpoints/{webhookEndpointId}","href":"/v3/api-reference/webhook-endpoint/delete-a-webhook-endpoint"},{"title":"Retrieve webhook delivery history","deprecated":null,"version":null,"sidebarTitle":"Retrieve webhook delivery history","openapi":"https://production.hifi.com/api/v3/openapi.json get /v3/webhook-endpoints/{webhookEndpointId}/history","href":"/v3/api-reference/webhook-endpoint/retrieve-webhook-delivery-history"},{"title":"Resend a webhook event","deprecated":null,"version":null,"sidebarTitle":"Resend a webhook event","openapi":"https://production.hifi.com/api/v3/openapi.json post /v3/webhook-endpoints/{webhookEndpointId}/events/{webhookEventId}/resend","href":"/v3/api-reference/webhook-endpoint/resend-a-webhook-event"}]}]}]}]},{"version":"v2","default":true,"tag":"Stable","pages":[{"title":"v2","href":"/"}]}]},"basePath":"","title":"HIFI Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-C4GwDT3_.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}