success, data, message, request_id, and code on failure: see Responses and errors
Permissions
Each endpoint lists the permission and feature it needs
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Mesh API","description":"Larkwave's developer API for banks' merchants: virtual accounts, wallets, transfers and webhooks.","colors":{"primary":"#010101","light":"#F8F8F8","dark":"#010101"},"logo":{"light":"https://mintcdn.com/larkwave/nOIrgR_JCvWNBbxN/logo/light.svg?fit=max\u0026auto=format\u0026n=nOIrgR_JCvWNBbxN\u0026q=85\u0026s=7d78510efe99e219c0100e6917041836","dark":"https://mintcdn.com/larkwave/nOIrgR_JCvWNBbxN/logo/dark.svg?fit=max\u0026auto=format\u0026n=nOIrgR_JCvWNBbxN\u0026q=85\u0026s=b47846821dd1ad074ed3b9014438b2df","href":"/"},"favicon":"https://mintcdn.com/larkwave/nOIrgR_JCvWNBbxN/favicon.svg?fit=max\u0026auto=format\u0026n=nOIrgR_JCvWNBbxN\u0026q=85\u0026s=631d5afb78efb959f058c088ec58dffe","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]}},"appearance":{"default":"light"},"background":{"color":{"light":"#FFFFFF","dark":"#010101"}},"navbar":{"primary":{"type":"button","label":"API reference","href":"/api-reference/introduction"}},"fonts":{"family":"Plus Jakarta Sans"},"styling":{"codeblocks":"system","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"larkwave","hasAudioNarration":false,"actualSubdomain":"larkwave","customDomains":[],"gitSource":{"type":"github","owner":"larkwavehq","repo":"mesh-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6b01c2ff588e0c4cc9a8ccfa"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b01c7a9a45c807fee73f6b9","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":53},{"language":"default","tag":"Guides","count":17},{"language":"default","tag":"Virtual accounts","count":11},{"language":"default","tag":"Essentials","count":6},{"language":"default","tag":"Wallets","count":6},{"language":"default","tag":"Webhook endpoint","count":5},{"language":"default","tag":"Events","count":4},{"language":"default","tag":"Accounts","count":4},{"language":"default","tag":"Customers","count":4},{"language":"default","tag":"Get started","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"API reference","description":"Every Mesh endpoint, with a playground.","href":"/api-reference/introduction"},"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: \"Every Mesh endpoint, with a playground.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Each page in this section is generated from Mesh’s OpenAPI description, with a playground to try the call.`}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://\u003cyour bank's Mesh host>/v1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`Your bank gives you the host. One URL serves test and live; the key decides which.`}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`Send your key in the `,_jsx(_components.code,{children:`X-Api-Key`}),` header, from an address on the key’s allowlist. In the playground, use a `,_jsx(_components.strong,{children:`test`}),` key. See `,_jsx(_components.a,{href:`/essentials/authentication`,children:`Authentication`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`conventions`,children:`Conventions`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{}),_jsx(_components.th,{})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Format`}),_jsxs(_components.td,{children:[`JSON in and out, `,_jsx(_components.code,{children:`snake_case`}),` fields`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Amounts`}),_jsxs(_components.td,{children:[`Integers in kobo: `,_jsx(_components.code,{children:`amount_minor: 150000`}),` is ₦1,500.00`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Times`}),_jsx(_components.td,{children:`ISO 8601, UTC`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Creates`}),_jsxs(_components.td,{children:[`Need an `,_jsx(_components.code,{children:`Idempotency-Key`}),` header: see `,_jsx(_components.a,{href:`/essentials/idempotency`,children:`Idempotency`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Lists`}),_jsxs(_components.td,{children:[`Newest first, `,_jsx(_components.code,{children:`limit`}),` and `,_jsx(_components.code,{children:`cursor`}),`: see `,_jsx(_components.a,{href:`/essentials/pagination`,children:`Pagination`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Responses`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`success`}),`, `,_jsx(_components.code,{children:`data`}),`, `,_jsx(_components.code,{children:`message`}),`, `,_jsx(_components.code,{children:`request_id`}),`, and `,_jsx(_components.code,{children:`code`}),` on failure: see `,_jsx(_components.a,{href:`/essentials/responses-and-errors`,children:`Responses and errors`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Permissions`}),_jsx(_components.td,{children:`Each endpoint lists the permission and feature it needs`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"API reference","description":"Every Mesh endpoint, with a playground.","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Conventions","slug":"conventions","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"larkwave","siteName":"Mesh API","title":"API reference - Mesh API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-21T16:32:48.088Z","originalFileLocation":"api-reference/introduction.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=\"light\"}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=\"Every Mesh endpoint, with a playground.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Mesh API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/larkwave/XKiizyyxIXhj2DX5/_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/larkwave/XKiizyyxIXhj2DX5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/larkwave/XKiizyyxIXhj2DX5/_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/larkwave/XKiizyyxIXhj2DX5/_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/larkwave/XKiizyyxIXhj2DX5/_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/larkwave/XKiizyyxIXhj2DX5/_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/larkwave/XKiizyyxIXhj2DX5/_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/larkwave/XKiizyyxIXhj2DX5/_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/larkwave/XKiizyyxIXhj2DX5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API reference - Mesh API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Every Mesh endpoint, with a playground.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Mesh API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://larkwave.mintlify.app/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://larkwave.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=API+reference\u0026amp;description=Every+Mesh+endpoint%2C+with+a+playground.\u0026amp;theme=0b933353cf8a9c4d33326dfe\u0026amp;signature=6f7f07ac69de9377ad6715a0dbf7f5ecb817f78c313b6f772ee0c05a1e67269e\">\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=\"API reference - Mesh API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Every Mesh endpoint, with a playground.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://larkwave.mintlify.site/_mintlify/api/og/v2?division=Overview\u0026amp;title=API+reference\u0026amp;description=Every+Mesh+endpoint%2C+with+a+playground.\u0026amp;theme=0b933353cf8a9c4d33326dfe\u0026amp;signature=6f7f07ac69de9377ad6715a0dbf7f5ecb817f78c313b6f772ee0c05a1e67269e\">\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/larkwave/XKiizyyxIXhj2DX5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Mesh API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#010101\">\u003clink data-mint-head rel=\"canonical\" href=\"https://larkwave.mintlify.app/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://larkwave.mintlify.app/#organization\",\"name\":\"Mesh API\",\"url\":\"https://larkwave.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/larkwave/nOIrgR_JCvWNBbxN/logo/light.svg?fit=max\u0026auto=format\u0026n=nOIrgR_JCvWNBbxN\u0026q=85\u0026s=7d78510efe99e219c0100e6917041836\"}},{\"@type\":\"WebSite\",\"@id\":\"https://larkwave.mintlify.app#website\",\"name\":\"Mesh API\",\"url\":\"https://larkwave.mintlify.app\",\"publisher\":{\"@id\":\"https://larkwave.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://larkwave.mintlify.app/api-reference/introduction#webpage\",\"url\":\"https://larkwave.mintlify.app/api-reference/introduction\",\"name\":\"API reference\",\"description\":\"Every Mesh endpoint, with a playground.\",\"dateModified\":\"2026-11-21T16:32:48.088Z\",\"isPartOf\":{\"@id\":\"https://larkwave.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://larkwave.mintlify.app/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://larkwave.mintlify.app/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Mesh API\",\"item\":\"https://larkwave.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API reference\",\"item\":\"https://larkwave.mintlify.app/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://larkwave.mintlify.app/api-reference/introduction#article\",\"headline\":\"API reference\",\"name\":\"API reference\",\"description\":\"Every Mesh endpoint, with a playground.\",\"url\":\"https://larkwave.mintlify.app/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://larkwave.mintlify.app/api-reference/introduction#webpage\"},\"dateModified\":\"2026-11-21T16:32:48.088Z\",\"publisher\":{\"@id\":\"https://larkwave.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://larkwave.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Mesh API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Mesh API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/introduction.md","siteName":"Mesh API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Account names","pages":[{"title":"Look up an account name","description":"The name on an account at any bank, asked of that bank (a name enquiry): account_number and bank_code (from GET /v1/banks). name_enquiry_ref is the enquiry's reference for the transfer that follows. Never cached.\n\n**Required permission:** `transfers:write`, `feature:TRANSFERS_INTERBANK`","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/account-names","href":"/api-reference/account-names/look-up-an-account-name"},{"title":"Get a bank number's name","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/account-names/{accountNumber}","href":"/api-reference/account-names/get-a-bank-numbers-name"}]},{"group":"Accounts","pages":[{"title":"Get a balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/accounts/{accountNumber}/balance","href":"/api-reference/accounts/get-a-balance"},{"title":"List an account's transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/accounts/{accountNumber}/transactions","href":"/api-reference/accounts/list-an-accounts-transactions"},{"title":"Get an account's transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/accounts/{accountNumber}/transactions/{transactionId}","href":"/api-reference/accounts/get-an-accounts-transaction"},{"title":"Get an account's limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/accounts/{accountNumber}/limits","href":"/api-reference/accounts/get-an-accounts-limits"}]},{"group":"Banks","pages":[{"title":"List banks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/banks","href":"/api-reference/banks/list-banks"}]},{"group":"Business transactions","pages":[{"title":"List the business's transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/transactions","href":"/api-reference/business-transactions/list-the-businesss-transactions"},{"title":"Get a business transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/transactions/{transactionId}","href":"/api-reference/business-transactions/get-a-business-transaction"}]},{"group":"Charges","pages":[{"title":"Get a charge statement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/charges/statement","href":"/api-reference/charges/get-a-charge-statement"}]},{"group":"Collection settlements","pages":[{"title":"List collection settlements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/collection-settlements","href":"/api-reference/collection-settlements/list-collection-settlements"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/customers","href":"/api-reference/customers/list-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/customers","href":"/api-reference/customers/create-a-customer"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/customers/{customerId}","href":"/api-reference/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/customers/{customerId}","href":"/api-reference/customers/update-a-customer"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/events","href":"/api-reference/events/list-events"},{"title":"Get an event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/events/{eventId}","href":"/api-reference/events/get-an-event"}]},{"group":"Number patterns","pages":[{"title":"List number patterns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/number-patterns","href":"/api-reference/number-patterns/list-number-patterns"}]},{"group":"Payments","pages":[{"title":"Get a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/payments/{paymentId}","href":"/api-reference/payments/get-a-payment"},{"title":"Accept a held payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/payments/{paymentId}/accept","href":"/api-reference/payments/accept-a-held-payment"}]},{"group":"Reference data","pages":[{"title":"List countries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/reference/countries","href":"/api-reference/reference-data/list-countries"},{"title":"List customer types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/reference/customer-types","href":"/api-reference/reference-data/list-customer-types"}]},{"group":"Settlement accounts","pages":[{"title":"List settlement accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/settlement-accounts","href":"/api-reference/settlement-accounts/list-settlement-accounts"}]},{"group":"Settlements","pages":[{"title":"Settle to your bank account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/settlements","href":"/api-reference/settlements/settle-to-your-bank-account"},{"title":"Get a settlement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/settlements/{transactionId}","href":"/api-reference/settlements/get-a-settlement"}]},{"group":"Simulations","pages":[{"title":"Simulate an inflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/simulations/inflows","href":"/api-reference/simulations/simulate-an-inflow"}]},{"group":"Status","pages":[{"title":"Get key status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/status","href":"/api-reference/status/get-key-status"}]},{"group":"Transfers","pages":[{"title":"Make an internal transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transfers/internal","href":"/api-reference/transfers/make-an-internal-transfer"},{"title":"Make an interbank transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transfers/interbank","href":"/api-reference/transfers/make-an-interbank-transfer"},{"title":"Get an interbank transfer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/transfers/interbank/{transactionId}","href":"/api-reference/transfers/get-an-interbank-transfer"}]},{"group":"Verifications","pages":[{"title":"Run a verification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/verifications/{checkType}","href":"/api-reference/verifications/run-a-verification"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/verifications","href":"/api-reference/verifications/list-verifications"},{"title":"Get a verification","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/verifications/{verificationId}","href":"/api-reference/verifications/get-a-verification"}]},{"group":"Virtual accounts","pages":[{"title":"List virtual accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/virtual-accounts","href":"/api-reference/virtual-accounts/list-virtual-accounts"},{"title":"Create a virtual account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/virtual-accounts","href":"/api-reference/virtual-accounts/create-a-virtual-account"},{"title":"Get a virtual account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/virtual-accounts/{accountId}","href":"/api-reference/virtual-accounts/get-a-virtual-account"},{"title":"Rename or label an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/virtual-accounts/{accountId}","href":"/api-reference/virtual-accounts/rename-or-label-an-account"},{"title":"Cancel a dynamic account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/virtual-accounts/{accountId}/cancel","href":"/api-reference/virtual-accounts/cancel-a-dynamic-account"},{"title":"List an account's payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/virtual-accounts/{accountId}/payments","href":"/api-reference/virtual-accounts/list-an-accounts-payments"},{"title":"Name a number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/virtual-accounts/numbers/{accountNumber}","href":"/api-reference/virtual-accounts/name-a-number"},{"title":"List an account's settlements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/virtual-accounts/{accountId}/settlements","href":"/api-reference/virtual-accounts/list-an-accounts-settlements"}]},{"group":"Wallets","pages":[{"title":"List wallets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/wallets","href":"/api-reference/wallets/list-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/wallets","href":"/api-reference/wallets/create-a-wallet"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/wallets/{walletId}","href":"/api-reference/wallets/get-a-wallet"}]},{"group":"Webhook deliveries","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-deliveries","href":"/api-reference/webhook-deliveries/list-webhook-deliveries"},{"title":"Get a webhook delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-deliveries/{deliveryId}","href":"/api-reference/webhook-deliveries/get-a-webhook-delivery"},{"title":"Retry a webhook delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-deliveries/{deliveryId}/retry","href":"/api-reference/webhook-deliveries/retry-a-webhook-delivery"}]},{"group":"Webhook endpoint","pages":[{"title":"Get the webhook URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoint","href":"/api-reference/webhook-endpoint/get-the-webhook-url"},{"title":"Set the webhook URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/webhook-endpoint","href":"/api-reference/webhook-endpoint/set-the-webhook-url"},{"title":"Remove the webhook URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/webhook-endpoint","href":"/api-reference/webhook-endpoint/remove-the-webhook-url"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoint/test","href":"/api-reference/webhook-endpoint/send-a-test-event"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoint/rotate-secret","href":"/api-reference/webhook-endpoint/rotate-the-signing-secret"}]}]}]},"basePath":"","title":"API reference - Mesh API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}