Blockchain transaction data, present on Crypto-backed transactions.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Onboard Business Documentation","colors":{"primary":"#5E1FEC","light":"#C6FF00","dark":"#530080"},"logo":{"light":"https://mintcdn.com/onboard-business-api/HDH9a6Pjug4DJUP-/logo/new-logo.svg?fit=max\u0026auto=format\u0026n=HDH9a6Pjug4DJUP-\u0026q=85\u0026s=d1c85d5b9605abcc9058bc7186e16415","dark":"https://mintcdn.com/onboard-business-api/HDH9a6Pjug4DJUP-/logo/new-logo.svg?fit=max\u0026auto=format\u0026n=HDH9a6Pjug4DJUP-\u0026q=85\u0026s=d1c85d5b9605abcc9058bc7186e16415"},"favicon":"https://mintcdn.com/onboard-business-api/XHh0yXLsmlnfh---/favicon.svg?fit=max\u0026auto=format\u0026n=XHh0yXLsmlnfh---\u0026q=85\u0026s=e73884ea99f298b23bc799ea6aac802c","api":{"openapi":"api-reference/openapi.yml"},"footer":{"socials":{"x":"https://x.com/OnboardGlobal","github":"https://github.com/OnboardGlobal"}},"seo":{"metatags":{"og:site_name":"Onboard Business","og:title":"Build cross-border payments with the Onboard API","og:description":"One API for stablecoin wallets, local-currency payouts, and account issuance. Documentation for fintechs and payment platforms moving money globally.","og:image":"/images/og-default.png","og:type":"website","twitter:card":"summary_large_image","twitter:site":"@OnboardGlobal","twitter:image":"/images/og-default.png"},"indexing":"all"},"contextual":{"options":["copy"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"onboard-business-api","hasAudioNarration":false,"actualSubdomain":"onboard-business-api","customDomains":["docs.onboard.xyz"],"gitSource":{"type":"github","owner":"nestcoinco","repo":"onboard-business-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae4b12e21d44d6b52dd3d17","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":53},{"language":"default","tag":"Guides","count":36},{"language":"default","tag":"Product Features","count":24},{"language":"default","tag":"Virtual Account","count":12},{"language":"default","tag":"Cash Payouts","count":10},{"language":"default","tag":"Cash Deposits","count":9},{"language":"default","tag":"Offramp Accounts","count":9},{"language":"default","tag":"Transaction Activities","count":7},{"language":"default","tag":"Use Cases","count":6},{"language":"default","tag":"Stablecoin Transactions","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/stablecoin/get-crypto-transfer","slug":"/api-reference/endpoints/stablecoin/get-crypto-transfer","pageMetadata":{"title":"Get Crypto Transfer","openapi":"GET /ledger/crypto-transfer/{transferReference}","description":"This operation allows the client to fetch a specific crypto transfer by its reference ID.\n","href":"/api-reference/endpoints/stablecoin/get-crypto-transfer"},"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: \"This operation allows the client to fetch a specific crypto transfer by its reference ID.\"\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{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Fetches the status of a crypto transfer by reference.`})}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 Crypto Transfer","openapi":"GET /ledger/crypto-transfer/{transferReference}","description":"This operation allows the client to fetch a specific crypto transfer by its reference ID.\n","href":"/api-reference/endpoints/stablecoin/get-crypto-transfer"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get crypto transfer by reference","description":"This operation allows the client to fetch a specific crypto transfer by its reference ID.\n","operationId":"getCryptoTransferByReference","x-visibility":"external","tags":["ledger-transfer"],"parameters":["aab0c0ca-c978-49ca-b009-701f33d5165b"],"responses":{"200":"8cd48ef3-ff71-4f01-96a1-3865d846c4d0","400":"2e4af5f5-5192-4bd1-90ea-156628a17075","401":"25b0983b-2a7b-4a82-854c-c4d076da464f","403":"249a4864-1ecd-4f56-a1e4-659b4508a7ad","404":"79b7cd91-047f-4fa2-8e6a-73fe168da878","default":"92eb4b86-325f-4c8c-8dda-72fe89a81e16"},"security":["6a4419e5-3652-4d02-a4b2-942005c442f9"],"method":"get","type":"path","servers":["f9ce9404-c09f-4cea-8fce-90e53805086c","dfd174e2-6344-4d18-8dc6-fdc59893e057"],"path":"/ledger/crypto-transfer/{transferReference}","baseUrlOptions":["https://business-api.onboard.xyz","https://external.dev.onboardpay.co"],"title":"Get crypto transfer by reference","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"aab0c0ca-c978-49ca-b009-701f33d5165b":{"in":"path","name":"transferReference","description":"The transfer unique ID","required":true,"schema":{"type":"string","isRequired":true,"description":"The transfer unique ID","uniqueKey":"","typeLabel":"string"}}},"responses":{"8cd48ef3-ff71-4f01-96a1-3865d846c4d0":{"description":"Crypto Transfer fetched successfully","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["id","reference","type","amount","currency","status","createdDate"],"properties":{"id":{"type":"string","description":"Unique transaction ID","example":"txn_123456","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"reference":{"type":"string","description":"Unique transaction reference.","example":"REF123456","isRequired":true,"uniqueKey":"reference","typeLabel":"string"},"type":{"type":"string","enum":["DEPOSIT","WITHDRAWAL","TRANSFER"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount, negative for debits, positive for credits","example":100,"isRequired":true,"uniqueKey":"amount","typeLabel":"number"},"currency":{"type":"string","description":"Transaction currency","example":"USD","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"status":{"type":"string","description":"Status of the transaction, indicating its current state in the processing lifecycle.\n- PENDING: The transaction has been created but not yet processed.\n- IN_PROGRESS: The transaction is currently being processed.\n- FAILED: The transaction processing has failed.\n- SUCCESS: The transaction has been successfully processed.\n","enum":["PENDING","IN_PROGRESS","FAILED","SUCCESS"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"createdDate":{"type":"string","format":"date-time","description":"Transaction creation date","isRequired":true,"uniqueKey":"createdDate","typeLabel":"string\u003cdate-time>"},"categoryTag":{"type":"string","description":"Category tag for the transaction","example":"crypto-withdrawal","uniqueKey":"categoryTag","typeLabel":"string"},"notes":{"type":"string","description":"Transaction description","example":"Conversion from USDC to IDR","uniqueKey":"notes","typeLabel":"string"},"accountId":{"type":"string","format":"uuid","description":"Associated account ID","uniqueKey":"accountId","typeLabel":"string\u003cuuid>"},"feeAmount":{"type":"number","description":"Fee amount associated with the transaction","example":1,"uniqueKey":"feeAmount","typeLabel":"number"},"feeInclusive":{"type":"boolean","description":"Indicates if the fee is inclusive in the transaction amount","uniqueKey":"feeInclusive","typeLabel":"boolean"},"subAccountId":{"type":"string","format":"uuid","description":"Associated sub-account ID, if applicable","uniqueKey":"subAccountId","typeLabel":"string\u003cuuid>"},"blockchainInfo":{"type":"object","description":"Blockchain transaction data, present on Crypto-backed transactions.","required":["txHash","recipient","value","tokenSymbol"],"properties":{"txHash":{"type":"string","description":"Blockchain Transaction Hash","example":"0x093a0b443d5f698d1097368c1c05fab1ee2304e508b36c08bb72c40389c17584","isRequired":true,"uniqueKey":"blockchainInfo.txHash","typeLabel":"string"},"recipient":{"type":"object","description":"Address data","required":["address"],"properties":{"address":{"type":"string","description":"Blockchain address where deposit was received.","example":"0x2b059a574a35e60b228d10d54fec2671de4928e1","isRequired":true,"uniqueKey":"blockchainInfo.recipient.address","typeLabel":"string"},"memo":{"type":"string","description":"Memo for blockchains where memo is required.","example":"1290122112","uniqueKey":"blockchainInfo.recipient.memo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"blockchainInfo.recipient","typeLabel":"object"},"value":{"type":"number","example":"100.01","minimum":0,"description":"Quantity of tokens transferred in the transaction.","default":"0.0","isRequired":true,"uniqueKey":"blockchainInfo.value","typeLabel":"number"},"tokenSymbol":{"example":"USDT","description":"Token symbol","type":"string","isRequired":true,"uniqueKey":"blockchainInfo.tokenSymbol","typeLabel":"string"},"senderAddress":{"type":"string","description":"The address of the sender.","example":"0x2b059a574a35e60b228d10d54fec2671de4928e1","uniqueKey":"blockchainInfo.senderAddress","typeLabel":"string"},"blockNumber":{"type":"integer","format":"int64","example":20564802,"uniqueKey":"blockchainInfo.blockNumber","typeLabel":"integer\u003cint64>"},"timestamp":{"type":"integer","format":"int64","description":"Transaction block timestamp.","uniqueKey":"blockchainInfo.timestamp","typeLabel":"integer\u003cint64>"},"explorerUrl":{"type":"string","format":"url","description":"URL to view the transaction on a blockchain explorer.","uniqueKey":"blockchainInfo.explorerUrl","typeLabel":"string\u003curl>"}},"x-source-svc":"ledger","uniqueKey":"blockchainInfo","typeLabel":"object"}},"x-source-svc":"ledger","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"txn_123456","reference":"REF123456","type":"DEPOSIT","amount":100,"currency":"USD","status":"PENDING","createdDate":"2023-11-07T05:31:56Z","categoryTag":"crypto-withdrawal","notes":"Conversion from USDC to IDR","accountId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","feeAmount":1,"feeInclusive":true,"subAccountId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","blockchainInfo":{"txHash":"0x093a0b443d5f698d1097368c1c05fab1ee2304e508b36c08bb72c40389c17584","recipient":{"address":"0x2b059a574a35e60b228d10d54fec2671de4928e1","memo":"1290122112"},"value":"100.01","tokenSymbol":"USDT","senderAddress":"0x2b059a574a35e60b228d10d54fec2671de4928e1","blockNumber":20564802,"timestamp":123,"explorerUrl":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"2e4af5f5-5192-4bd1-90ea-156628a17075":{"description":"Request could not be validated","content":{"application/json":{"schema":{"description":"Default error object for services. This gives consistent error object that all services may use.","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","example":"UNKNOWN_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Descriptive error message","example":"Request could not be completed due to an error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","description":"Additional data for this error message.","additionalProperties":true,"properties":{},"uniqueKey":"data","typeLabel":"object"}},"x-common-model":"ErrorMessageDto","uniqueKey":"","typeLabel":"object"},"example":{"code":"BAD_REQUEST","message":"Request could not be validated."},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST","message":"Request could not be validated."}}},"exampleType":"examples"}},"exampleType":"examples"},"25b0983b-2a7b-4a82-854c-c4d076da464f":{"description":"Client is not authorized to make request","content":{"application/json":{"schema":{"description":"Default error object for services. This gives consistent error object that all services may use.","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","example":"UNKNOWN_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Descriptive error message","example":"Request could not be completed due to an error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","description":"Additional data for this error message.","additionalProperties":true,"properties":{},"uniqueKey":"data","typeLabel":"object"}},"x-common-model":"ErrorMessageDto","uniqueKey":"","typeLabel":"object"},"example":{"code":"UNAUTHORIZED","message":"Either client security header is missing or it is not valid."},"examples":{"Example":{"title":"Example","value":{"code":"UNAUTHORIZED","message":"Either client security header is missing or it is not valid."}}},"exampleType":"examples"}},"exampleType":"examples"},"249a4864-1ecd-4f56-a1e4-659b4508a7ad":{"description":"Expected permission is not available.","content":{"application/json":{"schema":{"description":"Default error object for services. This gives consistent error object that all services may use.","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","example":"UNKNOWN_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Descriptive error message","example":"Request could not be completed due to an error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","description":"Additional data for this error message.","additionalProperties":true,"properties":{},"uniqueKey":"data","typeLabel":"object"}},"x-common-model":"ErrorMessageDto","uniqueKey":"","typeLabel":"object"},"example":{"code":"ACCESS_DENIED","message":"Expected permission or scope is not present."},"examples":{"Example":{"title":"Example","value":{"code":"ACCESS_DENIED","message":"Expected permission or scope is not present."}}},"exampleType":"examples"}},"exampleType":"examples"},"79b7cd91-047f-4fa2-8e6a-73fe168da878":{"description":"Entity was not found","content":{"application/json":{"schema":{"description":"Default error object for services. This gives consistent error object that all services may use.","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","example":"UNKNOWN_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Descriptive error message","example":"Request could not be completed due to an error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","description":"Additional data for this error message.","additionalProperties":true,"properties":{},"uniqueKey":"data","typeLabel":"object"}},"x-common-model":"ErrorMessageDto","uniqueKey":"","typeLabel":"object"},"example":{"code":"NOT_FOUND","message":"Information could not be found"},"examples":{"Example":{"title":"Example","value":{"code":"NOT_FOUND","message":"Information could not be found"}}},"exampleType":"examples"}},"exampleType":"examples"},"92eb4b86-325f-4c8c-8dda-72fe89a81e16":{"description":"Internal Server Error","content":{"application/json":{"schema":{"description":"Default error object for services. This gives consistent error object that all services may use.","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","example":"UNKNOWN_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Descriptive error message","example":"Request could not be completed due to an error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","description":"Additional data for this error message.","additionalProperties":true,"properties":{},"uniqueKey":"data","typeLabel":"object"}},"x-common-model":"ErrorMessageDto","uniqueKey":"","typeLabel":"object"},"example":{"code":"INTERNAL_ERROR","message":"An internal server error occurred."},"examples":{"Example":{"title":"Example","value":{"code":"INTERNAL_ERROR","message":"An internal server error occurred."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6a4419e5-3652-4d02-a4b2-942005c442f9":{"HMACAuth":{"type":"apiKey","name":"x-api-key","in":"header","description":"Requires authentication via API key and HMAC signature.\n * `x-api-key`: Your API key generated from your Onboard Business dashboard.\n * `x-timestamp`: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds\n * `x-signature`: SHA256 HMAC HEX signature calculated over `t={x-timestamp}\u0026{requestBody}` using your API Secret.","scopes":[],"schemeName":"HMACAuth"}}},"servers":{"f9ce9404-c09f-4cea-8fce-90e53805086c":{"url":"https://business-api.onboard.xyz","description":"Production gateway."},"dfd174e2-6344-4d18-8dc6-fdc59893e057":{"url":"https://external.dev.onboardpay.co","description":"Sandbox gateway — use for integration and testing."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","description":"Requires authentication via API key and HMAC signature.\n * `x-api-key`: Your API key generated from your Onboard Business dashboard.\n * `x-timestamp`: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds\n * `x-signature`: SHA256 HMAC HEX signature calculated over `t={x-timestamp}\u0026{requestBody}` using your API Secret.","scopes":[],"schemeName":"HMACAuth"},"schema":{"title":"x-api-key","type":"string","description":"Requires authentication via API key and HMAC signature.\n * `x-api-key`: Your API key generated from your Onboard Business dashboard.\n * `x-timestamp`: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds\n * `x-signature`: SHA256 HMAC HEX signature calculated over `t={x-timestamp}\u0026{requestBody}` using your API Secret.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"HMACAuth","name":"x-api-key"}],"title":"HMACAuth"}]},"originalFileLocation":"api-reference/openapi.yml"},"subdomain":"onboard-business-api","siteName":"Onboard Business Documentation","title":"Build cross-border payments with the Onboard API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-24T16:00:25.363Z","originalFileLocation":"api-reference/endpoints/stablecoin/get-crypto-transfer.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=\"This operation allows the client to fetch a specific crypto transfer by its reference ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Onboard Business Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Build cross-border payments with the Onboard API\">\u003cmeta data-mint-head property=\"og:description\" content=\"One API for stablecoin wallets, local-currency payouts, and account issuance. Documentation for fintechs and payment platforms moving money globally.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Onboard Business\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://onboard-business-api.mintlify.site/images/og-default.png\">\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=\"Build cross-border payments with the Onboard API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One API for stablecoin wallets, local-currency payouts, and account issuance. Documentation for fintechs and payment platforms moving money globally.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://onboard-business-api.mintlify.site/images/og-default.png\">\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/onboard-business-api/Fp5J2j_fqFPeMrmS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Onboard Business Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5E1FEC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/stablecoin/get-crypto-transfer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.onboard.xyz/#organization\",\"name\":\"Onboard Business Documentation\",\"url\":\"https://docs.onboard.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/onboard-business-api/HDH9a6Pjug4DJUP-/logo/new-logo.svg?fit=max\u0026auto=format\u0026n=HDH9a6Pjug4DJUP-\u0026q=85\u0026s=d1c85d5b9605abcc9058bc7186e16415\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.onboard.xyz#website\",\"name\":\"Onboard Business Documentation\",\"url\":\"https://docs.onboard.xyz\",\"publisher\":{\"@id\":\"https://docs.onboard.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer#webpage\",\"url\":\"https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer\",\"name\":\"Get Crypto Transfer\",\"description\":\"This operation allows the client to fetch a specific crypto transfer by its reference ID.\",\"dateModified\":\"2026-07-24T16:00:25.363Z\",\"isPartOf\":{\"@id\":\"https://docs.onboard.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Stablecoin Deposits \u0026 Withdrawal\",\"item\":\"https://docs.onboard.xyz/api-reference/endpoints/offramp-accounts/get-funding-address\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Crypto Transfer\",\"item\":\"https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer#apireference\",\"headline\":\"Get Crypto Transfer\",\"name\":\"Get Crypto Transfer\",\"description\":\"This operation allows the client to fetch a specific crypto transfer by its reference ID.\",\"url\":\"https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/stablecoin/get-crypto-transfer#webpage\"},\"image\":\"https://docs.onboard.xyz/images/og-default.png\",\"dateModified\":\"2026-07-24T16:00:25.363Z\",\"publisher\":{\"@id\":\"https://docs.onboard.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.onboard.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Onboard Business Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Onboard Business Documentation","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/getting-started/overview"}]},{"tab":"API Reference","groups":[{"group":"Authentication","pages":[{"title":"Base URLs","href":"/api-reference/base-urls"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Webhook Verification","href":"/api-reference/webhook-verification"}]},{"group":"Info","pages":[{"title":"Get API Info","openapi":"GET /exchange/api/info","href":"/api-reference/endpoints/info/get-api-info"},{"title":"Get Currency Assets","openapi":"GET /ledger/currency/assets","href":"/api-reference/endpoints/info/get-currency-assets"},{"title":"Get Network Tokens","openapi":"GET /ledger/assets/{assetCode}/network-tokens","href":"/api-reference/endpoints/info/get-network-tokens"}]},{"group":"Virtual Account","pages":[{"title":"List Accounts","openapi":"GET /ledger/accounts","href":"/api-reference/endpoints/virtual-account/get-accounts"},{"title":"Get Account by ID","openapi":"GET /ledger/accounts/{accountId}","href":"/api-reference/endpoints/virtual-account/get-account-by-id"},{"title":"List Sub-accounts","openapi":"GET /ledger/subaccounts","href":"/api-reference/endpoints/virtual-account/get-subaccounts"},{"title":"Create Sub-account","openapi":"POST /ledger/subaccounts","href":"/api-reference/endpoints/virtual-account/create-subaccount"},{"title":"Get Sub-account by Reference","openapi":"GET /ledger/subaccounts/{subAccountIdRef}","href":"/api-reference/endpoints/virtual-account/get-subaccount-by-ref"},{"title":"Update Sub-account","openapi":"PUT /ledger/subaccounts/{subAccountIdRef}","href":"/api-reference/endpoints/virtual-account/update-subaccount"},{"title":"Delete Sub-account","openapi":"DELETE /ledger/subaccounts/{subAccountIdRef}","href":"/api-reference/endpoints/virtual-account/delete-subaccount"}]},{"group":"Virtual Account Number","pages":[{"title":"Get Account Number Details","openapi":"GET /ledger/accounts/{accountId}/account-details","href":"/api-reference/endpoints/virtual-account-number/get-account-details"},{"title":"Generate Account Number","openapi":"POST /ledger/accounts/{accountId}/account-details","href":"/api-reference/endpoints/virtual-account-number/create-account-details"},{"title":"Get Sub-account Number Details","openapi":"GET /ledger/subaccounts/{subAccountIdRef}/account-details","href":"/api-reference/endpoints/virtual-account-number/get-subaccount-details"},{"title":"Generate Sub-account Number","openapi":"POST /ledger/subaccounts/{subAccountIdRef}/account-details","href":"/api-reference/endpoints/virtual-account-number/create-subaccount-details"}]},{"group":"Stablecoin Deposits \u0026 Withdrawal","pages":[{"title":"Get Offramp Account Funding Address","openapi":"GET /ledger/offramp-accounts/{id}/funding-address","href":"/api-reference/endpoints/offramp-accounts/get-funding-address"},{"title":"Get Sub-account Funding Address","openapi":"GET /ledger/subaccounts/{subAccountIdRef}/funding-address","href":"/api-reference/endpoints/stablecoin/get-subaccount-funding-address"},{"title":"Generate Sub-account Funding Address","openapi":"POST /ledger/subaccounts/{subAccountIdRef}/funding-address","href":"/api-reference/endpoints/stablecoin/create-subaccount-funding-address"},{"title":"Initiate Crypto Transfer","openapi":"POST /ledger/crypto-transfer","description":"This operation allow the client to perform crypto transfer to an external wallet.\n\nN.B. The amount field is the withdrawal amount only (fees are not included). The applicable\nfee, including any platform fee, is computed server-side and is not a client-supplied input.\n","href":"/api-reference/endpoints/stablecoin/create-crypto-transfer"},{"title":"Get Crypto Transfer","openapi":"GET /ledger/crypto-transfer/{transferReference}","href":"/api-reference/endpoints/stablecoin/get-crypto-transfer"}]},{"group":"Crypto Beneficiaries","pages":[{"title":"List Crypto Beneficiaries","openapi":"GET /ledger/crypto-beneficiaries","description":"This operation allows the client to fetch all beneficiary by accounts\n","href":"/api-reference/endpoints/crypto-beneficiaries/list"},{"title":"Create Crypto Beneficiary","openapi":"POST /ledger/crypto-beneficiaries","href":"/api-reference/endpoints/crypto-beneficiaries/create"},{"title":"Get Crypto Beneficiary","openapi":"GET /ledger/crypto-beneficiaries/{beneficiaryId}","href":"/api-reference/endpoints/crypto-beneficiaries/get-by-id"},{"title":"Delete Crypto Beneficiary","openapi":"DELETE /ledger/crypto-beneficiaries/{beneficiaryId}","href":"/api-reference/endpoints/crypto-beneficiaries/delete"}]},{"group":"Fiat Beneficiaries","pages":[{"title":"List Fiat Beneficiaries","openapi":"GET /ledger/fiat-beneficiaries","href":"/api-reference/endpoints/fiat-beneficiaries/list"},{"title":"Create Fiat Beneficiary","openapi":"POST /ledger/fiat-beneficiaries","href":"/api-reference/endpoints/fiat-beneficiaries/create"},{"title":"Get Fiat Beneficiary","openapi":"GET /ledger/fiat-beneficiaries/{beneficiaryId}","href":"/api-reference/endpoints/fiat-beneficiaries/get-by-id"},{"title":"Delete Fiat Beneficiary","openapi":"DELETE /ledger/fiat-beneficiaries/{beneficiaryId}","href":"/api-reference/endpoints/fiat-beneficiaries/delete"}]},{"group":"Cash Deposits","pages":[{"title":"Get Cash Deposit Currencies","openapi":"GET /ledger/cash-deposits/currencies","href":"/api-reference/endpoints/cash-deposits/get-currencies"},{"title":"Get Cash Deposit Rates","openapi":"GET /ledger/cash-deposits/rates","href":"/api-reference/endpoints/cash-deposits/get-rates"},{"title":"Create Cash Deposit Quote","openapi":"POST /ledger/cash-deposits/quotes","href":"/api-reference/endpoints/cash-deposits/create-quote"},{"title":"Create Cash Deposit","openapi":"POST /ledger/cash-deposits","href":"/api-reference/endpoints/cash-deposits/create-deposit"},{"title":"Get Cash Deposit","openapi":"GET /ledger/cash-deposits/{reference}","href":"/api-reference/endpoints/cash-deposits/get-by-reference"},{"title":"List Cash Deposits","openapi":"GET /ledger/cash-deposits","href":"/api-reference/endpoints/cash-deposits/list"}]},{"group":"Cash Payouts","pages":[{"title":"Get Cash Payout Currencies","openapi":"GET /ledger/cash-payments/currencies","href":"/api-reference/endpoints/cash-payouts/get-currencies"},{"title":"Get Cash Payout Rates","openapi":"GET /ledger/cash-payments/rates","href":"/api-reference/endpoints/cash-payouts/get-rates"},{"title":"Create Cash Payout Quote","openapi":"POST /ledger/cash-payments/quotes","href":"/api-reference/endpoints/cash-payouts/create-quote"},{"title":"List Cash Payouts","openapi":"GET /ledger/cash-payments","href":"/api-reference/endpoints/cash-payouts/list"},{"title":"Create Cash Payout","openapi":"POST /ledger/cash-payments","href":"/api-reference/endpoints/cash-payouts/create-payout"},{"title":"Get Cash Payout","openapi":"GET /ledger/cash-payments/{reference}","href":"/api-reference/endpoints/cash-payouts/get-by-reference"}]},{"group":"Offramp Accounts","pages":[{"title":"List Offramp Accounts","openapi":"GET /ledger/offramp-accounts","href":"/api-reference/endpoints/offramp-accounts/list"},{"title":"Create Offramp Account","openapi":"POST /ledger/offramp-accounts","href":"/api-reference/endpoints/offramp-accounts/create"},{"title":"Get Offramp Account","openapi":"GET /ledger/offramp-accounts/{offrampAccountId}","href":"/api-reference/endpoints/offramp-accounts/get-by-id"},{"title":"Delete Offramp Account","openapi":"DELETE /ledger/offramp-accounts/{offrampAccountId}","href":"/api-reference/endpoints/offramp-accounts/delete"},{"title":"Get Offramp Account Funding Address","openapi":"GET /ledger/offramp-accounts/{id}/funding-address","href":"/api-reference/endpoints/offramp-accounts/get-funding-address"},{"title":"Get Offramp Account Transactions","openapi":"GET /ledger/offramp-accounts/{id}/transactions","href":"/api-reference/endpoints/offramp-accounts/get-transactions"}]},{"group":"Transaction Activities","pages":[{"title":"List Account Activities","openapi":"GET /ledger/accounts/{accountId}/activities","href":"/api-reference/endpoints/transaction-activities/account-activities"},{"title":"Get Account Activity","openapi":"GET /ledger/accounts/{accountId}/activities/{activityId}","href":"/api-reference/endpoints/transaction-activities/account-activity-by-id"},{"title":"List Sub-account Activities","openapi":"GET /ledger/subaccounts/{subAccountIdRef}/activities","href":"/api-reference/endpoints/transaction-activities/subaccount-activities"},{"title":"Get Sub-account Activity","openapi":"GET /ledger/subaccounts/{subAccountIdRef}/activities/{activityId}","href":"/api-reference/endpoints/transaction-activities/subaccount-activity-by-id"},{"title":"List All Transaction Activities","openapi":"GET /ledger/transaction-activities","href":"/api-reference/endpoints/transaction-activities/list-all"}]},{"group":"WebHook Events","pages":[{"title":"WebHook Events","href":"/api-reference/webhook-events"}]}]}]},"basePath":"","title":"Build cross-border payments with the Onboard API","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}