Optional positive limit price, expressed as destination-currency units
per one source-currency unit. Supported only for direct USDT/USDC swaps
in either direction and limited to four decimal places. Omit to use
market pricing.
Optional number of seconds after creating the swap when execution should
be cancelled if it has not already started. Supported only for direct
USDT/USDC swaps in either direction. Omit to disable automatic cancellation.
{"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":"api-reference/token-swap/create-a-swap","slug":"/api-reference/token-swap/create-a-swap","pageMetadata":{"title":"Create a swap","description":"Create a swap request to exchange one cryptocurrency for another within the same chain or across chains.\n","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/swaps","href":"/api-reference/token-swap/create-a-swap","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: \"Create a swap request to exchange one cryptocurrency for another within the same chain or across chains.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a swap","description":"Create a swap request to exchange one cryptocurrency for another within the same chain or across chains.\n","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/swaps","href":"/api-reference/token-swap/create-a-swap","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/hifi/5e51763843a3bb92/homepage.js"],"openApiReferenceData":{"operation":{"summary":"Create a swap","description":"Create a swap request to exchange one cryptocurrency for another within the same chain or across chains.\n","tags":["Token Swap"],"requestBody":"873aef51-508e-4abe-88c5-d6a2519f9cce","responses":{"200":"9cfc9eb4-20a9-4340-933f-9d9b424377a6","401":"71cce43e-f4c7-4cab-9dfe-080d332037fa","404":"044e020f-bc72-4a03-8235-af9c24b66b06","500":"233853cc-f920-4c8a-8ac7-c651f73b8d99"},"method":"post","type":"path","servers":["6f432d32-e3fd-4608-b3f0-1c4898c1934a","b6cc863e-a862-4848-872f-9c5ae26de871"],"security":["6053876a-a234-4b58-84c8-e0a0938eafaf"],"path":"/v2/wallets/swaps","baseUrlOptions":["https://production.hifibridge.com","https://sandbox.hifibridge.com"],"title":"Create a swap","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["requestId","source","destination"],"properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for the swap request (recommend using uuid v4)","example":"1ab3e6e0-4839-4dbe-89c3-b06d9645ae86","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003cuuid>"},"source":{"type":"object","description":"Source wallet information for the swap","required":["userId","chain","currency"],"properties":{"userId":{"type":"string","format":"uuid","description":"User ID of the source wallet owner","example":"05179f69-1988-4b46-a847-dd4eea0984d6","isRequired":true,"uniqueKey":"source.userId","typeLabel":"string\u003cuuid>"},"chain":{"type":"string","enum":["POLYGON","ETHEREUM","SOLANA","TRON"],"description":"Blockchain network for the source wallet","example":"POLYGON","isRequired":true,"uniqueKey":"source.chain","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["usdc","usdt"],"description":"Source cryptocurrency to swap from","example":"usdt","isRequired":true,"uniqueKey":"source.currency","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Amount to swap (either source.amount or destination.amount must be provided)","example":"10000","uniqueKey":"source.amount","typeLabel":"string"}},"isRequired":true,"uniqueKey":"source","typeLabel":"object"},"destination":{"type":"object","description":"Destination wallet information for the swap","required":["chain","currency"],"properties":{"chain":{"type":"string","enum":["POLYGON","ETHEREUM","SOLANA","TRON"],"description":"Blockchain network for the destination wallet","example":"POLYGON","isRequired":true,"uniqueKey":"destination.chain","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["usdc","usdt","usdg"],"description":"Destination cryptocurrency to swap to","example":"usdc","isRequired":true,"uniqueKey":"destination.currency","typeLabel":"enum\u003cstring>"},"userId":{"type":"string","format":"uuid","description":"User ID of the destination wallet owner","example":"05179f69-1988-4b46-a847-dd4eea0984d6","uniqueKey":"destination.userId","typeLabel":"string\u003cuuid>"},"externalWalletId":{"type":"string","format":"uuid","description":"External wallet ID (Exclude with userId)","example":"64fc4e9d-4839-4384-b4a0-0376af2c9b2e","uniqueKey":"destination.externalWalletId","typeLabel":"string\u003cuuid>"},"walletAddress":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Wallet address (Exclude with userId)","example":"0xE9cfBf1D690565579D823264170eE357f80e9A34","uniqueKey":"destination.walletAddress","typeLabel":"string"},"amount":{"type":"string","description":"Amount to receive (either source.amount or destination.amount must be provided)","example":"10000","uniqueKey":"destination.amount","typeLabel":"string"}},"isRequired":true,"uniqueKey":"destination","typeLabel":"object"},"limitPrice":{"type":"string","pattern":"^(?=.*[1-9])\\d+(?:\\.\\d{1,4})?$","description":"Optional positive limit price, expressed as destination-currency units\nper one source-currency unit. Supported only for direct USDT/USDC swaps\nin either direction and limited to four decimal places. Omit to use\nmarket pricing.\n","example":"0.9990","uniqueKey":"limitPrice","typeLabel":"string"},"cancelAfterSeconds":{"type":"integer","minimum":60,"maximum":86400,"description":"Optional number of seconds after creating the swap when execution should\nbe cancelled if it has not already started. Supported only for direct\nUSDT/USDC swaps in either direction. Omit to disable automatic cancellation.\n","example":3600,"uniqueKey":"cancelAfterSeconds","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"requestId":"1ab3e6e0-4839-4dbe-89c3-b06d9645ae86","source":{"userId":"05179f69-1988-4b46-a847-dd4eea0984d6","chain":"POLYGON","currency":"usdt","amount":"10000"},"destination":{"chain":"POLYGON","currency":"usdc","userId":"05179f69-1988-4b46-a847-dd4eea0984d6","externalWalletId":"64fc4e9d-4839-4384-b4a0-0376af2c9b2e","walletAddress":"0xE9cfBf1D690565579D823264170eE357f80e9A34","amount":"10000"},"limitPrice":"0.9990","cancelAfterSeconds":3600}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9cfc9eb4-20a9-4340-933f-9d9b424377a6":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"transferType":{"type":"string","example":"WALLET.SWAP","uniqueKey":"transferType","typeLabel":"string"},"transferDetails":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"dc923cc1-d74b-58f6-9fe4-9e9c6eb8dc37","uniqueKey":"transferDetails.id","typeLabel":"string\u003cuuid>"},"requestId":{"type":"string","format":"uuid","example":"1ab3e6e0-4839-4dbe-89c3-b06d9645ae86","uniqueKey":"transferDetails.requestId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["OPEN_QUOTE","CREATED","PENDING","COMPLETED","QUOTE_FAILED","FAILED","CANCELLED"],"example":"COMPLETED","uniqueKey":"transferDetails.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","example":"2025-08-20T03:55:29.437108+00:00","uniqueKey":"transferDetails.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","example":"2025-08-20T04:08:10.837+00:00","uniqueKey":"transferDetails.updatedAt","typeLabel":"string\u003cdate-time>"},"source":{"type":"object","properties":{"currency":{"type":"string","enum":["usdc","usdt","usdg","pyusd","pyusd0"],"example":"usdc","uniqueKey":"transferDetails.source.currency","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","example":10,"uniqueKey":"transferDetails.source.amount","typeLabel":"number"},"chain":{"type":"string","enum":["POLYGON","ETHEREUM","SOLANA","FLOW_EVM"],"uniqueKey":"transferDetails.source.chain","typeLabel":"enum\u003cstring>"},"userId":{"type":"string","format":"uuid","example":"05179f69-1988-4b46-a847-dd4eea0984d6","uniqueKey":"transferDetails.source.userId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"transferDetails.source","typeLabel":"object"},"destination":{"type":"object","properties":{"currency":{"type":"string","enum":["usdc","usdt","usdg","pyusd","pyusd0"],"example":"usdt","uniqueKey":"transferDetails.destination.currency","typeLabel":"enum\u003cstring>"},"userId":{"type":"string","format":"uuid","example":"05179f69-1988-4b46-a847-dd4eea0984d6","uniqueKey":"transferDetails.destination.userId","typeLabel":"string\u003cuuid>"},"externalWalletId":{"oneOf":[{"type":"string","format":"uuid","example":null,"uniqueKey":"transferDetails.destination.externalWalletId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","example":null,"uniqueKey":"transferDetails.destination.externalWalletId.oneOf.1","typeLabel":"null"}],"uniqueKey":"transferDetails.destination.externalWalletId","typeLabel":"string\u003cuuid> | null"},"amount":{"oneOf":[{"type":"number","example":null,"uniqueKey":"transferDetails.destination.amount.oneOf.0","typeLabel":"number"},{"type":"null","example":null,"uniqueKey":"transferDetails.destination.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"transferDetails.destination.amount","typeLabel":"number | null"},"chain":{"type":"string","enum":["POLYGON","ETHEREUM","SOLANA","FLOW_EVM"],"example":"POLYGON","uniqueKey":"transferDetails.destination.chain","typeLabel":"enum\u003cstring>"},"walletAddress":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","example":"0xe5727a4B1d93A26D6A7Adfaae145EFa41ED7f204","uniqueKey":"transferDetails.destination.walletAddress","typeLabel":"string"}},"uniqueKey":"transferDetails.destination","typeLabel":"object"},"error":{"oneOf":[{"type":"string","example":null,"uniqueKey":"transferDetails.error.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"transferDetails.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"transferDetails.error","typeLabel":"string | null"},"errorDetails":{"oneOf":[{"type":"string","example":null,"uniqueKey":"transferDetails.errorDetails.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"transferDetails.errorDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"transferDetails.errorDetails","typeLabel":"string | null"},"cancellable":{"type":"boolean","description":"Whether a new manual cancellation request can be submitted for this swap.\n`false` after cancellation has been requested, execution has passed the\ncancellation point of no return, or the swap is in a terminal status.\n","example":true,"uniqueKey":"transferDetails.cancellable","typeLabel":"boolean"},"autoCancelAt":{"oneOf":[{"type":"string","format":"date-time","description":"Absolute automatic-cancellation deadline requested when the swap was\ncreated. `null` when no automatic deadline was requested. The deadline\nis actionable only while `cancellable` is `true`.\n","example":"2026-07-13T02:00:00.000Z","uniqueKey":"transferDetails.autoCancelAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Absolute automatic-cancellation deadline requested when the swap was\ncreated. `null` when no automatic deadline was requested. The deadline\nis actionable only while `cancellable` is `true`.\n","example":"2026-07-13T02:00:00.000Z","uniqueKey":"transferDetails.autoCancelAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"transferDetails.autoCancelAt","typeLabel":"string\u003cdate-time> | null"},"cancelRequestedAt":{"oneOf":[{"type":"string","format":"date-time","description":"Server timestamp for the accepted manual cancellation request. `null`\nuntil a manual cancellation request has been recorded.\n","example":null,"uniqueKey":"transferDetails.cancelRequestedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Server timestamp for the accepted manual cancellation request. `null`\nuntil a manual cancellation request has been recorded.\n","example":null,"uniqueKey":"transferDetails.cancelRequestedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"transferDetails.cancelRequestedAt","typeLabel":"string\u003cdate-time> | null"},"quoteInformation":{"type":"object","properties":{"sendGross":{"type":"object","properties":{"amount":{"type":"string","example":"10","uniqueKey":"transferDetails.quoteInformation.sendGross.amount","typeLabel":"string"},"currency":{"type":"string","example":"usdc","uniqueKey":"transferDetails.quoteInformation.sendGross.currency","typeLabel":"string"}},"uniqueKey":"transferDetails.quoteInformation.sendGross","typeLabel":"object"},"sendNet":{"type":"object","properties":{"amount":{"type":"string","example":"10","uniqueKey":"transferDetails.quoteInformation.sendNet.amount","typeLabel":"string"},"currency":{"type":"string","example":"usdc","uniqueKey":"transferDetails.quoteInformation.sendNet.currency","typeLabel":"string"}},"uniqueKey":"transferDetails.quoteInformation.sendNet","typeLabel":"object"},"receiveGross":{"type":"object","properties":{"amount":{"type":"string","example":"10","uniqueKey":"transferDetails.quoteInformation.receiveGross.amount","typeLabel":"string"},"currency":{"type":"string","example":"usdc","uniqueKey":"transferDetails.quoteInformation.receiveGross.currency","typeLabel":"string"}},"uniqueKey":"transferDetails.quoteInformation.receiveGross","typeLabel":"object"},"receiveNet":{"type":"object","properties":{"amount":{"type":"string","example":"10","uniqueKey":"transferDetails.quoteInformation.receiveNet.amount","typeLabel":"string"},"currency":{"type":"string","example":"usdc","uniqueKey":"transferDetails.quoteInformation.receiveNet.currency","typeLabel":"string"}},"uniqueKey":"transferDetails.quoteInformation.receiveNet","typeLabel":"object"},"rate":{"type":"string","example":"1","uniqueKey":"transferDetails.quoteInformation.rate","typeLabel":"string"},"limitPrice":{"type":"string","pattern":"^(?=.*[1-9])\\d+(?:\\.\\d{1,4})?$","description":"The accepted client limit price, expressed as destination-currency\nunits per one source-currency unit. Present only when the swap request\nincluded `limitPrice`.\n","example":"0.9990","uniqueKey":"transferDetails.quoteInformation.limitPrice","typeLabel":"string"},"expiresAt":{"type":"string","format":"date-time","example":"2025-08-20T03:55:59.539+00:00","uniqueKey":"transferDetails.quoteInformation.expiresAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"transferDetails.quoteInformation","typeLabel":"object"}},"uniqueKey":"transferDetails","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"transferType":"WALLET.SWAP","transferDetails":{"id":"dc923cc1-d74b-58f6-9fe4-9e9c6eb8dc37","requestId":"1ab3e6e0-4839-4dbe-89c3-b06d9645ae86","status":"COMPLETED","createdAt":"2025-08-20T03:55:29.437108+00:00","updatedAt":"2025-08-20T04:08:10.837+00:00","source":{"currency":"usdc","amount":10,"chain":"POLYGON","userId":"05179f69-1988-4b46-a847-dd4eea0984d6"},"destination":{"currency":"usdt","userId":"05179f69-1988-4b46-a847-dd4eea0984d6","externalWalletId":null,"amount":null,"chain":"POLYGON","walletAddress":"0xe5727a4B1d93A26D6A7Adfaae145EFa41ED7f204"},"error":null,"errorDetails":null,"cancellable":true,"autoCancelAt":"2026-07-13T02:00:00.000Z","cancelRequestedAt":null,"quoteInformation":{"sendGross":{"amount":"10","currency":"usdc"},"sendNet":{"amount":"10","currency":"usdc"},"receiveGross":{"amount":"10","currency":"usdc"},"receiveNet":{"amount":"10","currency":"usdc"},"rate":"1","limitPrice":"0.9990","expiresAt":"2025-08-20T03:55:59.539+00:00"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"71cce43e-f4c7-4cab-9dfe-080d332037fa":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Error code","uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error type","uniqueKey":"error","typeLabel":"string"},"errorDetails":{"type":"string","description":"Detailed error message","uniqueKey":"errorDetails","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"error":"\u003cstring>","errorDetails":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"044e020f-bc72-4a03-8235-af9c24b66b06":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"233853cc-f920-4c8a-8ac7-c651f73b8d99":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Error code","uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error type","uniqueKey":"error","typeLabel":"string"},"errorDetails":{"type":"string","description":"Detailed error message","uniqueKey":"errorDetails","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"error":"\u003cstring>","errorDetails":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6053876a-a234-4b58-84c8-e0a0938eafaf":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"6f432d32-e3fd-4608-b3f0-1c4898c1934a":{"url":"https://production.hifibridge.com","description":"Production server"},"b6cc863e-a862-4848-872f-9c5ae26de871":{"url":"https://sandbox.hifibridge.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/v2/openapi.json"},"subdomain":"hifi","siteName":"HIFI Docs","title":"HIFI Docs","navMaps":{"firstHrefInVersion":{"v3":{"href":"/v3/api-reference/token-swap/create-a-swap","matchLevel":1},"v2":{"href":"/api-reference/token-swap/create-a-swap","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T17:55:07.489Z","originalFileLocation":"api-reference/token-swap/create-a-swap.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a swap request to exchange one cryptocurrency for another within the same chain or across chains.\">\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/api-reference/token-swap/create-a-swap\">\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=Wallet+Swaps\u0026amp;title=Create+a+swap\u0026amp;description=Create+a+swap+request+to+exchange+one+cryptocurrency+for+another+within+the+same+chain+or+across+chains.%0A\u0026amp;theme=445d8ece64587b97bc363e93\u0026amp;signature=58c4341ac542b2e46ba3799fb31570977610cdaeee715d838dd095554c7bc55d\">\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=Wallet+Swaps\u0026amp;title=Create+a+swap\u0026amp;description=Create+a+swap+request+to+exchange+one+cryptocurrency+for+another+within+the+same+chain+or+across+chains.%0A\u0026amp;theme=445d8ece64587b97bc363e93\u0026amp;signature=58c4341ac542b2e46ba3799fb31570977610cdaeee715d838dd095554c7bc55d\">\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/api-reference/token-swap/create-a-swap\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/token-swap/create-a-swap.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/api-reference/token-swap/create-a-swap#webpage\",\"url\":\"https://docs.hifi.com/api-reference/token-swap/create-a-swap\",\"name\":\"Create a swap\",\"description\":\"Create a swap request to exchange one cryptocurrency for another within the same chain or across chains.\",\"dateModified\":\"2026-10-27T17:55:07.489Z\",\"isPartOf\":{\"@id\":\"https://docs.hifi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hifi.com/api-reference/token-swap/create-a-swap#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hifi.com/api-reference/token-swap/create-a-swap#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.hifi.com/api-reference/common/ping\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Wallet Swaps\",\"item\":\"https://docs.hifi.com/api-reference/token-swap/list-all-swaps\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a swap\",\"item\":\"https://docs.hifi.com/api-reference/token-swap/create-a-swap\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hifi.com/api-reference/token-swap/create-a-swap#apireference\",\"headline\":\"Create a swap\",\"name\":\"Create a swap\",\"description\":\"Create a swap request to exchange one cryptocurrency for another within the same chain or across chains.\",\"url\":\"https://docs.hifi.com/api-reference/token-swap/create-a-swap\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hifi.com/api-reference/token-swap/create-a-swap#webpage\"},\"dateModified\":\"2026-10-27T17:55:07.489Z\",\"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":"/api-reference/token-swap/create-a-swap.md","siteName":"HIFI Docs","nav":{"global":null,"versions":[{"version":"v3","tag":"Beta","pages":[{"title":"v3","href":"/v3/api-reference/token-swap/create-a-swap"}]},{"version":"v2","default":true,"tag":"Stable","tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/quickstart"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"API Reference","pages":[{"group":"Overview","pages":[{"title":"Authentication","href":"/api/authentication"},{"title":"Error Codes","href":"/api/errors"}]},{"group":"Endpoints","pages":[{"group":"Common","pages":[{"title":"Ping","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /ping","href":"/api-reference/common/ping"}]},{"group":"Users","pages":[{"title":"List all users","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users","href":"/api-reference/user/list-all-users"},{"title":"Retrieve a user","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}","href":"/api-reference/user/retrieve-a-user"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users","href":"/api-reference/user/create-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}","href":"/api-reference/user/update-a-user"},{"title":"Retrieve a terms of service link","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/tos-link/{signedAgreementId}","href":"/api-reference/user/retrieve-a-terms-of-service-link"},{"title":"Generate a terms of service link","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/tos-link","href":"/api-reference/user/generate-a-terms-of-service-link"}]},{"group":"KYC","pages":[{"title":"List all KYC statuses","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/kyc/status","href":"/api-reference/kyc/list-all-kyc-statuses"},{"title":"Retrieve KYC information","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/kyc","href":"/api-reference/kyc/retrieve-kyc-information"},{"title":"Retrieve KYC status","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/kyc/status","href":"/api-reference/kyc/retrieve-kyc-status"},{"title":"Retrieve KYC requirements","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/kyc/requirements","href":"/api-reference/kyc/retrieve-kyc-requirements"},{"title":"List all documents","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/kyc/documents","href":"/api-reference/kyc/list-all-documents"},{"title":"Retrieve a document","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/kyc/documents/{documentId}","href":"/api-reference/kyc/retrieve-a-document"},{"title":"List all UBOs","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/kyc/ubos","href":"/api-reference/kyc/list-all-ubos"},{"title":"Retrieve a UBO","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/kyc/ubos/{uboId}","href":"/api-reference/kyc/retrieve-a-ubo"},{"title":"Generate a KYC link","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/kyc-link","href":"/api-reference/kyc/generate-a-kyc-link"},{"title":"Update KYC information","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/kyc","href":"/api-reference/kyc/update-kyc-information"},{"title":"Submit KYC","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/kyc/submissions","href":"/api-reference/kyc/submit-kyc"},{"title":"Add documents","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/kyc/documents","href":"/api-reference/kyc/add-documents"},{"title":"Update a document","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/kyc/documents/{documentId}","href":"/api-reference/kyc/update-a-document"},{"title":"Add a UBO","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/kyc/ubos","href":"/api-reference/kyc/add-a-ubo"},{"title":"Update a UBO","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/kyc/ubos/{uboId}","href":"/api-reference/kyc/update-a-ubo"}]},{"group":"RFI","pages":[{"title":"List RFIs","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/rfis","href":"/api-reference/rfi/list-rfis"},{"title":"Submit an RFI response","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/rfis/{rfiId}/submissions","href":"/api-reference/rfi/submit-an-rfi-response"}]},{"group":"File","pages":[{"title":"Upload a file","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/files","href":"/api-reference/file/upload-a-file"}]},{"group":"Wallets","pages":[{"title":"Retrieve wallet balance","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/wallets/balance","href":"/api-reference/wallet/retrieve-wallet-balance"},{"title":"Get external wallets for a user","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/wallets/external","href":"/api-reference/wallet/get-external-wallets-for-a-user"},{"title":"Get an external wallet","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/wallets/external/{externalWalletId}","href":"/api-reference/wallet/get-an-external-wallet"},{"title":"Get inbound deposits","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/wallets/deposits","href":"/api-reference/wallet/get-inbound-deposits"},{"title":"Get an inbound deposit","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/wallets/deposits/{depositId}","href":"/api-reference/wallet/get-an-inbound-deposit"},{"title":"Add wallets to a user","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/wallets/add","href":"/api-reference/wallet/add-wallets-to-a-user"},{"title":"Add external wallets to a user","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/wallets/external","href":"/api-reference/wallet/add-external-wallets-to-a-user"}]},{"group":"Accounts","pages":[{"title":"List all accounts","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/accounts","href":"/api-reference/account/list-all-accounts"},{"title":"Retrieve an account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/accounts/{accountId}","href":"/api-reference/account/retrieve-an-account"},{"title":"Create an account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/accounts","href":"/api-reference/account/create-an-account"},{"title":"Delete an account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json delete /v2/users/{userId}/accounts/{accountId}","href":"/api-reference/account/delete-an-account"}]},{"group":"Virtual Accounts","pages":[{"title":"List all virtual accounts","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/virtual-accounts","href":"/api-reference/virtual-account/list-all-virtual-accounts"},{"title":"Retrieve a virtual account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/virtual-accounts/{accountId}","href":"/api-reference/virtual-account/retrieve-a-virtual-account"},{"title":"Create a virtual account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/virtual-accounts","href":"/api-reference/virtual-account/create-a-virtual-account"},{"title":"Update a virtual account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/virtual-accounts/{accountId}/update","href":"/api-reference/virtual-account/update-a-virtual-account"},{"title":"Deactivate a virtual account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/virtual-accounts/{accountId}/deactivate","href":"/api-reference/virtual-account/deactivate-a-virtual-account"},{"title":"Reactivate a virtual account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/virtual-accounts/{accountId}/reactivate","href":"/api-reference/virtual-account/reactivate-a-virtual-account"},{"title":"Simulate a deposit to a virtual account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/virtual-accounts/{accountId}/simulate-deposit","href":"/api-reference/virtual-account/simulate-a-deposit-to-a-virtual-account"}]},{"group":"Orchestration Addresses","pages":[{"title":"List orchestration addresses","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/orchestration-addresses","href":"/api-reference/orchestration-address/list-orchestration-addresses"},{"title":"Retrieve an orchestration address","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}","href":"/api-reference/orchestration-address/retrieve-an-orchestration-address"},{"title":"Create an orchestration address","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/orchestration-addresses","href":"/api-reference/orchestration-address/create-an-orchestration-address"},{"title":"Update an orchestration address","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/update","href":"/api-reference/orchestration-address/update-an-orchestration-address"},{"title":"Deactivate an orchestration address","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/deactivate","href":"/api-reference/orchestration-address/deactivate-an-orchestration-address"},{"title":"List deposits for an orchestration address","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/deposits","href":"/api-reference/orchestration-address/list-deposits-for-an-orchestration-address"},{"title":"Retrieve a deposit","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/deposits/{depositId}","href":"/api-reference/orchestration-address/retrieve-a-deposit"},{"title":"List batches for an orchestration address","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/batches","href":"/api-reference/orchestration-address/list-batches-for-an-orchestration-address"},{"title":"Retrieve a batch","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/batches/{batchId}","href":"/api-reference/orchestration-address/retrieve-a-batch"},{"title":"Manually trigger an orchestration","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/orchestrate","href":"/api-reference/orchestration-address/manually-trigger-an-orchestration"}]},{"group":"Onramps","pages":[{"title":"List all onramps","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/onramps","href":"/api-reference/onramp/list-all-onramps"},{"title":"Retrieve an onramp","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/onramps/{transferId}","href":"/api-reference/onramp/retrieve-an-onramp"},{"title":"Retrieve an onramp rate","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/onramps/rates","href":"/api-reference/onramp/retrieve-an-onramp-rate"},{"title":"Create an onramp","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/onramps","href":"/api-reference/onramp/create-an-onramp"},{"title":"Cancel an onramp","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/onramps/{transferId}/cancel","href":"/api-reference/onramp/cancel-an-onramp"},{"title":"Refresh an onramp quote","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/onramps/{transferId}/quote/refresh","href":"/api-reference/onramp/refresh-an-onramp-quote"},{"title":"Accept an onramp quote","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/onramps/{transferId}/quote/accept","href":"/api-reference/onramp/accept-an-onramp-quote"}]},{"group":"Offramps","pages":[{"title":"List all offramps","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/offramps","href":"/api-reference/offramp/list-all-offramps"},{"title":"Retrieve an offramp","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/offramps/{transferId}","href":"/api-reference/offramp/retrieve-an-offramp"},{"title":"Retrieve an offramp rate","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/offramps/rates","href":"/api-reference/offramp/retrieve-an-offramp-rate"},{"title":"Create an offramp","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/offramps","href":"/api-reference/offramp/create-an-offramp"},{"title":"Cancel an offramp","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/offramps/{transferId}/cancel","href":"/api-reference/offramp/cancel-an-offramp"},{"title":"Accept an offramp quote","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/offramps/{transferId}/quote/accept","href":"/api-reference/offramp/accept-an-offramp-quote"}]},{"group":"Wallet Transfers","pages":[{"title":"List all crypto transfers","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/transfers","href":"/api-reference/crypto-transfer/list-all-crypto-transfers"},{"title":"Retrieve a crypto transfer","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/transfers/{transferId}","href":"/api-reference/crypto-transfer/retrieve-a-crypto-transfer"},{"title":"List all batch crypto transfers","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/transfers/batches","href":"/api-reference/crypto-transfer/list-all-batch-crypto-transfers"},{"title":"Retrieve a batch crypto transfer","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/transfers/batches/{transferId}","href":"/api-reference/crypto-transfer/retrieve-a-batch-crypto-transfer"},{"title":"Create a crypto transfer","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/transfers","href":"/api-reference/crypto-transfer/create-a-crypto-transfer"},{"title":"Create a batch crypto transfer","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/transfers/batches","href":"/api-reference/crypto-transfer/create-a-batch-crypto-transfer"}]},{"group":"Wallet Offers","pages":[{"title":"List all offers for a wallet","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/{walletId}/offers","href":"/api-reference/canton-offers/list-all-offers-for-a-wallet"},{"title":"Retrieve a Canton offer","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/{walletId}/offers/{offerId}","href":"/api-reference/canton-offers/retrieve-a-canton-offer"},{"title":"Accept a Canton offer","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/{walletId}/offers/{offerId}/accept","href":"/api-reference/canton-offers/accept-a-canton-offer"},{"title":"Reject a Canton offer","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/{walletId}/offers/{offerId}/reject","href":"/api-reference/canton-offers/reject-a-canton-offer"}]},{"group":"Wallet Bridges","pages":[{"title":"List all bridging requests","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/bridges","href":"/api-reference/cross-chain-bridge/list-all-bridging-requests"},{"title":"Retrieve a bridging request","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/bridges/{transferId}","href":"/api-reference/cross-chain-bridge/retrieve-a-bridging-request"},{"title":"Create a bridging request","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/bridges","href":"/api-reference/cross-chain-bridge/create-a-bridging-request"},{"title":"Accept a bridging request","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/bridges/{transferId}/accept","href":"/api-reference/cross-chain-bridge/accept-a-bridging-request"}]},{"group":"Wallet Swaps","pages":[{"title":"List all swaps","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/swaps","href":"/api-reference/token-swap/list-all-swaps"},{"title":"Retrieve a swap","description":"Retrieve details of a specific swap by its ID.\n","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/swaps/{swapId}","href":"/api-reference/token-swap/retrieve-a-swap"},{"title":"Create a swap","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/swaps","href":"/api-reference/token-swap/create-a-swap"},{"title":"Accept a swap","description":"Accept a swap request to execute the cryptocurrency exchange.\n","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/swaps/{swapId}/accept","href":"/api-reference/token-swap/accept-a-swap"},{"title":"Request swap cancellation","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/wallets/swaps/{swapId}/cancel","href":"/api-reference/token-swap/request-swap-cancellation"},{"title":"Retrieve a swap rate","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/wallets/swaps/rate","href":"/api-reference/token-swap/retrieve-a-swap-rate"}]},{"group":"Transfer Approvals","pages":[{"title":"List all pending transfer approvals","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/transfer-approvals","href":"/api-reference/transfer-approvals/list-all-pending-transfer-approvals"},{"title":"Get a transfer approval","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/transfer-approvals/{approvalId}","href":"/api-reference/transfer-approvals/get-a-transfer-approval"},{"title":"Approve a transfer","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/transfer-approvals/{approvalId}/approve","href":"/api-reference/transfer-approvals/approve-a-transfer"},{"title":"Reject a transfer","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/transfer-approvals/{approvalId}/reject","href":"/api-reference/transfer-approvals/reject-a-transfer"}]},{"group":"Settlement Rules","pages":[{"title":"List all settlement rules","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/virtual-accounts/settlement-rules","href":"/api-reference/settlement-rules/list-all-settlement-rules"},{"title":"Retrieve a settlement rule","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/virtual-accounts/settlement-rules/{ruleId}","href":"/api-reference/settlement-rules/retrieve-a-settlement-rule"},{"title":"Create a settlement rule","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/virtual-accounts/settlement-rules","href":"/api-reference/settlement-rules/create-a-settlement-rule"},{"title":"Update a settlement rule","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/virtual-accounts/settlement-rules/{ruleId}/update","href":"/api-reference/settlement-rules/update-a-settlement-rule"},{"title":"Apply settlement rule to virtual account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/users/{userId}/virtual-accounts/{accountId}/settlement-rules/{ruleId}","href":"/api-reference/settlement-rules/apply-settlement-rule-to-virtual-account"},{"title":"Delete a settlement rule","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json delete /v2/virtual-accounts/settlement-rules/{ruleId}","href":"/api-reference/settlement-rules/delete-a-settlement-rule"},{"title":"Remove settlement rule from virtual account","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json delete /v2/users/{userId}/virtual-accounts/{accountId}/settlement-rules","href":"/api-reference/settlement-rules/remove-settlement-rule-from-virtual-account"}]},{"group":"Reporting","pages":[{"title":"Get Available Metric Templates","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/reporting/templates","href":"/api-reference/reporting/get-available-metric-templates"},{"title":"Get Template Details","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/reporting/templates/{name}","href":"/api-reference/reporting/get-template-details"},{"title":"Get Parameter Options","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/reporting/params/{name}/options","href":"/api-reference/reporting/get-parameter-options"},{"title":"Create Saved Metric","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/reporting/metrics","href":"/api-reference/reporting/create-saved-metric"},{"title":"List Saved Metrics","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/reporting/metrics","href":"/api-reference/reporting/list-saved-metrics"},{"title":"Get Metric Details","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/reporting/metrics/{id}","href":"/api-reference/reporting/get-metric-details"},{"title":"Update Saved Metric","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/reporting/metrics/{id}","href":"/api-reference/reporting/update-saved-metric"},{"title":"Delete Saved Metric","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json delete /v2/reporting/metrics/{id}","href":"/api-reference/reporting/delete-saved-metric"},{"title":"Preview Metric Results","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json post /v2/reporting/metrics/preview","href":"/api-reference/reporting/preview-metric-results"},{"title":"Execute Saved Metric","deprecated":null,"version":null,"openapi":"https://production.hifi.com/api/v2/openapi.json get /v2/reporting/metrics/{id}/results","href":"/api-reference/reporting/execute-saved-metric"}]}]}]}]}]},"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"]}