Account: Create and manage user accounts, bank accounts, and profiles.Ramp: Initiate onramp (fiat-to-crypto) and offramp (crypto-to-fiat) transactions. This is the core of the Partna API.Rate: Fetch conversion rates and create/verify rate keys for locking prices.Transfer: Create transfers, initiate payouts, convert currencies, and withdraw balances.KYC: Identity verification flows including BVN verification, OTP confirmation, and bank account resolution.Bank: List supported banks by currency.Discount: Fetch current volume-based discount tiers.Supported: List supported crypto assets and networks.User: Manage merchant settings, API keys, webhook URLs, balances, and admin access.MFA: Enable and manage multi-factor authentication for accounts.Mock (Staging Only): Simulate deposits for testing.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Partna API docs","colors":{"primary":"#00CC66","light":"#07C983","dark":"#00CC66"},"logo":{"light":"https://mintcdn.com/partna-75/8csf5k99mps6ESTh/logo/light.svg?fit=max\u0026auto=format\u0026n=8csf5k99mps6ESTh\u0026q=85\u0026s=0a3f1e79f7ab8a14ce0c94f1c39c2778","dark":"https://mintcdn.com/partna-75/8csf5k99mps6ESTh/logo/dark.svg?fit=max\u0026auto=format\u0026n=8csf5k99mps6ESTh\u0026q=85\u0026s=4ac6fa0c663054391585ba774f0db804"},"favicon":"https://mintcdn.com/partna-75/8csf5k99mps6ESTh/favicon.svg?fit=max\u0026auto=format\u0026n=8csf5k99mps6ESTh\u0026q=85\u0026s=6d9210e1f7645a7e99ccfbd18c50921b","api":{"openapi":["api-reference/ventogram.yml","api-reference/biz.yml","api-reference/partna.json"]},"navbar":{"links":[{"href":"mailto:dev@getpartna.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.getpartna.com"}},"footer":{"socials":{"twitter":"https://twitter.com/getpartna","linkedin":"https://www.linkedin.com/company/getpartna"}},"seo":{"metatags":{"og:image":"https://res.cloudinary.com/payourse-technologies-inc/image/upload/v1710838758/seo-partna/dev_doc_cu1aax.jpg"},"indexing":"navigable"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"partna-75","hasAudioNarration":false,"actualSubdomain":"partna-75","customDomains":["docs.getpartna.com"],"gitSource":{"type":"github","owner":"ventogram-admin","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a6b33d5ed6e717ed8a3c71c","collectionId":"8be3c478-f4c8-48e8-a3e0-9d6d4f60ad10","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a6b33d5ed6e717ed8a3c71c"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6a6b33d5ed6e717ed8a3c71c:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":67},{"language":"default","tag":"User","count":20},{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"KYC","count":12},{"language":"default","tag":"Account","count":10},{"language":"default","tag":"Transfer","count":6},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"MFA","count":4},{"language":"default","tag":"Ramp","count":4},{"language":"default","tag":"Getting Started","count":4}]},"assistantConfig":{},"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v4/api-reference/overview","slug":"/v4/api-reference/overview","pageMetadata":{"title":"API Reference","description":"Complete reference for all Partna API endpoints","icon":"book-open","href":"/v4/api-reference/overview"},"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: \"Complete reference for all Partna API endpoints\"\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:`This is the complete reference for the Partna v4 API. All endpoints use the same base URL and authentication pattern.`}),`\n`,_jsx(Heading,{level:`2`,id:`base-urls`,children:`Base URLs`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Environment`}),_jsx(_components.th,{children:`Base URL`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Staging`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://staging-api.getpartna.com/v4`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Production`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://api.getpartna.com/v4`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`All requests require two headers:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,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:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`x-api-key: YOUR_API_KEY`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`x-api-user: YOUR_USERNAME`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/v4/documentation/authentication`,children:`Authentication`}),` for details.`]}),`\n`,_jsx(Heading,{level:`2`,id:`request-format`,children:`Request format`}),`\n`,_jsxs(_components.p,{children:[`All `,_jsx(_components.code,{children:`POST`}),` and `,_jsx(_components.code,{children:`PUT`}),` requests accept JSON bodies. Set the `,_jsx(_components.code,{children:`Content-Type: application/json`}),` header.`]}),`\n`,_jsx(Heading,{level:`2`,id:`response-format`,children:`Response format`}),`\n`,_jsx(_components.p,{children:`All responses return JSON with this structure:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"success\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Error responses include a descriptive message:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,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:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Description of what went wrong\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`endpoint-groups`,children:`Endpoint groups`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Account`}),`: Create and manage user accounts, bank accounts, and profiles.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Ramp`}),`: Initiate onramp (fiat-to-crypto) and offramp (crypto-to-fiat) transactions. This is the core of the Partna API.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Rate`}),`: Fetch conversion rates and create/verify rate keys for locking prices.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Transfer`}),`: Create transfers, initiate payouts, convert currencies, and withdraw balances.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`KYC`}),`: Identity verification flows including BVN verification, OTP confirmation, and bank account resolution.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Bank`}),`: List supported banks by currency.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Discount`}),`: Fetch current volume-based discount tiers.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Supported`}),`: List supported crypto assets and networks.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`User`}),`: Manage merchant settings, API keys, webhook URLs, balances, and admin access.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`MFA`}),`: Enable and manage multi-factor authentication for accounts.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Mock (Staging Only)`}),`: Simulate deposits for testing.`]})]})}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":{"config":{},"pageMetadata":{"title":"API Reference","description":"Complete reference for all Partna API endpoints","icon":"book-open","href":"/v4/api-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URLs","slug":"base-urls","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Request format","slug":"request-format","depth":2,"children":[]},{"title":"Response format","slug":"response-format","depth":2,"children":[]},{"title":"Endpoint groups","slug":"endpoint-groups","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"partna-75","siteName":"Partna API docs","title":"API Reference - Partna API docs","navMaps":{"firstHrefInVersion":{"v4":{"href":"/v4/api-reference/overview","matchLevel":0},"v2":{"href":"/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-03-26T00:19:37.120Z","originalFileLocation":"v4/api-reference/overview.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=\"Complete reference for all Partna API endpoints\">\u003cmeta data-mint-head name=\"application-name\" content=\"Partna API docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/partna-75/HZ97Up7a_BjtHf3r/_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/partna-75/HZ97Up7a_BjtHf3r/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/partna-75/HZ97Up7a_BjtHf3r/_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/partna-75/HZ97Up7a_BjtHf3r/_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/partna-75/HZ97Up7a_BjtHf3r/_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/partna-75/HZ97Up7a_BjtHf3r/_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/partna-75/HZ97Up7a_BjtHf3r/_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/partna-75/HZ97Up7a_BjtHf3r/_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/partna-75/HZ97Up7a_BjtHf3r/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Reference - Partna API docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Complete reference for all Partna API endpoints\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Partna API docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getpartna.com/v4/api-reference/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://res.cloudinary.com/payourse-technologies-inc/image/upload/v1710838758/seo-partna/dev_doc_cu1aax.jpg\">\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 - Partna API docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Complete reference for all Partna API endpoints\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://res.cloudinary.com/payourse-technologies-inc/image/upload/v1710838758/seo-partna/dev_doc_cu1aax.jpg\">\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/partna-75/HZ97Up7a_BjtHf3r/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Partna API docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00CC66\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getpartna.com/v4/api-reference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v4/api-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getpartna.com/#organization\",\"name\":\"Partna API docs\",\"url\":\"https://docs.getpartna.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/partna-75/8csf5k99mps6ESTh/logo/light.svg?fit=max\u0026auto=format\u0026n=8csf5k99mps6ESTh\u0026q=85\u0026s=0a3f1e79f7ab8a14ce0c94f1c39c2778\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getpartna.com#website\",\"name\":\"Partna API docs\",\"url\":\"https://docs.getpartna.com\",\"publisher\":{\"@id\":\"https://docs.getpartna.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getpartna.com/v4/api-reference/overview#webpage\",\"url\":\"https://docs.getpartna.com/v4/api-reference/overview\",\"name\":\"API Reference\",\"description\":\"Complete reference for all Partna API endpoints\",\"dateModified\":\"2026-03-26T00:19:37.120Z\",\"isPartOf\":{\"@id\":\"https://docs.getpartna.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.getpartna.com/v4/api-reference/overview#article\",\"headline\":\"API Reference\",\"name\":\"API Reference\",\"description\":\"Complete reference for all Partna API endpoints\",\"url\":\"https://docs.getpartna.com/v4/api-reference/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getpartna.com/v4/api-reference/overview#webpage\"},\"image\":\"https://res.cloudinary.com/payourse-technologies-inc/image/upload/v1710838758/seo-partna/dev_doc_cu1aax.jpg\",\"dateModified\":\"2026-03-26T00:19:37.120Z\",\"publisher\":{\"@id\":\"https://docs.getpartna.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getpartna.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Partna API docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Partna API docs","nav":{"global":null,"versions":[{"version":"v4","tabs":[{"tab":"Documentation","icon":"book","pages":[{"title":"Documentation","href":"/v4/documentation/introduction"}]},{"tab":"API Reference","icon":"code","pages":[{"title":"API Reference","icon":"book-open","href":"/v4/api-reference/overview"},{"group":"Account","icon":"user","pages":[{"openapi":"get /account","title":"Get Account","description":"Get all accounts or filter using account name. The account name must be an alphanumeric lowercase hex string between 2 to 40 characters long","href":"/api-reference/endpoint/v3/account/get-account"},{"openapi":"put /account","title":"Create Bank Account","href":"/api-reference/endpoint/v3/account/create-bank-account"},{"openapi":"post /account","title":"Create Account","href":"/api-reference/endpoint/v3/account/create-account"},{"openapi":"get /account/account-details","title":"Get Accounts Details","href":"/api-reference/endpoint/v3/account/get-accounts-details"},{"openapi":"post /account/complete-registration","title":"Complete Account Registration","href":"/api-reference/endpoint/v3/account/complete-account-registration"},{"openapi":"put /account/email","title":"Update Account Email","href":"/api-reference/endpoint/v3/account/update-account-email"},{"openapi":"get /account/permissions","title":"Get Account Permissions","href":"/api-reference/endpoint/v3/account/get-account-permissions"},{"openapi":"get /account/myprofile","title":"Get user Account Profile","href":"/api-reference/endpoint/v3/account/get-account-profile"},{"openapi":"post /account/register","title":"Register Account","href":"/api-reference/endpoint/v3/account/register-account"},{"openapi":"get /account/search","title":"Search Account","href":"/api-reference/endpoint/v3/account/search-account"}]},{"group":"Ramp","icon":"arrow-right-arrow-left","pages":[{"openapi":"get /ramp","title":"Get Ramp Requests","href":"/api-reference/endpoint/v3/ramp/get-ramp-requests"},{"openapi":"post /ramp","title":"Onramp and Offramp","href":"/api-reference/endpoint/v3/ramp/onramp-and-offramp"},{"openapi":"post /ramp/breakdown","title":"Calculate ramp fees from toAmount or fromAmount","href":"/api-reference/endpoint/v3/ramp/calculate-ramp-fees-from-toamount-or-fromamount"},{"openapi":"post /ramp/complete","title":"Handle Ramp","href":"/api-reference/endpoint/v3/ramp/handle-ramp"}]},{"group":"Rate","icon":"chart-line","pages":[{"openapi":"post /convert/preorder","title":"Create a custom ratekey for conversion","href":"/api-reference/endpoint/v3/rate/create-a-custom-ratekey-for-conversion"},{"openapi":"get /rate","title":"Get Rate","href":"/api-reference/endpoint/v3/rate/get-rate"},{"openapi":"get /rate/verify-rate-key","title":"Verify Rate Key","href":"/api-reference/endpoint/v3/rate/verify-rate-key"}]},{"group":"Transfer","icon":"money-bill-transfer","pages":[{"openapi":"post /convert","title":"Convert Currency","href":"/api-reference/endpoint/v3/transfer/convert-currency"},{"openapi":"get /transfer","title":"Get Transfer","href":"/api-reference/endpoint/v3/transfer/get-transfer"},{"openapi":"post /transfer","title":"Create Transfer","href":"/api-reference/endpoint/v3/transfer/create-transfer"},{"openapi":"get /transfer/details","title":"Get Single Transaction","href":"/api-reference/endpoint/v3/transfer/get-single-transaction"},{"openapi":"post /transfer/initiate","title":"Initiate Transfer","href":"/api-reference/endpoint/v3/transfer/initiate-transfer"},{"openapi":"post /transfer/withdraw","title":"Withdraw","href":"/api-reference/endpoint/v3/transfer/withdraw"}]},{"group":"KYC","icon":"id-card","pages":[{"openapi":"post /kyc","title":"Initiate BVN KYC","href":"/api-reference/endpoint/v3/kyc/initiate-bvn-kyc"},{"openapi":"post /kyc/complete-kyc","title":"Merchant KYC users manually","href":"/api-reference/endpoint/v3/kyc/merchant-kyc-users-manually"},{"openapi":"put /kyc/confirm-otp","title":"Confirm KYC OTP","href":"/api-reference/endpoint/v3/kyc/confirm-kyc-otp"},{"openapi":"put /kyc/confirm-phone","title":"Confirm Phone","href":"/api-reference/endpoint/v3/kyc/confirm-phone"},{"openapi":"put /kyc/verification-method","title":"Handle BVN OTP Method","href":"/api-reference/endpoint/v3/kyc/handle-bvn-otp-method-1"},{"openapi":"post /kyc/resolve-account","title":"Resolve Bank","href":"/api-reference/endpoint/v3/kyc/resolve-bank"},{"openapi":"get /kyc/supported-methods","title":"Supported Verification Methods by country","href":"/api-reference/endpoint/v3/kyc/supported-verification-methods-by-country"},{"openapi":"get /user/kyc-exempt","title":"Check for manual kyc ","href":"/api-reference/endpoint/v3/kyc/check-for-manual-kyc"},{"openapi":"post /phone","title":"Initiate user's phone number validation by country","href":"/api-reference/endpoint/v3/kyc/initiate-users-phone-number-validation-by-country"},{"openapi":"get /phone","title":"Used to get a user's verified phone numbers by country","href":"/api-reference/endpoint/v3/kyc/used-to-get-a-users-verified-phone-numbers-by-country"},{"openapi":"put /phone/verify","title":"Validate a user's phone number","href":"/api-reference/endpoint/v3/kyc/validate-a-users-phone-number"},{"openapi":"put /kyc/address","title":"Populate address details for an existing NG KYC record","href":"/api-reference/endpoint/v3/kyc/populate-address-details-for-an-existing-ng-kyc-record"}]},{"group":"Bank","icon":"building-columns","pages":[{"openapi":"get /banks","title":"Get Banks","href":"/api-reference/endpoint/v3/bank/get-banks"}]},{"group":"Discount","icon":"percent","pages":[{"openapi":"get /discount","title":"Get Discounts","href":"/api-reference/endpoint/v3/discount/get-discounts"}]},{"group":"Supported","icon":"coins","pages":[{"openapi":"get /supported/assets","title":"Get Supported Assets","href":"/api-reference/endpoint/v3/supported/get-supported-assets"}]},{"group":"User","icon":"gear","pages":[{"openapi":"put /user","title":"Update User","href":"/api-reference/endpoint/v3/user/update-user"},{"openapi":"post /user/activate","title":"Create User","href":"/api-reference/endpoint/v3/user/create-user"},{"openapi":"get /user/admin","title":"Used to get all active admins with privileges","href":"/api-reference/endpoint/v3/user/used-to-get-all-active-admins-with-privileges"},{"openapi":"post /user/admin","title":"Used to give admin privileges.","href":"/api-reference/endpoint/v3/user/used-to-give-admin-privileges"},{"openapi":"delete /user/admin","title":"Used to delete an admin with privileges","href":"/api-reference/endpoint/v3/user/used-to-delete-an-admin-with-privileges"},{"openapi":"post /user/apikey","title":"Generate API Key","href":"/api-reference/endpoint/v3/user/generate-api-key"},{"openapi":"delete /user/apikey","title":"Delete API Key","href":"/api-reference/endpoint/v3/user/delete-api-key"},{"openapi":"get /user/apikey-scope","title":"Get API Key scopes","href":"/api-reference/endpoint/v3/user/get-api-key-scopes"},{"openapi":"get /user/apikeys","title":"Get API Keys","href":"/api-reference/endpoint/v3/user/get-api-keys"},{"openapi":"get /user/balances","title":"Get Balances","href":"/api-reference/endpoint/v3/user/get-balances"},{"openapi":"post /user/invalidate-apikey","title":"Invalidate API Key","href":"/api-reference/endpoint/v3/user/invalidate-api-key"},{"openapi":"get /user/settings","title":"Get Registration, Deposit and Fee Settings","href":"/api-reference/endpoint/v3/user/get-registration-deposit-and-fee-settings"},{"openapi":"put /user/settings","title":"Registration, Deposit and Fee Settings","href":"/api-reference/endpoint/v3/user/registration-deposit-and-fee-settings"},{"openapi":"get /user/webhook","title":"Get Webhook URL","href":"/api-reference/endpoint/v3/user/get-webhook-url"},{"openapi":"post /user/webhook","title":"Update Webhook URL","href":"/api-reference/endpoint/v3/user/update-webhook-url"},{"openapi":"delete /user/webhook","title":"Delete Webhook URL","href":"/api-reference/endpoint/v3/user/delete-webhook-url"},{"openapi":"get /user/profile","title":"Get Customer's Account Profile","href":"/api-reference/endpoint/v3/user/get-customers-account-profile"},{"openapi":"post /user/ip-whitelist","title":"Add IP to Whitelist","href":"/api-reference/endpoint/v3/admin/add-ip-to-whitelist"},{"openapi":"delete /user/ip-whitelist","title":"Remove IP from Whitelist","href":"/api-reference/endpoint/v3/admin/remove-ip-from-whitelist"},{"openapi":"get /user/ip-whitelist","title":"Get Whitelisted IPs","href":"/api-reference/endpoint/v3/admin/get-whitelisted-ips"}]},{"group":"MFA","icon":"shield-halved","pages":[{"openapi":"get /mfa","title":"Get Account MFA","href":"/api-reference/endpoint/v3/mfa/get-account-mfa"},{"openapi":"put /mfa","title":"Validate Account MFA","href":"/api-reference/endpoint/v3/mfa/validate-account-mfa"},{"openapi":"post /mfa","title":"Enable Account MFA","href":"/api-reference/endpoint/v3/mfa/enable-account-mfa"},{"openapi":"put /mfa/disable","title":"Disable Account MFA","href":"/api-reference/endpoint/v3/mfa/disable-account-mfa"}]},{"group":"Mock (Staging Only)","icon":"flask","pages":[{"openapi":"post /mock/deposit","title":"Mock Deposit","href":"/api-reference/endpoint/v3/mock/mock-deposit"},{"openapi":"post /mock/deposit-fiat","title":"Mock Fiat Deposit","href":"/api-reference/endpoint/v3/mock/mock-fiat-deposit"}]},{"group":"Pricing","icon":"receipt","pages":[{"openapi":"get /pricing/pending","title":"Get Pending Pricing","href":"/api-reference/endpoint/v3/pricing/get-pending-pricing"},{"openapi":"get /pricing/trigger","title":"Pricing Alert","href":"/api-reference/endpoint/v3/pricing/pricing-alert"}]}]}]},{"version":"v2","hidden":true,"pages":[{"title":"v2","href":"/introduction","hidden":true}]}]},"basePath":"","title":"API Reference - Partna API docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}