Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
userId
string
required
ID of the user
Query Parameters
chain
enum<string>
required
The blockchain network to retrieve the wallet balance from.
Available options:
POLYGON,
ETHEREUM,
SOLANA,
BASE,
TRON
currency
enum<string>
required
The type of currency to check the balance for.
Available options:
usdc,
usdt,
usdg,
pyusd
status
enum<string>
Status of the deposit, CONFIRMED indicates the deposit is found in the blockchain, COMPLETED indicates the deposit is completed and unlikely to be reverted.
Available options:
CONFIRMED,
COMPLETED
createdAfter
string<date>
ISO format: YYYY-MM-DD
createdBefore
string<date>
ISO format: YYYY-MM-DD
limit
string
default to 10, maximum to 100
minAmount
number
Minimum amount of the deposit, default is 0.01
Response
Success
count
integer
deposits
object[]
Show child attributes
nextCursor
string
The createdAt timestamp of the last record in the current page. Pass this as createdBefore in the next request to retrieve the next page of results.
{"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":"6af791720efcea8bd4ccae6b","clientVersion":"0.0.4143","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":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","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/wallet/get-inbound-deposits","slug":"/api-reference/wallet/get-inbound-deposits","pageMetadata":{"title":"Get inbound deposits","description":"Get inbound deposits for a user's wallet","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","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: \"Get inbound deposits for a user’s wallet\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=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":"Get inbound deposits","description":"Get inbound deposits for a user's wallet","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/hifi/5e51763843a3bb92/homepage.js"],"openApiReferenceData":{"operation":{"summary":"Get inbound deposits","description":"Get inbound deposits for a user's wallet","tags":["Wallet"],"parameters":["95666171-f189-44a4-9ffe-039efda1287f","ba3dfc46-3347-41d4-978b-9cc0ba84a876","5a314c4e-8306-475c-9f56-d9d077acdc20","9a09c031-5aa5-424a-962c-b3e18c16f947","3054ea03-b9e5-462e-aed0-eabf055063c0","a8164dd3-120d-470e-a9a3-f3f404d7217a","7a237852-6bb9-4e1c-b1f8-c7fa4b5c3c4e","4c59246f-2ca6-46d3-abac-965851b765f5"],"responses":{"200":"f509dadd-079a-4c09-8d9d-61c2965d2378","401":"9d1b977f-48c1-4487-aa99-5969d18877eb","500":"12cf1f7b-6ecb-480f-a792-745084d04425"},"method":"get","type":"path","servers":["6f432d32-e3fd-4608-b3f0-1c4898c1934a","b6cc863e-a862-4848-872f-9c5ae26de871"],"security":["6053876a-a234-4b58-84c8-e0a0938eafaf"],"path":"/v2/users/{userId}/wallets/deposits","baseUrlOptions":["https://production.hifibridge.com","https://sandbox.hifibridge.com"],"title":"Get inbound deposits","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"95666171-f189-44a4-9ffe-039efda1287f":{"name":"userId","in":"path","schema":{"type":"string","isRequired":true,"description":"ID of the user","uniqueKey":"","typeLabel":"string"},"description":"ID of the user","required":true},"ba3dfc46-3347-41d4-978b-9cc0ba84a876":{"name":"chain","in":"query","schema":{"type":"string","enum":["POLYGON","ETHEREUM","SOLANA","BASE","TRON"],"isRequired":true,"description":"The blockchain network to retrieve the wallet balance from.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"The blockchain network to retrieve the wallet balance from.","required":true},"5a314c4e-8306-475c-9f56-d9d077acdc20":{"name":"currency","in":"query","schema":{"type":"string","enum":["usdc","usdt","usdg","pyusd"],"isRequired":true,"description":"The type of currency to check the balance for.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"The type of currency to check the balance for.","required":true},"9a09c031-5aa5-424a-962c-b3e18c16f947":{"name":"status","in":"query","schema":{"type":"string","enum":["CONFIRMED","COMPLETED"],"isRequired":false,"description":"Status of the deposit, CONFIRMED indicates the deposit is found in the blockchain, COMPLETED indicates the deposit is completed and unlikely to be reverted.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Status of the deposit, CONFIRMED indicates the deposit is found in the blockchain, COMPLETED indicates the deposit is completed and unlikely to be reverted.","required":false},"3054ea03-b9e5-462e-aed0-eabf055063c0":{"name":"createdAfter","in":"query","schema":{"type":"string","format":"date","isRequired":false,"description":"ISO format: YYYY-MM-DD","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"ISO format: YYYY-MM-DD","required":false},"a8164dd3-120d-470e-a9a3-f3f404d7217a":{"name":"createdBefore","in":"query","schema":{"type":"string","format":"date","isRequired":false,"description":"ISO format: YYYY-MM-DD","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"ISO format: YYYY-MM-DD","required":false},"7a237852-6bb9-4e1c-b1f8-c7fa4b5c3c4e":{"name":"limit","in":"query","schema":{"type":"string","minimum":1,"maximum":100,"isRequired":false,"description":"default to 10, maximum to 100","uniqueKey":"","typeLabel":"string"},"description":"default to 10, maximum to 100","required":false},"4c59246f-2ca6-46d3-abac-965851b765f5":{"name":"minAmount","in":"query","schema":{"type":"number","isRequired":false,"description":"Minimum amount of the deposit, default is 0.01","uniqueKey":"","typeLabel":"number"},"description":"Minimum amount of the deposit, default is 0.01","required":false}},"responses":{"f509dadd-079a-4c09-8d9d-61c2965d2378":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","uniqueKey":"count","typeLabel":"integer"},"deposits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"deposits.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"userId":{"type":"string","format":"uuid","uniqueKey":"deposits.items.[INDEX].userId","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"deposits.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"deposits.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"wallet":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"deposits.items.[INDEX].wallet.id","typeLabel":"string\u003cuuid>"},"address":{"type":"string","uniqueKey":"deposits.items.[INDEX].wallet.address","typeLabel":"string"},"chain":{"type":"string","enum":["POLYGON","SOLANA","ETHEREUM","BASE","TRON"],"uniqueKey":"deposits.items.[INDEX].wallet.chain","typeLabel":"enum\u003cstring>"},"walletType":{"type":"string","enum":["INDIVIDUAL"],"uniqueKey":"deposits.items.[INDEX].wallet.walletType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"deposits.items.[INDEX].wallet","typeLabel":"object"},"transaction":{"type":"object","properties":{"transactionHash":{"type":"string","uniqueKey":"deposits.items.[INDEX].transaction.transactionHash","typeLabel":"string"},"chain":{"type":"string","enum":["POLYGON","SOLANA","ETHEREUM","BASE","TRON"],"uniqueKey":"deposits.items.[INDEX].transaction.chain","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","uniqueKey":"deposits.items.[INDEX].transaction.currency","typeLabel":"string"},"status":{"type":"string","enum":["COMPLETED","CONFIRMED"],"uniqueKey":"deposits.items.[INDEX].transaction.status","typeLabel":"enum\u003cstring>"},"sourceAddress":{"type":"string","uniqueKey":"deposits.items.[INDEX].transaction.sourceAddress","typeLabel":"string"},"destinationAddress":{"type":"string","uniqueKey":"deposits.items.[INDEX].transaction.destinationAddress","typeLabel":"string"},"contractAddress":{"type":"string","uniqueKey":"deposits.items.[INDEX].transaction.contractAddress","typeLabel":"string"},"amount":{"type":"string","uniqueKey":"deposits.items.[INDEX].transaction.amount","typeLabel":"string"},"unitAmount":{"type":"string","uniqueKey":"deposits.items.[INDEX].transaction.unitAmount","typeLabel":"string"}},"uniqueKey":"deposits.items.[INDEX].transaction","typeLabel":"object"}},"uniqueKey":"deposits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"deposits","typeLabel":"object[]"},"nextCursor":{"type":"string","description":"The `createdAt` timestamp of the last record in the current page. Pass this as `createdBefore` in the next request to retrieve the next page of results.","uniqueKey":"nextCursor","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"WalletDepositObjectListExample":{"title":"WalletDepositObjectListExample","summary":"Wallet Deposit Object List","value":{"count":1,"records":[{"userId":"f4c99c2f-ce05-4f61-8ed6-9064a5689197","id":"2e084846-00d6-5e4c-806f-eac45e197108","createdAt":"2025-06-25T15:47:16.983978+00:00","updatedAt":"2025-06-25T15:47:16.983978+00:00","wallet":{"id":"24b4917d-694e-4d81-ace8-9ba5261b6f4e","address":"0x0B95D270400BE4319EAFbfDD82F6C38B59ab54Ef","chain":"POLYGON","walletType":"INDIVIDUAL"},"transaction":{"transactionHash":"0xe5284c4cb35ae9b5eb0ae23b840032f320b87b63f8967ee9b67ee09dfe6a194a","chain":"POLYGON","currency":"usdc","status":"COMPLETED","sourceAddress":"0x0B95D270400BE4319EAFbfDD82F6C38B59ab54Ef","destinationAddress":"0x0B95D270400BE4319EAFbfDD82F6C38B59ab54Ef","contractAddress":"0x41E94Eb019C0762f9Bfcf9Fb1E58725BfB0e7582","amount":"19","unitAmount":"19000000"}}],"nextCursor":"2025-06-25T15:47:16.983978+00:00"}}},"exampleType":"examples"}},"exampleType":"examples"},"9d1b977f-48c1-4487-aa99-5969d18877eb":{"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"},"12cf1f7b-6ecb-480f-a792-745084d04425":{"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/docs/introduction/welcome","matchLevel":4},"v2":{"href":"/api-reference/wallet/get-inbound-deposits","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T17:55:06.934Z","originalFileLocation":"api-reference/wallet/get-inbound-deposits.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=\"Get inbound deposits for a user\u0026#x27;s wallet\">\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/wallet/get-inbound-deposits\">\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=Wallets\u0026amp;title=Get+inbound+deposits\u0026amp;description=Get+inbound+deposits+for+a+user%27s+wallet\u0026amp;theme=445d8ece64587b97bc363e93\u0026amp;signature=c8479e63c550768c63a3fef63ebc332b778e226c5073a5a5d4c740f6ecd91cbd\">\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=Wallets\u0026amp;title=Get+inbound+deposits\u0026amp;description=Get+inbound+deposits+for+a+user%27s+wallet\u0026amp;theme=445d8ece64587b97bc363e93\u0026amp;signature=c8479e63c550768c63a3fef63ebc332b778e226c5073a5a5d4c740f6ecd91cbd\">\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/wallet/get-inbound-deposits\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/wallet/get-inbound-deposits.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/wallet/get-inbound-deposits#webpage\",\"url\":\"https://docs.hifi.com/api-reference/wallet/get-inbound-deposits\",\"name\":\"Get inbound deposits\",\"description\":\"Get inbound deposits for a user's wallet\",\"dateModified\":\"2026-10-27T17:55:06.934Z\",\"isPartOf\":{\"@id\":\"https://docs.hifi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hifi.com/api-reference/wallet/get-inbound-deposits#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hifi.com/api-reference/wallet/get-inbound-deposits#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.hifi.com/api-reference/common/ping\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Wallets\",\"item\":\"https://docs.hifi.com/api-reference/wallet/retrieve-wallet-balance\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get inbound deposits\",\"item\":\"https://docs.hifi.com/api-reference/wallet/get-inbound-deposits\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hifi.com/api-reference/wallet/get-inbound-deposits#apireference\",\"headline\":\"Get inbound deposits\",\"name\":\"Get inbound deposits\",\"description\":\"Get inbound deposits for a user's wallet\",\"url\":\"https://docs.hifi.com/api-reference/wallet/get-inbound-deposits\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hifi.com/api-reference/wallet/get-inbound-deposits#webpage\"},\"dateModified\":\"2026-10-27T17:55:06.934Z\",\"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/wallet/get-inbound-deposits.md","siteName":"HIFI Docs","nav":{"global":null,"versions":[{"version":"v3","tag":"Beta","pages":[{"title":"v3","href":"/v3/docs/introduction/welcome"}]},{"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","description":"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","description":"Get an inbound deposit for a user's wallet","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","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","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_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}