A single entry in the aggregated account activity feed. The concrete subtype is
determined by the activityType discriminator; the type field carries the
semantic category for filtering and display.
{"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.4094","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/transaction-activities/subaccount-activity-by-id","slug":"/api-reference/endpoints/transaction-activities/subaccount-activity-by-id","pageMetadata":{"title":"Get Sub-account Activity","openapi":"GET /ledger/subaccounts/{subAccountIdRef}/activities/{activityId}","description":"This operation allows the client to fetch a specific transaction activity by its ID.\n","href":"/api-reference/endpoints/transaction-activities/subaccount-activity-by-id"},"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 transaction activity by its 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 a single sub-account activity by ID.`})}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 Sub-account Activity","openapi":"GET /ledger/subaccounts/{subAccountIdRef}/activities/{activityId}","description":"This operation allows the client to fetch a specific transaction activity by its ID.\n","href":"/api-reference/endpoints/transaction-activities/subaccount-activity-by-id"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get a single sub-account transaction activity","description":"This operation allows the client to fetch a specific transaction activity by its ID.\n","operationId":"getSubAccountActivityById","x-visibility":"external","tags":["ledger-account activity"],"parameters":["90b2633a-dc4d-4867-8931-025f51aa6277","871a1628-5abc-47cc-a02a-79b993fdee7f"],"responses":{"200":"f8ca13f2-5880-4584-b095-0abaffe98b9e","400":"01af1223-c955-487d-954c-5431b1391b1f","401":"7bf6d592-31cc-4537-a32b-f0bd82d9ae00","403":"16b0e179-dad0-445a-add3-c756872cd3c3","404":"ac2a2c66-fd5a-4a84-acee-3f7f39b36967","default":"67296eb2-0352-4ecd-b400-34ca2c53bb15"},"security":["876b3d6e-d150-47c9-b046-1fb217d3258c"],"method":"get","type":"path","servers":["f9ce9404-c09f-4cea-8fce-90e53805086c","dfd174e2-6344-4d18-8dc6-fdc59893e057"],"path":"/ledger/subaccounts/{subAccountIdRef}/activities/{activityId}","baseUrlOptions":["https://business-api.onboard.xyz","https://external.dev.onboardpay.co"],"title":"Get a single sub-account transaction activity","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"90b2633a-dc4d-4867-8931-025f51aa6277":{"in":"path","name":"subAccountIdRef","description":"The unique onboard sub-account ID or reference\n","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique onboard sub-account ID or reference\n","uniqueKey":"","typeLabel":"string"}},"871a1628-5abc-47cc-a02a-79b993fdee7f":{"in":"path","name":"activityId","description":"The unique transaction activity ID","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"The unique transaction activity ID","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"f8ca13f2-5880-4584-b095-0abaffe98b9e":{"description":"Activity fetched successfully","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"A single entry in the aggregated account activity feed. The concrete subtype is\ndetermined by the activityType discriminator; the type field carries the\nsemantic category for filtering and display.\n","required":["id","activityType","type","direction","amount","currency","status","activityAt","accountId","accountType","activityData"],"x-source-svc":"ledger","properties":{"activityData":{"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":"oneOf.0.activityData.id","typeLabel":"string\u003cuuid>"},"reference":{"type":"string","description":"Reference for the cash deposit transaction at initiation.","isRequired":true,"uniqueKey":"oneOf.0.activityData.reference","typeLabel":"string"},"currency":{"type":"string","description":"Currency in which the account was credited.","example":"USD","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.status","typeLabel":"enum\u003cstring>"},"payinCurrency":{"type":"string","description":"Currency the customer paid in.","example":"NGN","isRequired":true,"uniqueKey":"oneOf.0.activityData.payinCurrency","typeLabel":"string"},"amount":{"type":"number","description":"Amount credited to the account.","example":100,"isRequired":true,"uniqueKey":"oneOf.0.activityData.amount","typeLabel":"number"},"rate":{"type":"number","description":"Exchange rate applied for this deposit.","example":1450.75,"isRequired":true,"uniqueKey":"oneOf.0.activityData.rate","typeLabel":"number"},"payinAmount":{"type":"number","description":"Amount the customer paid in, in the pay-in currency.","example":145075,"isRequired":true,"uniqueKey":"oneOf.0.activityData.payinAmount","typeLabel":"number"},"createdDate":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.activityData.createdDate","typeLabel":"string\u003cdate-time>"},"accountTransactionId":{"type":"string","description":"Identifier of the credit transaction on the account.","uniqueKey":"oneOf.0.activityData.accountTransactionId","typeLabel":"string"},"providerReference":{"type":"string","description":"Reference provided by the cash deposit provider.","example":"PROV123456","uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.0.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.0.accountNumber","typeLabel":"string"},"bankName":{"description":"Beneficiary bank name","type":"string","uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.0.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.0.reference","typeLabel":"string"}},"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.1.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.1.bic","typeLabel":"string"},"bankName":{"description":"Beneficiary bank name","type":"string","uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.1.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.1.reference","typeLabel":"string"}},"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.2.recipientAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.2.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.0.activityData.paymentDetails.details.oneOf.2.bankAddress","typeLabel":"object"},"bankName":{"description":"Beneficiary bank name","type":"string","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.2.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.2.accountNumber","typeLabel":"string"},"accountType":{"type":"string","description":"The account type","example":"CHECKING","enum":["CHECKING","SAVINGS"],"x-source-svc":"ledger","uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.2.reference","typeLabel":"string"}},"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.3.recipientAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.3.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.0.activityData.paymentDetails.details.oneOf.3.bankAddress","typeLabel":"object"},"bankName":{"description":"Beneficiary bank name","type":"string","isRequired":true,"uniqueKey":"oneOf.0.activityData.paymentDetails.details.oneOf.3.bankName","typeLabel":"string"},"bic":{"description":"Beneficiary BIC, might be called SWIFT code","type":"string","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.3.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.3.accountNumber","typeLabel":"string"},"routingNumber":{"type":"string","minLength":9,"maxLength":9,"pattern":"^\\d{9}$","example":"021000021","uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.3.reference","typeLabel":"string"}},"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.4.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.0.activityData.paymentDetails.details.oneOf.4.accountName","typeLabel":"string"},"mobileNetwork":{"type":"string","description":"Mobile network operator for the mobile money account (e.g., MTN, Vodafone)","uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.4.reference","typeLabel":"string"}},"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.5.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.5.supportedRails.items.[INDEX].rail","typeLabel":"enum\u003cstring>"},"routingCode":{"type":"string","example":"021000021","isRequired":true,"uniqueKey":"oneOf.0.activityData.paymentDetails.details.oneOf.5.supportedRails.items.[INDEX].routingCode","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"oneOf.0.activityData.paymentDetails.details.oneOf.5.supportedRails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.5.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.5.accountNumber","typeLabel":"string"},"accountType":{"type":"string","description":"The account type","example":"CHECKING","enum":["CHECKING","SAVINGS"],"x-source-svc":"ledger","uniqueKey":"oneOf.0.activityData.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":"oneOf.0.activityData.paymentDetails.details.oneOf.5.reference","typeLabel":"string"}},"uniqueKey":"oneOf.0.activityData.paymentDetails.details.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.0.activityData.paymentDetails.details","typeLabel":"object"}},"x-source-svc":"ledger","uniqueKey":"oneOf.0.activityData.paymentDetails","typeLabel":"object"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.0.activityData","typeLabel":"object"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string\u003cuuid>"},"activityType":{"type":"string","description":"Discriminator; the concrete activity model name, e.g. CashDepositActivity.\n","isRequired":true,"uniqueKey":"oneOf.0.activityType","typeLabel":"string"},"type":{"type":"string","description":"Semantic category of a transaction activity feed entry.","enum":["CASH_DEPOSIT","CASH_PAYMENT","ACCOUNT_NUMBER_DEPOSIT","CRYPTO_WITHDRAWAL","CRYPTO_DEPOSIT","INTERNAL_TRANSFER","OFFRAMP_DEPOSIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["CREDIT","DEBIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.0.direction","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Always positive; see direction for credit/debit.","example":100,"isRequired":true,"uniqueKey":"oneOf.0.amount","typeLabel":"number"},"currency":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.0.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":"oneOf.0.status","typeLabel":"enum\u003cstring>"},"accountId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.accountId","typeLabel":"string\u003cuuid>"},"accountType":{"type":"string","description":"The kind of account a transaction activity occurred on.","enum":["MAIN","SUB_ACCOUNT","OFFRAMP_ACCOUNT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.0.accountType","typeLabel":"enum\u003cstring>"},"activityAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.0.activityAt","typeLabel":"string\u003cdate-time>"},"reference":{"type":"string","description":"Customer-facing reference of the source transaction.","uniqueKey":"oneOf.0.reference","typeLabel":"string"},"subAccountId":{"type":"string","format":"uuid","description":"Set when accountType is SUB_ACCOUNT.","uniqueKey":"oneOf.0.subAccountId","typeLabel":"string\u003cuuid>"},"accountTransactionId":{"type":"string","description":"Identifier of the transaction on the ledger account, when available.","uniqueKey":"oneOf.0.accountTransactionId","typeLabel":"string"},"groupId":{"type":"string","format":"uuid","description":"Links related activities together, e.g. the two legs of an internal\ntransfer, or an offramp deposit and its refund.\n","uniqueKey":"oneOf.0.groupId","typeLabel":"string\u003cuuid>"},"narration":{"type":"string","uniqueKey":"oneOf.0.narration","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"A single entry in the aggregated account activity feed. The concrete subtype is\ndetermined by the activityType discriminator; the type field carries the\nsemantic category for filtering and display.\n","required":["id","activityType","type","direction","amount","currency","status","activityAt","accountId","accountType","activityData"],"x-source-svc":"ledger","properties":{"activityData":{"type":"object","description":"Details of a cash payment transaction.","required":["id","reference","currency","status","payoutCurrency","amount","rate","payoutAmount","createdDate","recipient"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.activityData.id","typeLabel":"string\u003cuuid>"},"reference":{"type":"string","description":"Reference for the cash payment transaction at initiation.","isRequired":true,"uniqueKey":"oneOf.1.activityData.reference","typeLabel":"string"},"currency":{"type":"string","description":"Currency in which the account was debited.","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.activityData.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":"oneOf.1.activityData.status","typeLabel":"enum\u003cstring>"},"payoutCurrency":{"type":"string","description":"Currency in which the beneficiary will be paid out.","example":"NGN","isRequired":true,"uniqueKey":"oneOf.1.activityData.payoutCurrency","typeLabel":"string"},"amount":{"type":"number","description":"Amount transferred.","example":100,"isRequired":true,"uniqueKey":"oneOf.1.activityData.amount","typeLabel":"number"},"rate":{"type":"number","description":"Exchange rate applied for this transfer.","example":1450.75,"isRequired":true,"uniqueKey":"oneOf.1.activityData.rate","typeLabel":"number"},"payoutAmount":{"type":"number","description":"Amount paid out to the beneficiary in payout currency.","example":145075,"isRequired":true,"uniqueKey":"oneOf.1.activityData.payoutAmount","typeLabel":"number"},"recipient":{"type":"object","description":"Basic information about a beneficiary as at the time of transaction.","required":["id","accountName","beneficiaryType","accountIdentifier","paymentChannelId"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the beneficiary.","isRequired":true,"uniqueKey":"oneOf.1.activityData.recipient.id","typeLabel":"string\u003cuuid>"},"accountName":{"type":"string","description":"Name on the account","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.1.activityData.recipient.accountName","typeLabel":"string"},"beneficiaryType":{"type":"string","description":"Type of beneficiary object.","example":"BeneficiaryLocalBankAccount","isRequired":true,"uniqueKey":"oneOf.1.activityData.recipient.beneficiaryType","typeLabel":"string"},"accountIdentifier":{"type":"string","description":"The account identifier at the bank. For mobile money, this is the phone number on account, for P2P wallet, this is the account ID\nWhere routing number or sort code is present, this would be `{routingNumber}-{accountNumber}`\n","example":"230101010","isRequired":true,"uniqueKey":"oneOf.1.activityData.recipient.accountIdentifier","typeLabel":"string"},"paymentChannelId":{"type":"string","description":"Identifier of the payment channel used for this transaction, if available. This can be used to determine the exact payment method used for the transaction.","example":"BANK_TRANSFER_NIGERIA","isRequired":true,"uniqueKey":"oneOf.1.activityData.recipient.paymentChannelId","typeLabel":"string"},"bankName":{"type":"string","description":"Name of the receiving bank, for mobile money this would be the network, and for P2P wallet it will be the name of the account provider\n","example":"Great Bank LLC","uniqueKey":"oneOf.1.activityData.recipient.bankName","typeLabel":"string"},"country":{"type":"string","description":"Country where the payment method belongs if available","example":"IE","uniqueKey":"oneOf.1.activityData.recipient.country","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.1.activityData.recipient","typeLabel":"object"},"createdDate":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.1.activityData.createdDate","typeLabel":"string\u003cdate-time>"},"accountTransactionId":{"type":"string","description":"Identifier of the transaction on the account.","uniqueKey":"oneOf.1.activityData.accountTransactionId","typeLabel":"string"},"providerReference":{"type":"string","description":"Reference provided by the cash payment provider.","example":"PROV123456","uniqueKey":"oneOf.1.activityData.providerReference","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.1.activityData","typeLabel":"object"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string\u003cuuid>"},"activityType":{"type":"string","description":"Discriminator; the concrete activity model name, e.g. CashDepositActivity.\n","isRequired":true,"uniqueKey":"oneOf.1.activityType","typeLabel":"string"},"type":{"type":"string","description":"Semantic category of a transaction activity feed entry.","enum":["CASH_DEPOSIT","CASH_PAYMENT","ACCOUNT_NUMBER_DEPOSIT","CRYPTO_WITHDRAWAL","CRYPTO_DEPOSIT","INTERNAL_TRANSFER","OFFRAMP_DEPOSIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["CREDIT","DEBIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.1.direction","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Always positive; see direction for credit/debit.","example":100,"isRequired":true,"uniqueKey":"oneOf.1.amount","typeLabel":"number"},"currency":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.1.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":"oneOf.1.status","typeLabel":"enum\u003cstring>"},"accountId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.accountId","typeLabel":"string\u003cuuid>"},"accountType":{"type":"string","description":"The kind of account a transaction activity occurred on.","enum":["MAIN","SUB_ACCOUNT","OFFRAMP_ACCOUNT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.1.accountType","typeLabel":"enum\u003cstring>"},"activityAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.1.activityAt","typeLabel":"string\u003cdate-time>"},"reference":{"type":"string","description":"Customer-facing reference of the source transaction.","uniqueKey":"oneOf.1.reference","typeLabel":"string"},"subAccountId":{"type":"string","format":"uuid","description":"Set when accountType is SUB_ACCOUNT.","uniqueKey":"oneOf.1.subAccountId","typeLabel":"string\u003cuuid>"},"accountTransactionId":{"type":"string","description":"Identifier of the transaction on the ledger account, when available.","uniqueKey":"oneOf.1.accountTransactionId","typeLabel":"string"},"groupId":{"type":"string","format":"uuid","description":"Links related activities together, e.g. the two legs of an internal\ntransfer, or an offramp deposit and its refund.\n","uniqueKey":"oneOf.1.groupId","typeLabel":"string\u003cuuid>"},"narration":{"type":"string","uniqueKey":"oneOf.1.narration","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","description":"A single entry in the aggregated account activity feed. The concrete subtype is\ndetermined by the activityType discriminator; the type field carries the\nsemantic category for filtering and display.\n","required":["id","activityType","type","direction","amount","currency","status","activityAt","accountId","accountType","activityData"],"x-source-svc":"ledger","properties":{"activityData":{"type":"object","description":"Details of an account-number (virtual/bank account number) deposit transaction.","required":["id","amount","currency","accountCurrency","status","createdDate"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.2.activityData.id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","example":100,"description":"Amount deposited to the bank account number","isRequired":true,"uniqueKey":"oneOf.2.activityData.amount","typeLabel":"number"},"currency":{"description":"The account number currency/currency for the amount that was deposited.","type":"string","example":"NGN","isRequired":true,"uniqueKey":"oneOf.2.activityData.currency","typeLabel":"string"},"accountCurrency":{"type":"string","description":"The currency of the account that owns the account number","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.activityData.accountCurrency","typeLabel":"string"},"status":{"type":"string","description":"Status of the deposit transaction","enum":["PENDING","IN_PROGRESS","FAILED","SUCCESS"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.2.activityData.status","typeLabel":"enum\u003cstring>"},"createdDate":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.2.activityData.createdDate","typeLabel":"string\u003cdate-time>"},"fee":{"type":"number","minimum":0,"description":"Fee charged in account number currency (currency field)","uniqueKey":"oneOf.2.activityData.fee","typeLabel":"number"},"senderAccountDetails":{"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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.0.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.0.accountNumber","typeLabel":"string"},"bankName":{"description":"Beneficiary bank name","type":"string","uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.0.bankAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.0.bankAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.0.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.0.reference","typeLabel":"string"}},"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.1.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.1.bic","typeLabel":"string"},"bankName":{"description":"Beneficiary bank name","type":"string","uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.1.bankAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.1.bankAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.1.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.1.reference","typeLabel":"string"}},"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.2.recipientAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.2.recipientAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.2.recipientAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.2.bankAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.2.bankAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.2.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.oneOf.2.bankAddress","typeLabel":"object"},"bankName":{"description":"Beneficiary bank name","type":"string","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.2.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.2.accountNumber","typeLabel":"string"},"accountType":{"type":"string","description":"The account type","example":"CHECKING","enum":["CHECKING","SAVINGS"],"x-source-svc":"ledger","uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.2.reference","typeLabel":"string"}},"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.3.recipientAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.3.recipientAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.3.recipientAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.3.bankAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.3.bankAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.3.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.oneOf.3.bankAddress","typeLabel":"object"},"bankName":{"description":"Beneficiary bank name","type":"string","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.oneOf.3.bankName","typeLabel":"string"},"bic":{"description":"Beneficiary BIC, might be called SWIFT code","type":"string","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.3.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.3.accountNumber","typeLabel":"string"},"routingNumber":{"type":"string","minLength":9,"maxLength":9,"pattern":"^\\d{9}$","example":"021000021","uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.3.reference","typeLabel":"string"}},"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.4.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.oneOf.4.accountName","typeLabel":"string"},"mobileNetwork":{"type":"string","description":"Mobile network operator for the mobile money account (e.g., MTN, Vodafone)","uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.4.reference","typeLabel":"string"}},"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.5.bankAddress.streetAddress","typeLabel":"string"},"city":{"minLength":2,"type":"string","description":"the city/municipality where the user lives","example":"Gbagada","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.5.bankAddress.country","typeLabel":"string"},"postalCode":{"minLength":4,"type":"string","description":"the postal code of the specified address","example":"200124","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.5.bankAddress.apartmentNo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.5.supportedRails.items.[INDEX].rail","typeLabel":"enum\u003cstring>"},"routingCode":{"type":"string","example":"021000021","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.oneOf.5.supportedRails.items.[INDEX].routingCode","typeLabel":"string"}},"x-source-svc":"ledger","uniqueKey":"oneOf.2.activityData.senderAccountDetails.oneOf.5.supportedRails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.5.accountInfoType","typeLabel":"string"},"accountName":{"type":"string","description":"Name on the destination account.","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.5.accountNumber","typeLabel":"string"},"accountType":{"type":"string","description":"The account type","example":"CHECKING","enum":["CHECKING","SAVINGS"],"x-source-svc":"ledger","uniqueKey":"oneOf.2.activityData.senderAccountDetails.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":"oneOf.2.activityData.senderAccountDetails.oneOf.5.reference","typeLabel":"string"}},"uniqueKey":"oneOf.2.activityData.senderAccountDetails.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.2.activityData.senderAccountDetails","typeLabel":"object"},"settlementAmount":{"type":"number","description":"The final settlement amount in the same currency as accountCurrency","uniqueKey":"oneOf.2.activityData.settlementAmount","typeLabel":"number"},"settlementExchangeRate":{"type":"number","description":"Exchange rate from the deposited currency to the account currency","uniqueKey":"oneOf.2.activityData.settlementExchangeRate","typeLabel":"number"},"accountTransactionId":{"type":"string","description":"Transaction ID on the ledger, only available when status is SUCCESS","uniqueKey":"oneOf.2.activityData.accountTransactionId","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.2.activityData","typeLabel":"object"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string\u003cuuid>"},"activityType":{"type":"string","description":"Discriminator; the concrete activity model name, e.g. CashDepositActivity.\n","isRequired":true,"uniqueKey":"oneOf.2.activityType","typeLabel":"string"},"type":{"type":"string","description":"Semantic category of a transaction activity feed entry.","enum":["CASH_DEPOSIT","CASH_PAYMENT","ACCOUNT_NUMBER_DEPOSIT","CRYPTO_WITHDRAWAL","CRYPTO_DEPOSIT","INTERNAL_TRANSFER","OFFRAMP_DEPOSIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["CREDIT","DEBIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.2.direction","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Always positive; see direction for credit/debit.","example":100,"isRequired":true,"uniqueKey":"oneOf.2.amount","typeLabel":"number"},"currency":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.2.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":"oneOf.2.status","typeLabel":"enum\u003cstring>"},"accountId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.2.accountId","typeLabel":"string\u003cuuid>"},"accountType":{"type":"string","description":"The kind of account a transaction activity occurred on.","enum":["MAIN","SUB_ACCOUNT","OFFRAMP_ACCOUNT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.2.accountType","typeLabel":"enum\u003cstring>"},"activityAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.2.activityAt","typeLabel":"string\u003cdate-time>"},"reference":{"type":"string","description":"Customer-facing reference of the source transaction.","uniqueKey":"oneOf.2.reference","typeLabel":"string"},"subAccountId":{"type":"string","format":"uuid","description":"Set when accountType is SUB_ACCOUNT.","uniqueKey":"oneOf.2.subAccountId","typeLabel":"string\u003cuuid>"},"accountTransactionId":{"type":"string","description":"Identifier of the transaction on the ledger account, when available.","uniqueKey":"oneOf.2.accountTransactionId","typeLabel":"string"},"groupId":{"type":"string","format":"uuid","description":"Links related activities together, e.g. the two legs of an internal\ntransfer, or an offramp deposit and its refund.\n","uniqueKey":"oneOf.2.groupId","typeLabel":"string\u003cuuid>"},"narration":{"type":"string","uniqueKey":"oneOf.2.narration","typeLabel":"string"}},"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","description":"A single entry in the aggregated account activity feed. The concrete subtype is\ndetermined by the activityType discriminator; the type field carries the\nsemantic category for filtering and display.\n","required":["id","activityType","type","direction","amount","currency","status","activityAt","accountId","accountType","activityData"],"x-source-svc":"ledger","properties":{"activityData":{"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":"oneOf.3.activityData.id","typeLabel":"string"},"reference":{"type":"string","description":"Unique transaction reference.","example":"REF123456","isRequired":true,"uniqueKey":"oneOf.3.activityData.reference","typeLabel":"string"},"type":{"type":"string","enum":["DEPOSIT","WITHDRAWAL","TRANSFER"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.3.activityData.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount, negative for debits, positive for credits","example":100,"isRequired":true,"uniqueKey":"oneOf.3.activityData.amount","typeLabel":"number"},"currency":{"type":"string","description":"Transaction currency","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.activityData.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":"oneOf.3.activityData.status","typeLabel":"enum\u003cstring>"},"createdDate":{"type":"string","format":"date-time","description":"Transaction creation date","isRequired":true,"uniqueKey":"oneOf.3.activityData.createdDate","typeLabel":"string\u003cdate-time>"},"categoryTag":{"type":"string","description":"Category tag for the transaction","example":"crypto-withdrawal","uniqueKey":"oneOf.3.activityData.categoryTag","typeLabel":"string"},"notes":{"type":"string","description":"Transaction description","example":"Conversion from USDC to IDR","uniqueKey":"oneOf.3.activityData.notes","typeLabel":"string"},"accountId":{"type":"string","format":"uuid","description":"Associated account ID","uniqueKey":"oneOf.3.activityData.accountId","typeLabel":"string\u003cuuid>"},"feeAmount":{"type":"number","description":"Fee amount associated with the transaction","example":1,"uniqueKey":"oneOf.3.activityData.feeAmount","typeLabel":"number"},"feeInclusive":{"type":"boolean","description":"Indicates if the fee is inclusive in the transaction amount","uniqueKey":"oneOf.3.activityData.feeInclusive","typeLabel":"boolean"},"subAccountId":{"type":"string","format":"uuid","description":"Associated sub-account ID, if applicable","uniqueKey":"oneOf.3.activityData.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":"oneOf.3.activityData.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":"oneOf.3.activityData.blockchainInfo.recipient.address","typeLabel":"string"},"memo":{"type":"string","description":"Memo for blockchains where memo is required.","example":"1290122112","uniqueKey":"oneOf.3.activityData.blockchainInfo.recipient.memo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.3.activityData.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":"oneOf.3.activityData.blockchainInfo.value","typeLabel":"number"},"tokenSymbol":{"example":"USDT","description":"Token symbol","type":"string","isRequired":true,"uniqueKey":"oneOf.3.activityData.blockchainInfo.tokenSymbol","typeLabel":"string"},"senderAddress":{"type":"string","description":"The address of the sender.","example":"0x2b059a574a35e60b228d10d54fec2671de4928e1","uniqueKey":"oneOf.3.activityData.blockchainInfo.senderAddress","typeLabel":"string"},"blockNumber":{"type":"integer","format":"int64","example":20564802,"uniqueKey":"oneOf.3.activityData.blockchainInfo.blockNumber","typeLabel":"integer\u003cint64>"},"timestamp":{"type":"integer","format":"int64","description":"Transaction block timestamp.","uniqueKey":"oneOf.3.activityData.blockchainInfo.timestamp","typeLabel":"integer\u003cint64>"},"explorerUrl":{"type":"string","format":"url","description":"URL to view the transaction on a blockchain explorer.","uniqueKey":"oneOf.3.activityData.blockchainInfo.explorerUrl","typeLabel":"string\u003curl>"}},"x-source-svc":"ledger","uniqueKey":"oneOf.3.activityData.blockchainInfo","typeLabel":"object"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.3.activityData","typeLabel":"object"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.3.id","typeLabel":"string\u003cuuid>"},"activityType":{"type":"string","description":"Discriminator; the concrete activity model name, e.g. CashDepositActivity.\n","isRequired":true,"uniqueKey":"oneOf.3.activityType","typeLabel":"string"},"type":{"type":"string","description":"Semantic category of a transaction activity feed entry.","enum":["CASH_DEPOSIT","CASH_PAYMENT","ACCOUNT_NUMBER_DEPOSIT","CRYPTO_WITHDRAWAL","CRYPTO_DEPOSIT","INTERNAL_TRANSFER","OFFRAMP_DEPOSIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["CREDIT","DEBIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.3.direction","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Always positive; see direction for credit/debit.","example":100,"isRequired":true,"uniqueKey":"oneOf.3.amount","typeLabel":"number"},"currency":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.3.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":"oneOf.3.status","typeLabel":"enum\u003cstring>"},"accountId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.3.accountId","typeLabel":"string\u003cuuid>"},"accountType":{"type":"string","description":"The kind of account a transaction activity occurred on.","enum":["MAIN","SUB_ACCOUNT","OFFRAMP_ACCOUNT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.3.accountType","typeLabel":"enum\u003cstring>"},"activityAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.3.activityAt","typeLabel":"string\u003cdate-time>"},"reference":{"type":"string","description":"Customer-facing reference of the source transaction.","uniqueKey":"oneOf.3.reference","typeLabel":"string"},"subAccountId":{"type":"string","format":"uuid","description":"Set when accountType is SUB_ACCOUNT.","uniqueKey":"oneOf.3.subAccountId","typeLabel":"string\u003cuuid>"},"accountTransactionId":{"type":"string","description":"Identifier of the transaction on the ledger account, when available.","uniqueKey":"oneOf.3.accountTransactionId","typeLabel":"string"},"groupId":{"type":"string","format":"uuid","description":"Links related activities together, e.g. the two legs of an internal\ntransfer, or an offramp deposit and its refund.\n","uniqueKey":"oneOf.3.groupId","typeLabel":"string\u003cuuid>"},"narration":{"type":"string","uniqueKey":"oneOf.3.narration","typeLabel":"string"}},"uniqueKey":"oneOf.3","typeLabel":"object"},{"type":"object","description":"A single entry in the aggregated account activity feed. The concrete subtype is\ndetermined by the activityType discriminator; the type field carries the\nsemantic category for filtering and display.\n","required":["id","activityType","type","direction","amount","currency","status","activityAt","accountId","accountType","activityData"],"x-source-svc":"ledger","properties":{"activityData":{"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":"oneOf.4.activityData.id","typeLabel":"string"},"reference":{"type":"string","description":"Unique transaction reference.","example":"REF123456","isRequired":true,"uniqueKey":"oneOf.4.activityData.reference","typeLabel":"string"},"type":{"type":"string","enum":["DEPOSIT","WITHDRAWAL","TRANSFER"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.4.activityData.type","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Transaction amount, negative for debits, positive for credits","example":100,"isRequired":true,"uniqueKey":"oneOf.4.activityData.amount","typeLabel":"number"},"currency":{"type":"string","description":"Transaction currency","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.activityData.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":"oneOf.4.activityData.status","typeLabel":"enum\u003cstring>"},"createdDate":{"type":"string","format":"date-time","description":"Transaction creation date","isRequired":true,"uniqueKey":"oneOf.4.activityData.createdDate","typeLabel":"string\u003cdate-time>"},"categoryTag":{"type":"string","description":"Category tag for the transaction","example":"crypto-withdrawal","uniqueKey":"oneOf.4.activityData.categoryTag","typeLabel":"string"},"notes":{"type":"string","description":"Transaction description","example":"Conversion from USDC to IDR","uniqueKey":"oneOf.4.activityData.notes","typeLabel":"string"},"accountId":{"type":"string","format":"uuid","description":"Associated account ID","uniqueKey":"oneOf.4.activityData.accountId","typeLabel":"string\u003cuuid>"},"feeAmount":{"type":"number","description":"Fee amount associated with the transaction","example":1,"uniqueKey":"oneOf.4.activityData.feeAmount","typeLabel":"number"},"feeInclusive":{"type":"boolean","description":"Indicates if the fee is inclusive in the transaction amount","uniqueKey":"oneOf.4.activityData.feeInclusive","typeLabel":"boolean"},"subAccountId":{"type":"string","format":"uuid","description":"Associated sub-account ID, if applicable","uniqueKey":"oneOf.4.activityData.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":"oneOf.4.activityData.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":"oneOf.4.activityData.blockchainInfo.recipient.address","typeLabel":"string"},"memo":{"type":"string","description":"Memo for blockchains where memo is required.","example":"1290122112","uniqueKey":"oneOf.4.activityData.blockchainInfo.recipient.memo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.4.activityData.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":"oneOf.4.activityData.blockchainInfo.value","typeLabel":"number"},"tokenSymbol":{"example":"USDT","description":"Token symbol","type":"string","isRequired":true,"uniqueKey":"oneOf.4.activityData.blockchainInfo.tokenSymbol","typeLabel":"string"},"senderAddress":{"type":"string","description":"The address of the sender.","example":"0x2b059a574a35e60b228d10d54fec2671de4928e1","uniqueKey":"oneOf.4.activityData.blockchainInfo.senderAddress","typeLabel":"string"},"blockNumber":{"type":"integer","format":"int64","example":20564802,"uniqueKey":"oneOf.4.activityData.blockchainInfo.blockNumber","typeLabel":"integer\u003cint64>"},"timestamp":{"type":"integer","format":"int64","description":"Transaction block timestamp.","uniqueKey":"oneOf.4.activityData.blockchainInfo.timestamp","typeLabel":"integer\u003cint64>"},"explorerUrl":{"type":"string","format":"url","description":"URL to view the transaction on a blockchain explorer.","uniqueKey":"oneOf.4.activityData.blockchainInfo.explorerUrl","typeLabel":"string\u003curl>"}},"x-source-svc":"ledger","uniqueKey":"oneOf.4.activityData.blockchainInfo","typeLabel":"object"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.4.activityData","typeLabel":"object"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.4.id","typeLabel":"string\u003cuuid>"},"activityType":{"type":"string","description":"Discriminator; the concrete activity model name, e.g. CashDepositActivity.\n","isRequired":true,"uniqueKey":"oneOf.4.activityType","typeLabel":"string"},"type":{"type":"string","description":"Semantic category of a transaction activity feed entry.","enum":["CASH_DEPOSIT","CASH_PAYMENT","ACCOUNT_NUMBER_DEPOSIT","CRYPTO_WITHDRAWAL","CRYPTO_DEPOSIT","INTERNAL_TRANSFER","OFFRAMP_DEPOSIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.4.type","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["CREDIT","DEBIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.4.direction","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Always positive; see direction for credit/debit.","example":100,"isRequired":true,"uniqueKey":"oneOf.4.amount","typeLabel":"number"},"currency":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.4.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":"oneOf.4.status","typeLabel":"enum\u003cstring>"},"accountId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.4.accountId","typeLabel":"string\u003cuuid>"},"accountType":{"type":"string","description":"The kind of account a transaction activity occurred on.","enum":["MAIN","SUB_ACCOUNT","OFFRAMP_ACCOUNT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.4.accountType","typeLabel":"enum\u003cstring>"},"activityAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.4.activityAt","typeLabel":"string\u003cdate-time>"},"reference":{"type":"string","description":"Customer-facing reference of the source transaction.","uniqueKey":"oneOf.4.reference","typeLabel":"string"},"subAccountId":{"type":"string","format":"uuid","description":"Set when accountType is SUB_ACCOUNT.","uniqueKey":"oneOf.4.subAccountId","typeLabel":"string\u003cuuid>"},"accountTransactionId":{"type":"string","description":"Identifier of the transaction on the ledger account, when available.","uniqueKey":"oneOf.4.accountTransactionId","typeLabel":"string"},"groupId":{"type":"string","format":"uuid","description":"Links related activities together, e.g. the two legs of an internal\ntransfer, or an offramp deposit and its refund.\n","uniqueKey":"oneOf.4.groupId","typeLabel":"string\u003cuuid>"},"narration":{"type":"string","uniqueKey":"oneOf.4.narration","typeLabel":"string"}},"uniqueKey":"oneOf.4","typeLabel":"object"},{"type":"object","description":"A single entry in the aggregated account activity feed. The concrete subtype is\ndetermined by the activityType discriminator; the type field carries the\nsemantic category for filtering and display.\n","required":["id","activityType","type","direction","amount","currency","status","activityAt","accountId","accountType","activityData"],"x-source-svc":"ledger","properties":{"activityData":{"type":"object","additionalProperties":false,"required":["reference","sourceAccountId","destinationAccountId","amount","currency","status","createdDate"],"properties":{"reference":{"type":"string","description":"Transfer reference","example":"ITR123456","isRequired":true,"uniqueKey":"oneOf.5.activityData.reference","typeLabel":"string"},"sourceAccountId":{"type":"string","format":"uuid","description":"Source account ID","isRequired":true,"uniqueKey":"oneOf.5.activityData.sourceAccountId","typeLabel":"string\u003cuuid>"},"destinationAccountId":{"type":"string","format":"uuid","description":"Destination account ID","isRequired":true,"uniqueKey":"oneOf.5.activityData.destinationAccountId","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"Transfer amount","example":100,"isRequired":true,"uniqueKey":"oneOf.5.activityData.amount","typeLabel":"number"},"currency":{"type":"string","description":"Transfer currency","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.activityData.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":"oneOf.5.activityData.status","typeLabel":"enum\u003cstring>"},"createdDate":{"type":"string","format":"date-time","description":"Transfer creation date","isRequired":true,"uniqueKey":"oneOf.5.activityData.createdDate","typeLabel":"string\u003cdate-time>"},"sourceAccountRef":{"type":"string","description":"The transaction reference on the source account.","uniqueKey":"oneOf.5.activityData.sourceAccountRef","typeLabel":"string"},"destinationAccountRef":{"type":"string","description":"The transaction reference on the destination account.","uniqueKey":"oneOf.5.activityData.destinationAccountRef","typeLabel":"string"},"description":{"type":"string","description":"Transfer description","uniqueKey":"oneOf.5.activityData.description","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.5.activityData","typeLabel":"object"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.5.id","typeLabel":"string\u003cuuid>"},"activityType":{"type":"string","description":"Discriminator; the concrete activity model name, e.g. CashDepositActivity.\n","isRequired":true,"uniqueKey":"oneOf.5.activityType","typeLabel":"string"},"type":{"type":"string","description":"Semantic category of a transaction activity feed entry.","enum":["CASH_DEPOSIT","CASH_PAYMENT","ACCOUNT_NUMBER_DEPOSIT","CRYPTO_WITHDRAWAL","CRYPTO_DEPOSIT","INTERNAL_TRANSFER","OFFRAMP_DEPOSIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.5.type","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["CREDIT","DEBIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.5.direction","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Always positive; see direction for credit/debit.","example":100,"isRequired":true,"uniqueKey":"oneOf.5.amount","typeLabel":"number"},"currency":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.5.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":"oneOf.5.status","typeLabel":"enum\u003cstring>"},"accountId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.5.accountId","typeLabel":"string\u003cuuid>"},"accountType":{"type":"string","description":"The kind of account a transaction activity occurred on.","enum":["MAIN","SUB_ACCOUNT","OFFRAMP_ACCOUNT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.5.accountType","typeLabel":"enum\u003cstring>"},"activityAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.5.activityAt","typeLabel":"string\u003cdate-time>"},"reference":{"type":"string","description":"Customer-facing reference of the source transaction.","uniqueKey":"oneOf.5.reference","typeLabel":"string"},"subAccountId":{"type":"string","format":"uuid","description":"Set when accountType is SUB_ACCOUNT.","uniqueKey":"oneOf.5.subAccountId","typeLabel":"string\u003cuuid>"},"accountTransactionId":{"type":"string","description":"Identifier of the transaction on the ledger account, when available.","uniqueKey":"oneOf.5.accountTransactionId","typeLabel":"string"},"groupId":{"type":"string","format":"uuid","description":"Links related activities together, e.g. the two legs of an internal\ntransfer, or an offramp deposit and its refund.\n","uniqueKey":"oneOf.5.groupId","typeLabel":"string\u003cuuid>"},"narration":{"type":"string","uniqueKey":"oneOf.5.narration","typeLabel":"string"}},"uniqueKey":"oneOf.5","typeLabel":"object"},{"type":"object","description":"A single entry in the aggregated account activity feed. The concrete subtype is\ndetermined by the activityType discriminator; the type field carries the\nsemantic category for filtering and display.\n","required":["id","activityType","type","direction","amount","currency","status","activityAt","accountId","accountType","activityData"],"x-source-svc":"ledger","properties":{"activityData":{"type":"object","description":"Details of an offramp account transaction.","required":["id","reference","currency","status","payoutCurrency","amount","rate","payoutAmount","createdDate","recipient"],"x-source-svc":"ledger","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.6.activityData.id","typeLabel":"string\u003cuuid>"},"reference":{"type":"string","description":"Reference for the cash payment transaction at initiation.","isRequired":true,"uniqueKey":"oneOf.6.activityData.reference","typeLabel":"string"},"currency":{"type":"string","description":"Currency in which the account was debited.","example":"USD","isRequired":true,"uniqueKey":"oneOf.6.activityData.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":"oneOf.6.activityData.status","typeLabel":"enum\u003cstring>"},"payoutCurrency":{"type":"string","description":"Currency in which the beneficiary will be paid out.","example":"NGN","isRequired":true,"uniqueKey":"oneOf.6.activityData.payoutCurrency","typeLabel":"string"},"amount":{"type":"number","description":"Amount transferred.","example":100,"isRequired":true,"uniqueKey":"oneOf.6.activityData.amount","typeLabel":"number"},"rate":{"type":"number","description":"Exchange rate applied for this transfer.","example":1450.75,"isRequired":true,"uniqueKey":"oneOf.6.activityData.rate","typeLabel":"number"},"payoutAmount":{"type":"number","description":"Amount paid out to the beneficiary in payout currency.","example":145075,"isRequired":true,"uniqueKey":"oneOf.6.activityData.payoutAmount","typeLabel":"number"},"recipient":{"type":"object","description":"Basic information about a beneficiary as at the time of transaction.","required":["id","accountName","beneficiaryType","accountIdentifier","paymentChannelId"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the beneficiary.","isRequired":true,"uniqueKey":"oneOf.6.activityData.recipient.id","typeLabel":"string\u003cuuid>"},"accountName":{"type":"string","description":"Name on the account","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.6.activityData.recipient.accountName","typeLabel":"string"},"beneficiaryType":{"type":"string","description":"Type of beneficiary object.","example":"BeneficiaryLocalBankAccount","isRequired":true,"uniqueKey":"oneOf.6.activityData.recipient.beneficiaryType","typeLabel":"string"},"accountIdentifier":{"type":"string","description":"The account identifier at the bank. For mobile money, this is the phone number on account, for P2P wallet, this is the account ID\nWhere routing number or sort code is present, this would be `{routingNumber}-{accountNumber}`\n","example":"230101010","isRequired":true,"uniqueKey":"oneOf.6.activityData.recipient.accountIdentifier","typeLabel":"string"},"paymentChannelId":{"type":"string","description":"Identifier of the payment channel used for this transaction, if available. This can be used to determine the exact payment method used for the transaction.","example":"BANK_TRANSFER_NIGERIA","isRequired":true,"uniqueKey":"oneOf.6.activityData.recipient.paymentChannelId","typeLabel":"string"},"bankName":{"type":"string","description":"Name of the receiving bank, for mobile money this would be the network, and for P2P wallet it will be the name of the account provider\n","example":"Great Bank LLC","uniqueKey":"oneOf.6.activityData.recipient.bankName","typeLabel":"string"},"country":{"type":"string","description":"Country where the payment method belongs if available","example":"IE","uniqueKey":"oneOf.6.activityData.recipient.country","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.6.activityData.recipient","typeLabel":"object"},"createdDate":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.6.activityData.createdDate","typeLabel":"string\u003cdate-time>"},"accountTransactionId":{"type":"string","description":"Identifier of the transaction on the account.","uniqueKey":"oneOf.6.activityData.accountTransactionId","typeLabel":"string"},"providerReference":{"type":"string","description":"Reference provided by the cash payment provider.","example":"PROV123456","uniqueKey":"oneOf.6.activityData.providerReference","typeLabel":"string"},"offrampAccountId":{"type":"string","format":"uuid","description":"Identifier of the offramp account associated with this transaction.","uniqueKey":"oneOf.6.activityData.offrampAccountId","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":"oneOf.6.activityData.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":"oneOf.6.activityData.blockchainInfo.recipient.address","typeLabel":"string"},"memo":{"type":"string","description":"Memo for blockchains where memo is required.","example":"1290122112","uniqueKey":"oneOf.6.activityData.blockchainInfo.recipient.memo","typeLabel":"string"}},"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.6.activityData.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":"oneOf.6.activityData.blockchainInfo.value","typeLabel":"number"},"tokenSymbol":{"example":"USDT","description":"Token symbol","type":"string","isRequired":true,"uniqueKey":"oneOf.6.activityData.blockchainInfo.tokenSymbol","typeLabel":"string"},"senderAddress":{"type":"string","description":"The address of the sender.","example":"0x2b059a574a35e60b228d10d54fec2671de4928e1","uniqueKey":"oneOf.6.activityData.blockchainInfo.senderAddress","typeLabel":"string"},"blockNumber":{"type":"integer","format":"int64","example":20564802,"uniqueKey":"oneOf.6.activityData.blockchainInfo.blockNumber","typeLabel":"integer\u003cint64>"},"timestamp":{"type":"integer","format":"int64","description":"Transaction block timestamp.","uniqueKey":"oneOf.6.activityData.blockchainInfo.timestamp","typeLabel":"integer\u003cint64>"},"explorerUrl":{"type":"string","format":"url","description":"URL to view the transaction on a blockchain explorer.","uniqueKey":"oneOf.6.activityData.blockchainInfo.explorerUrl","typeLabel":"string\u003curl>"}},"x-source-svc":"ledger","uniqueKey":"oneOf.6.activityData.blockchainInfo","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.6.activityData","typeLabel":"object"},"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.6.id","typeLabel":"string\u003cuuid>"},"activityType":{"type":"string","description":"Discriminator; the concrete activity model name, e.g. CashDepositActivity.\n","isRequired":true,"uniqueKey":"oneOf.6.activityType","typeLabel":"string"},"type":{"type":"string","description":"Semantic category of a transaction activity feed entry.","enum":["CASH_DEPOSIT","CASH_PAYMENT","ACCOUNT_NUMBER_DEPOSIT","CRYPTO_WITHDRAWAL","CRYPTO_DEPOSIT","INTERNAL_TRANSFER","OFFRAMP_DEPOSIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.6.type","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["CREDIT","DEBIT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.6.direction","typeLabel":"enum\u003cstring>"},"amount":{"type":"number","description":"Always positive; see direction for credit/debit.","example":100,"isRequired":true,"uniqueKey":"oneOf.6.amount","typeLabel":"number"},"currency":{"type":"string","example":"USD","isRequired":true,"uniqueKey":"oneOf.6.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":"oneOf.6.status","typeLabel":"enum\u003cstring>"},"accountId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.6.accountId","typeLabel":"string\u003cuuid>"},"accountType":{"type":"string","description":"The kind of account a transaction activity occurred on.","enum":["MAIN","SUB_ACCOUNT","OFFRAMP_ACCOUNT"],"x-source-svc":"ledger","isRequired":true,"uniqueKey":"oneOf.6.accountType","typeLabel":"enum\u003cstring>"},"activityAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.6.activityAt","typeLabel":"string\u003cdate-time>"},"reference":{"type":"string","description":"Customer-facing reference of the source transaction.","uniqueKey":"oneOf.6.reference","typeLabel":"string"},"subAccountId":{"type":"string","format":"uuid","description":"Set when accountType is SUB_ACCOUNT.","uniqueKey":"oneOf.6.subAccountId","typeLabel":"string\u003cuuid>"},"accountTransactionId":{"type":"string","description":"Identifier of the transaction on the ledger account, when available.","uniqueKey":"oneOf.6.accountTransactionId","typeLabel":"string"},"groupId":{"type":"string","format":"uuid","description":"Links related activities together, e.g. the two legs of an internal\ntransfer, or an offramp deposit and its refund.\n","uniqueKey":"oneOf.6.groupId","typeLabel":"string\u003cuuid>"},"narration":{"type":"string","uniqueKey":"oneOf.6.narration","typeLabel":"string"}},"uniqueKey":"oneOf.6","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"activityData":{"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"}}},"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","activityType":"\u003cstring>","type":"CASH_DEPOSIT","direction":"CREDIT","amount":100,"currency":"USD","status":"PENDING","accountId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","accountType":"MAIN","activityAt":"2023-11-07T05:31:56Z","reference":"\u003cstring>","subAccountId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","accountTransactionId":"\u003cstring>","groupId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","narration":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"01af1223-c955-487d-954c-5431b1391b1f":{"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"},"7bf6d592-31cc-4537-a32b-f0bd82d9ae00":{"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"},"16b0e179-dad0-445a-add3-c756872cd3c3":{"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"},"ac2a2c66-fd5a-4a84-acee-3f7f39b36967":{"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"},"67296eb2-0352-4ecd-b400-34ca2c53bb15":{"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":{"876b3d6e-d150-47c9-b046-1fb217d3258c":{"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.358Z","originalFileLocation":"api-reference/endpoints/transaction-activities/subaccount-activity-by-id.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 transaction activity by its 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/transaction-activities/subaccount-activity-by-id\">\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/transaction-activities/subaccount-activity-by-id\">\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/transaction-activities/subaccount-activity-by-id.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/transaction-activities/subaccount-activity-by-id#webpage\",\"url\":\"https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/subaccount-activity-by-id\",\"name\":\"Get Sub-account Activity\",\"description\":\"This operation allows the client to fetch a specific transaction activity by its ID.\",\"dateModified\":\"2026-07-24T16:00:25.358Z\",\"isPartOf\":{\"@id\":\"https://docs.onboard.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/subaccount-activity-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/subaccount-activity-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Transaction Activities\",\"item\":\"https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/account-activities\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Sub-account Activity\",\"item\":\"https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/subaccount-activity-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/subaccount-activity-by-id#apireference\",\"headline\":\"Get Sub-account Activity\",\"name\":\"Get Sub-account Activity\",\"description\":\"This operation allows the client to fetch a specific transaction activity by its ID.\",\"url\":\"https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/subaccount-activity-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/transaction-activities/subaccount-activity-by-id#webpage\"},\"image\":\"https://docs.onboard.xyz/images/og-default.png\",\"dateModified\":\"2026-07-24T16:00:25.358Z\",\"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","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","description":"This operation allows the client to fetch a paginated, aggregated feed of all\ntransaction activities for a sub-account (cash deposits/payments, account-number\ndeposits, crypto deposits/withdrawals, internal transfers, offramp deposits),\neach with type-specific details in activityData.\n","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","description":"This operation allows the client to fetch a paginated, aggregated feed of all\ntransaction activity for the authenticated business, optionally scoped to a\nsingle account, with the same type-specific activityData as the account-scoped\nactivities endpoint.\n","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_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}