To get authenticated, you need two headers, X-Api-Key and X-Api-User.
X-Api-User is your merchant username
To get your X-Api-Key, please follow the steps mentioned here
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.3965","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":{},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"authentication","slug":"/authentication","pageMetadata":{"title":"Authentication","description":null,"href":"/authentication","hidden":true},"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`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`To get authenticated, you need two headers, `,_jsx(_components.code,{children:`X-Api-Key`}),` and `,_jsx(_components.code,{children:`X-Api-User`}),`.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`X-Api-User`}),` is your merchant username`]}),`\n`,_jsxs(_components.li,{children:[`To get your `,_jsx(_components.code,{children:`X-Api-Key`}),`, please follow the steps mentioned `,_jsx(_components.a,{href:`/introduction#first-steps`,children:`here`})]}),`\n`]})]})}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":"Authentication","description":null,"href":"/authentication","hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"partna-75","siteName":"Partna API docs","title":"Authentication - Partna API docs","navMaps":{"firstHrefInVersion":{"v4":{"href":"/v4/documentation/introduction","matchLevel":4},"v2":{"href":"/authentication","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-07-30T11:22:47.950Z","originalFileLocation":"authentication.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=\"application-name\" content=\"Partna API docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\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=\"Authentication - Partna API docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Partna API docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getpartna.com/authentication\">\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=\"Authentication - Partna API docs\">\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/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/authentication.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/authentication#webpage\",\"url\":\"https://docs.getpartna.com/authentication\",\"name\":\"Authentication\",\"dateModified\":\"2026-07-30T11:22:47.950Z\",\"isPartOf\":{\"@id\":\"https://docs.getpartna.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getpartna.com/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getpartna.com/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Overview\",\"item\":\"https://docs.getpartna.com/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.getpartna.com/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.getpartna.com/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"url\":\"https://docs.getpartna.com/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getpartna.com/authentication#webpage\"},\"image\":\"https://res.cloudinary.com/payourse-technologies-inc/image/upload/v1710838758/seo-partna/dev_doc_cu1aax.jpg\",\"dateModified\":\"2026-07-30T11:22:47.950Z\",\"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","pages":[{"title":"v4","href":"/v4/documentation/introduction"}]},{"version":"v2","hidden":true,"tabs":[{"tab":"Documentation","groups":[{"group":"Overview","pages":[{"title":"Introduction","description":"Welcome to Partna API docs. \nWith our API, you can:\n1. Collect and payout local currencies. \n\n2. Onramp and Offramp your users with crypto\n\nThese docs will cover the available endpoints and provide example code for using the API. They will hopefully help you build your product and use case seamlessly. \n\nIf have any questions, feel free to send a mail to dev@getpartna.com","href":"/introduction"},{"title":"Environments","description":"To make it easier to test and develop with Partna, we have built different Staging and Production environments.","href":"/environments"},{"title":"Authentication","href":"/authentication"},{"title":"Webhooks","description":"Webhooks allow you to set up a notification system that can be used to receive updates on certain requests made to the Partna API.","href":"/webhooks"},{"title":"Rate Tiers","description":null,"href":"/rate-tiers"}]},{"group":"Use cases","pages":[{"title":"Collect","description":"Collect local currency payments from customers","href":"/collect"},{"title":"Onramp","description":"Collect local currency payments from customers and convert to crypto","href":"/onramp"},{"title":"Payout","description":"Make instant local currency transfers to your customers","href":"/payout"},{"title":"Offramp","description":"Receive crypto and make instant local currency transfers to your customers","href":"/offramp"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/endpoint/ventogram/balance/retrieve-merchant-account-balance"}]}]}]},"title":"Authentication - Partna API docs","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":[],"chunks":[]}