Destination account details the customer must pay into to fund the deposit. Mirrors a Beneficiary
(without an id). Carries only the account details needed to make the payment; transaction context
(amount, status, etc.) lives on the enclosing CashDepositTransaction.
details can be nullable when the account number provider is still generating it
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/cash-deposits/create-deposit","slug":"/api-reference/endpoints/cash-deposits/create-deposit","pageMetadata":{"title":"Create Cash Deposit","openapi":"POST /ledger/cash-deposits","description":"Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.","href":"/api-reference/endpoints/cash-deposits/create-deposit"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.\"\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:`Creates a disposable cash deposit account for a single transaction.`})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Cash Deposit","openapi":"POST /ledger/cash-deposits","description":"Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.","href":"/api-reference/endpoints/cash-deposits/create-deposit"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create cash deposit","description":"Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.","operationId":"createCashDeposit","x-visibility":"external","tags":["ledger-cash deposits"],"requestBody":"ce785f3f-05f3-457c-8b29-f38fb1d99680","responses":{"200":"d06c3a71-e46a-4c95-a15d-441edb3d8fb7","400":"65e9051e-a6c6-4bb3-bc0e-40233c225e60","401":"a22cb056-be88-45ed-966b-b6de4798f703"},"security":["16034ed4-70e8-4fef-8507-1c6354dbcfbf"],"method":"post","type":"path","servers":["f9ce9404-c09f-4cea-8fce-90e53805086c","dfd174e2-6344-4d18-8dc6-fdc59893e057"],"path":"/ledger/cash-deposits","baseUrlOptions":["https://business-api.onboard.xyz","https://external.dev.onboardpay.co"],"title":"Create cash deposit","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Details required to create a cash deposit. The amount and currency must align with an existing quote.","required":["quoteId","accountId","amount","reference"],"properties":{"quoteId":{"type":"string","format":"uuid","description":"Identifier of an existing cash deposit quote, retrieved from the cash deposit quote endpoint.","isRequired":true,"uniqueKey":"quoteId","typeLabel":"string\u003cuuid>"},"accountId":{"type":"string","format":"uuid","description":"Account to credit for this deposit. Can be the main account ID or a sub-account ID.","isRequired":true,"uniqueKey":"accountId","typeLabel":"string\u003cuuid>"},"reference":{"type":"string","description":"Alpha-numeric deposit reference, unique for this deposit.","example":"CTR123456","pattern":"^[a-zA-Z0-9_-]{8,48}$","minLength":8,"maxLength":48,"isRequired":true,"uniqueKey":"reference","typeLabel":"string"},"amount":{"type":"number","minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"amount","typeLabel":"number"},"unitCurrency":{"type":"string","description":"Should be same as one of pay-in or account currencies in the quote.\nDefaults to account currency if not provided.\n","uniqueKey":"unitCurrency","typeLabel":"string"},"senderInfo":{"type":"object","description":"Identifies the party sending fiat for the deposit. When omitted on a deposit request, it is constructed from the business details.","required":["firstName","lastName","email"],"properties":{"firstName":{"type":"string","isRequired":true,"uniqueKey":"senderInfo.firstName","typeLabel":"string"},"lastName":{"type":"string","isRequired":true,"uniqueKey":"senderInfo.lastName","typeLabel":"string"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"senderInfo.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"type":"string","pattern":"^\\+[1-9][0-9]{0,3}[0-9]{7,14}$","uniqueKey":"senderInfo.phoneNumber","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"senderInfo","typeLabel":"object"},"narration":{"type":"string","description":"Notes to be included with the deposit.","uniqueKey":"narration","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"quoteId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","accountId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","reference":"CTR123456","amount":1,"unitCurrency":"\u003cstring>","narration":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d06c3a71-e46a-4c95-a15d-441edb3d8fb7":{"description":"Cash deposit created","content":{"application/json":{"schema":{"type":"object","description":"Details of a cash deposit transaction.","required":["id","reference","currency","status","payinCurrency","amount","rate","payinAmount","createdDate"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"reference":{"type":"string","description":"Reference for the cash deposit transaction at initiation.","isRequired":true,"uniqueKey":"reference","typeLabel":"string"},"currency":{"type":"string","description":"Currency in which the account was credited.","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>"},"payinCurrency":{"type":"string","description":"Currency the customer paid in.","example":"NGN","isRequired":true,"uniqueKey":"payinCurrency","typeLabel":"string"},"amount":{"type":"number","description":"Amount credited to the account.","example":100,"isRequired":true,"uniqueKey":"amount","typeLabel":"number"},"rate":{"type":"number","description":"Exchange rate applied for this deposit.","example":1450.75,"isRequired":true,"uniqueKey":"rate","typeLabel":"number"},"payinAmount":{"type":"number","description":"Amount the customer paid in, in the pay-in currency.","example":145075,"isRequired":true,"uniqueKey":"payinAmount","typeLabel":"number"},"createdDate":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdDate","typeLabel":"string\u003cdate-time>"},"accountTransactionId":{"type":"string","description":"Identifier of the credit transaction on the account.","uniqueKey":"accountTransactionId","typeLabel":"string"},"providerReference":{"type":"string","description":"Reference provided by the cash deposit provider.","example":"PROV123456","uniqueKey":"providerReference","typeLabel":"string"},"paymentDetails":{"type":"object","description":"Destination account details the customer must pay into to fund the deposit. Mirrors a Beneficiary\n(without an id). Carries only the account details needed to make the payment; transaction context\n(amount, status, etc.) lives on the enclosing CashDepositTransaction.\n\n`details` can be nullable when the account number provider is still generating it\n","required":["payinCurrency"],"properties":{"payinCurrency":{"type":"string","description":"Currency the destination account accepts for the deposit.","example":"NGN","isRequired":true,"uniqueKey":"paymentDetails.payinCurrency","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Details for local bank accounts","required":["accountInfoType","accountName","accountNumber","bankCode"],"x-source-svc":"ledger","properties":{"bankCode":{"description":"Beneficiary bank code","type":"string","minLength":3,"maxLength":12,"isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.0.bankCode","typeLabel":"string"},"accountInfoType":{"type":"string","pattern":"^Cash(LocalBank|SepaBank|ACHBank|SwiftBank|MobileWallet|MultiRailBank)Account$","description":"Used to determine the exact schema type.\nAllowed values:\n- CashLocalBankAccount\n- CashSepaBankAccount\n- CashACHBankAccount\n- CashSwiftBankAccount\n- CashMobileWalletAccount\n- CashMultiRailBankAccount\n","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.0.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.0.accountName","typeLabel":"string"},"accountNumber":{"type":"string","description":"The destination account identifier. For mobile money this is the phone number, for P2P wallet the account ID.\nWhere routing number or sort code is present, this would be `{routingNumber}-{accountNumber}`.\n","example":"230101010","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.0.accountNumber","typeLabel":"string"},"bankName":{"description":"Beneficiary bank name","type":"string","uniqueKey":"paymentDetails.details.oneOf.0.bankName","typeLabel":"string"},"bankAddress":{"required":["city","country","postalCode","state","streetAddress"],"type":"object","properties":{"streetAddress":{"minLength":3,"type":"string","description":"the street address of the user","example":"11 Main Street","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.0.bankAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.0.bankAddress.city","typeLabel":"string"},"state":{"minLength":3,"type":"string","description":"the state/region/province where the user lives","example":"Lagos","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.0.bankAddress.state","typeLabel":"string"},"country":{"maxLength":2,"minLength":2,"type":"string","description":"the country ISO CODE 3166-2 where the user lives","example":"NG","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.0.bankAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.0.bankAddress.postalCode","typeLabel":"string"},"apartmentNo":{"minLength":1,"type":"string","description":"the flat/apartment number of the user at the specified address","example":"5B","uniqueKey":"paymentDetails.details.oneOf.0.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"paymentDetails.details.oneOf.0.bankAddress","typeLabel":"object"},"reference":{"type":"string","description":"Reference the customer must include with the deposit so the pay-in is auto-matched.\nOptional — some providers do not require one.\n","example":"PROV123456","uniqueKey":"paymentDetails.details.oneOf.0.reference","typeLabel":"string"}},"uniqueKey":"paymentDetails.details.oneOf.0","typeLabel":"object"},{"type":"object","description":"Details for SEPA accounts","required":["accountInfoType","accountName","accountNumber","country"],"x-source-svc":"ledger","properties":{"country":{"description":"Beneficiary country ISO code","type":"string","minLength":2,"maxLength":2,"isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.1.country","typeLabel":"string"},"accountInfoType":{"type":"string","pattern":"^Cash(LocalBank|SepaBank|ACHBank|SwiftBank|MobileWallet|MultiRailBank)Account$","description":"Used to determine the exact schema type.\nAllowed values:\n- CashLocalBankAccount\n- CashSepaBankAccount\n- CashACHBankAccount\n- CashSwiftBankAccount\n- CashMobileWalletAccount\n- CashMultiRailBankAccount\n","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.1.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.1.accountName","typeLabel":"string"},"accountNumber":{"type":"string","description":"The destination account identifier. For mobile money this is the phone number, for P2P wallet the account ID.\nWhere routing number or sort code is present, this would be `{routingNumber}-{accountNumber}`.\n","example":"230101010","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.1.accountNumber","typeLabel":"string"},"bic":{"description":"Providing a BIC alongside the IBAN is optional for regular SEPA transfers. \nBanks are required by SEPA to automatically derive the BIC from the IBAN. \nYou must still provide the BIC if the SEPA-participating country does not use the euro (e.g., Switzerland, Monaco, or San Marino).\n","type":"string","uniqueKey":"paymentDetails.details.oneOf.1.bic","typeLabel":"string"},"bankName":{"description":"Beneficiary bank name","type":"string","uniqueKey":"paymentDetails.details.oneOf.1.bankName","typeLabel":"string"},"bankAddress":{"required":["city","country","postalCode","state","streetAddress"],"type":"object","properties":{"streetAddress":{"minLength":3,"type":"string","description":"the street address of the user","example":"11 Main Street","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.1.bankAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.1.bankAddress.city","typeLabel":"string"},"state":{"minLength":3,"type":"string","description":"the state/region/province where the user lives","example":"Lagos","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.1.bankAddress.state","typeLabel":"string"},"country":{"maxLength":2,"minLength":2,"type":"string","description":"the country ISO CODE 3166-2 where the user lives","example":"NG","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.1.bankAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.1.bankAddress.postalCode","typeLabel":"string"},"apartmentNo":{"minLength":1,"type":"string","description":"the flat/apartment number of the user at the specified address","example":"5B","uniqueKey":"paymentDetails.details.oneOf.1.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"paymentDetails.details.oneOf.1.bankAddress","typeLabel":"object"},"reference":{"type":"string","description":"Reference the customer must include with the deposit so the pay-in is auto-matched.\nOptional — some providers do not require one.\n","example":"PROV123456","uniqueKey":"paymentDetails.details.oneOf.1.reference","typeLabel":"string"}},"uniqueKey":"paymentDetails.details.oneOf.1","typeLabel":"object"},{"type":"object","description":"Bank details needed for ACH payments","required":["accountInfoType","accountName","accountNumber","recipientAddress","bankAddress","routingNumber","bankName"],"x-source-svc":"ledger","properties":{"routingNumber":{"type":"string","minLength":9,"maxLength":9,"pattern":"^\\d{9}$","example":"021000021","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.routingNumber","typeLabel":"string"},"recipientAddress":{"required":["city","country","postalCode","state","streetAddress"],"type":"object","properties":{"streetAddress":{"minLength":3,"type":"string","description":"the street address of the user","example":"11 Main Street","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.recipientAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.recipientAddress.city","typeLabel":"string"},"state":{"minLength":3,"type":"string","description":"the state/region/province where the user lives","example":"Lagos","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.recipientAddress.state","typeLabel":"string"},"country":{"maxLength":2,"minLength":2,"type":"string","description":"the country ISO CODE 3166-2 where the user lives","example":"NG","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.recipientAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.recipientAddress.postalCode","typeLabel":"string"},"apartmentNo":{"minLength":1,"type":"string","description":"the flat/apartment number of the user at the specified address","example":"5B","uniqueKey":"paymentDetails.details.oneOf.2.recipientAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.recipientAddress","typeLabel":"object"},"bankAddress":{"required":["city","country","postalCode","state","streetAddress"],"type":"object","properties":{"streetAddress":{"minLength":3,"type":"string","description":"the street address of the user","example":"11 Main Street","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.bankAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.bankAddress.city","typeLabel":"string"},"state":{"minLength":3,"type":"string","description":"the state/region/province where the user lives","example":"Lagos","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.bankAddress.state","typeLabel":"string"},"country":{"maxLength":2,"minLength":2,"type":"string","description":"the country ISO CODE 3166-2 where the user lives","example":"NG","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.bankAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.bankAddress.postalCode","typeLabel":"string"},"apartmentNo":{"minLength":1,"type":"string","description":"the flat/apartment number of the user at the specified address","example":"5B","uniqueKey":"paymentDetails.details.oneOf.2.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.bankAddress","typeLabel":"object"},"bankName":{"description":"Beneficiary bank name","type":"string","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.bankName","typeLabel":"string"},"accountInfoType":{"type":"string","pattern":"^Cash(LocalBank|SepaBank|ACHBank|SwiftBank|MobileWallet|MultiRailBank)Account$","description":"Used to determine the exact schema type.\nAllowed values:\n- CashLocalBankAccount\n- CashSepaBankAccount\n- CashACHBankAccount\n- CashSwiftBankAccount\n- CashMobileWalletAccount\n- CashMultiRailBankAccount\n","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.accountName","typeLabel":"string"},"accountNumber":{"type":"string","description":"The destination account identifier. For mobile money this is the phone number, for P2P wallet the account ID.\nWhere routing number or sort code is present, this would be `{routingNumber}-{accountNumber}`.\n","example":"230101010","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.2.accountNumber","typeLabel":"string"},"accountType":{"type":"string","description":"The account type","example":"CHECKING","enum":["CHECKING","SAVINGS"],"x-source-svc":"ledger","uniqueKey":"paymentDetails.details.oneOf.2.accountType","typeLabel":"enum\u003cstring>"},"reference":{"type":"string","description":"Reference the customer must include with the deposit so the pay-in is auto-matched.\nOptional — some providers do not require one.\n","example":"PROV123456","uniqueKey":"paymentDetails.details.oneOf.2.reference","typeLabel":"string"}},"uniqueKey":"paymentDetails.details.oneOf.2","typeLabel":"object"},{"type":"object","description":"Bank details needed for SWIFT","required":["accountInfoType","accountName","accountNumber","recipientAddress","bankAddress","bankName","bic"],"x-source-svc":"ledger","properties":{"recipientAddress":{"required":["city","country","postalCode","state","streetAddress"],"type":"object","properties":{"streetAddress":{"minLength":3,"type":"string","description":"the street address of the user","example":"11 Main Street","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.recipientAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.recipientAddress.city","typeLabel":"string"},"state":{"minLength":3,"type":"string","description":"the state/region/province where the user lives","example":"Lagos","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.recipientAddress.state","typeLabel":"string"},"country":{"maxLength":2,"minLength":2,"type":"string","description":"the country ISO CODE 3166-2 where the user lives","example":"NG","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.recipientAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.recipientAddress.postalCode","typeLabel":"string"},"apartmentNo":{"minLength":1,"type":"string","description":"the flat/apartment number of the user at the specified address","example":"5B","uniqueKey":"paymentDetails.details.oneOf.3.recipientAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.recipientAddress","typeLabel":"object"},"bankAddress":{"required":["city","country","postalCode","state","streetAddress"],"type":"object","properties":{"streetAddress":{"minLength":3,"type":"string","description":"the street address of the user","example":"11 Main Street","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.bankAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.bankAddress.city","typeLabel":"string"},"state":{"minLength":3,"type":"string","description":"the state/region/province where the user lives","example":"Lagos","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.bankAddress.state","typeLabel":"string"},"country":{"maxLength":2,"minLength":2,"type":"string","description":"the country ISO CODE 3166-2 where the user lives","example":"NG","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.bankAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.bankAddress.postalCode","typeLabel":"string"},"apartmentNo":{"minLength":1,"type":"string","description":"the flat/apartment number of the user at the specified address","example":"5B","uniqueKey":"paymentDetails.details.oneOf.3.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.bankAddress","typeLabel":"object"},"bankName":{"description":"Beneficiary bank name","type":"string","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.bankName","typeLabel":"string"},"bic":{"description":"Beneficiary BIC, might be called SWIFT code","type":"string","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.bic","typeLabel":"string"},"accountInfoType":{"type":"string","pattern":"^Cash(LocalBank|SepaBank|ACHBank|SwiftBank|MobileWallet|MultiRailBank)Account$","description":"Used to determine the exact schema type.\nAllowed values:\n- CashLocalBankAccount\n- CashSepaBankAccount\n- CashACHBankAccount\n- CashSwiftBankAccount\n- CashMobileWalletAccount\n- CashMultiRailBankAccount\n","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.accountName","typeLabel":"string"},"accountNumber":{"type":"string","description":"The destination account identifier. For mobile money this is the phone number, for P2P wallet the account ID.\nWhere routing number or sort code is present, this would be `{routingNumber}-{accountNumber}`.\n","example":"230101010","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.3.accountNumber","typeLabel":"string"},"routingNumber":{"type":"string","minLength":9,"maxLength":9,"pattern":"^\\d{9}$","example":"021000021","uniqueKey":"paymentDetails.details.oneOf.3.routingNumber","typeLabel":"string"},"reference":{"type":"string","description":"Reference the customer must include with the deposit so the pay-in is auto-matched.\nOptional — some providers do not require one.\n","example":"PROV123456","uniqueKey":"paymentDetails.details.oneOf.3.reference","typeLabel":"string"}},"uniqueKey":"paymentDetails.details.oneOf.3","typeLabel":"object"},{"type":"object","description":"Details needed for mobile money payments","required":["accountInfoType","accountName","accountNumber"],"x-source-svc":"ledger","properties":{"accountNumber":{"type":"string","description":"The destination account identifier. For mobile money this is the phone number, for P2P wallet the account ID.\nWhere routing number or sort code is present, this would be `{routingNumber}-{accountNumber}`.\n","example":"230101010","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.4.accountNumber","typeLabel":"string"},"accountInfoType":{"type":"string","pattern":"^Cash(LocalBank|SepaBank|ACHBank|SwiftBank|MobileWallet|MultiRailBank)Account$","description":"Used to determine the exact schema type.\nAllowed values:\n- CashLocalBankAccount\n- CashSepaBankAccount\n- CashACHBankAccount\n- CashSwiftBankAccount\n- CashMobileWalletAccount\n- CashMultiRailBankAccount\n","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.4.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.4.accountName","typeLabel":"string"},"mobileNetwork":{"type":"string","description":"Mobile network operator for the mobile money account (e.g., MTN, Vodafone)","uniqueKey":"paymentDetails.details.oneOf.4.mobileNetwork","typeLabel":"string"},"reference":{"type":"string","description":"Reference the customer must include with the deposit so the pay-in is auto-matched.\nOptional — some providers do not require one.\n","example":"PROV123456","uniqueKey":"paymentDetails.details.oneOf.4.reference","typeLabel":"string"}},"uniqueKey":"paymentDetails.details.oneOf.4","typeLabel":"object"},{"type":"object","description":"Bank details for an account reachable via more than one independently-coded payment rail on the\nsame account number (e.g. a US account that accepts ACH, FedWire, and SWIFT, each with its own\nrouting code). Use the single-rail Cash*BankAccount schemas instead when only one rail applies.\n","required":["accountInfoType","accountName","accountNumber","bankName","bankAddress","supportedRails"],"x-source-svc":"ledger","properties":{"bankName":{"description":"Beneficiary bank name","type":"string","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.bankName","typeLabel":"string"},"bankAddress":{"required":["city","country","postalCode","state","streetAddress"],"type":"object","properties":{"streetAddress":{"minLength":3,"type":"string","description":"the street address of the user","example":"11 Main Street","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.bankAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.bankAddress.city","typeLabel":"string"},"state":{"minLength":3,"type":"string","description":"the state/region/province where the user lives","example":"Lagos","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.bankAddress.state","typeLabel":"string"},"country":{"maxLength":2,"minLength":2,"type":"string","description":"the country ISO CODE 3166-2 where the user lives","example":"NG","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.bankAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.bankAddress.postalCode","typeLabel":"string"},"apartmentNo":{"minLength":1,"type":"string","description":"the flat/apartment number of the user at the specified address","example":"5B","uniqueKey":"paymentDetails.details.oneOf.5.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.bankAddress","typeLabel":"object"},"supportedRails":{"type":"array","minItems":1,"uniqueItems":true,"items":{"description":"A single payment rail supported by a multi-rail bank account, and the routing code specific to\nthat rail (e.g. the ABA routing number for ACH/FedWire, or the BIC for SWIFT).\n","type":"object","required":["rail","routingCode"],"properties":{"rail":{"type":"string","enum":["ACH","FEDWIRE","SWIFT"],"isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.supportedRails.items.[INDEX].rail","typeLabel":"enum\u003cstring>"},"routingCode":{"type":"string","example":"021000021","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.supportedRails.items.[INDEX].routingCode","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"paymentDetails.details.oneOf.5.supportedRails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.supportedRails","typeLabel":"object[]"},"accountInfoType":{"type":"string","pattern":"^Cash(LocalBank|SepaBank|ACHBank|SwiftBank|MobileWallet|MultiRailBank)Account$","description":"Used to determine the exact schema type.\nAllowed values:\n- CashLocalBankAccount\n- CashSepaBankAccount\n- CashACHBankAccount\n- CashSwiftBankAccount\n- CashMobileWalletAccount\n- CashMultiRailBankAccount\n","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.accountName","typeLabel":"string"},"accountNumber":{"type":"string","description":"The destination account identifier. For mobile money this is the phone number, for P2P wallet the account ID.\nWhere routing number or sort code is present, this would be `{routingNumber}-{accountNumber}`.\n","example":"230101010","isRequired":true,"uniqueKey":"paymentDetails.details.oneOf.5.accountNumber","typeLabel":"string"},"accountType":{"type":"string","description":"The account type","example":"CHECKING","enum":["CHECKING","SAVINGS"],"x-source-svc":"ledger","uniqueKey":"paymentDetails.details.oneOf.5.accountType","typeLabel":"enum\u003cstring>"},"reference":{"type":"string","description":"Reference the customer must include with the deposit so the pay-in is auto-matched.\nOptional — some providers do not require one.\n","example":"PROV123456","uniqueKey":"paymentDetails.details.oneOf.5.reference","typeLabel":"string"}},"uniqueKey":"paymentDetails.details.oneOf.5","typeLabel":"object"}],"uniqueKey":"paymentDetails.details","typeLabel":"object"}},"x-source-svc":"ledger","uniqueKey":"paymentDetails","typeLabel":"object"}},"x-source-svc":"ledger","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","reference":"\u003cstring>","currency":"USD","status":"PENDING","payinCurrency":"NGN","amount":100,"rate":1450.75,"payinAmount":145075,"createdDate":"2023-11-07T05:31:56Z","accountTransactionId":"\u003cstring>","providerReference":"PROV123456","paymentDetails":{"payinCurrency":"NGN","details":{"bankCode":"\u003cstring>","accountInfoType":"\u003cstring>","accountName":"John Doe","accountNumber":"230101010","bankName":"\u003cstring>","bankAddress":{"streetAddress":"11 Main Street","city":"Gbagada","state":"Lagos","country":"NG","postalCode":"200124","apartmentNo":"5B"},"reference":"PROV123456"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"65e9051e-a6c6-4bb3-bc0e-40233c225e60":{"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"},"a22cb056-be88-45ed-966b-b6de4798f703":{"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"}},"security":{"16034ed4-70e8-4fef-8507-1c6354dbcfbf":{"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.355Z","originalFileLocation":"api-reference/endpoints/cash-deposits/create-deposit.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.\">\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/cash-deposits/create-deposit\">\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/cash-deposits/create-deposit\">\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/cash-deposits/create-deposit.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/cash-deposits/create-deposit#webpage\",\"url\":\"https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/create-deposit\",\"name\":\"Create Cash Deposit\",\"description\":\"Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.\",\"dateModified\":\"2026-07-24T16:00:25.355Z\",\"isPartOf\":{\"@id\":\"https://docs.onboard.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/create-deposit#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/create-deposit#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cash Deposits\",\"item\":\"https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/get-currencies\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Cash Deposit\",\"item\":\"https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/create-deposit\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/create-deposit#apireference\",\"headline\":\"Create Cash Deposit\",\"name\":\"Create Cash Deposit\",\"description\":\"Create cash deposit, using the created quote. Returns the deposit transaction, including the payment details the customer must pay into.\",\"url\":\"https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/create-deposit\",\"mainEntityOfPage\":{\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/cash-deposits/create-deposit#webpage\"},\"image\":\"https://docs.onboard.xyz/images/og-default.png\",\"dateModified\":\"2026-07-24T16:00:25.355Z\",\"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","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","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","description":"Create quote for cash deposit","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}","description":"Get specific cash deposit by 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"]}