Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the dashboard.
If for any reason you believe your api key has been compromised or you wish to reset them, you can do so from the dashboard.
Secure your api keys
Do not commit your api keys to git, or use them in client-side code.
Request headers should be in the following format: x-api-key: WALLET_API_KEY
API requests made without authentication will fail with the status code 401:Unauthorized . All API requests must be made over HTTPS.
Secure your requests
Do not set VERIFY_PEER to FALSE. Ensure your server verifies the SSL connection to Yiksi Pay.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Yiksi Pay","colors":{"primary":"#6B53E2","light":"#8E72FF","dark":"#6B53E2"},"logo":{"light":"https://mintcdn.com/yiksipay/4IZNODSIyaoI_2s_/logo/light.png?fit=max\u0026auto=format\u0026n=4IZNODSIyaoI_2s_\u0026q=85\u0026s=6d5bc3bce8ca8b192d20804f89f45456","dark":"https://mintcdn.com/yiksipay/4IZNODSIyaoI_2s_/logo/dark.png?fit=max\u0026auto=format\u0026n=4IZNODSIyaoI_2s_\u0026q=85\u0026s=d798a6444634f2d08eaf267d185b968d"},"favicon":"https://mintcdn.com/yiksipay/pFjIfRqPiQ-3l9Ci/favicon.svg?fit=max\u0026auto=format\u0026n=pFjIfRqPiQ-3l9Ci\u0026q=85\u0026s=97e1387680dbf2d0939e2bde69dbad31","navbar":{"links":[{"href":"mailto:partner@yiksi.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.yiksipay.com"}},"footer":{"socials":{"x":"https://x.com/yiksiexchange","linkedin":"https://www.linkedin.com/company/yiksiexchange"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","href":"en/introduction"},{"language":"es","href":"es/introduction"},{"language":"pt","href":"pt/introduction"},{"language":"fr","href":"fr/introduction"},{"language":"zh","href":"zh/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"yiksipay","hasAudioNarration":false,"actualSubdomain":"yiksipay","customDomains":["docs.yiksipay.com"],"gitSource":{"type":"github","owner":"yiksi-inc","repo":"yiksi-pay-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21db7470c69447c725ea25","collectionId":"42fe3f44-e4ae-49a7-8559-93f3414bffca","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21db7470c69447c725ea25:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"en","tag":"API Reference","count":76},{"language":"es","tag":"Referencia API","count":76},{"language":"fr","tag":"Référence API","count":76},{"language":"pt","tag":"Referência da API","count":76},{"language":"zh","tag":"API 参考","count":76},{"language":"en","tag":"Auto Settlements","count":14},{"language":"es","tag":"Liquidaciones Automáticas","count":14},{"language":"fr","tag":"Règlements Automatiques","count":14},{"language":"pt","tag":"Liquidações Automáticas","count":14},{"language":"zh","tag":"自动结算","count":14},{"language":"en","tag":"Security","count":12},{"language":"es","tag":"Seguridad","count":12},{"language":"fr","tag":"Sécurité","count":12},{"language":"pt","tag":"Segurança","count":12},{"language":"zh","tag":"安全","count":12},{"language":"en","tag":"Address","count":10},{"language":"en","tag":"Documentation","count":10},{"language":"es","tag":"Dirección","count":10},{"language":"es","tag":"Documentación","count":10},{"language":"fr","tag":"Adresse","count":10},{"language":"fr","tag":"Documentation","count":10},{"language":"pt","tag":"Endereço","count":10},{"language":"pt","tag":"Documentação","count":10},{"language":"zh","tag":"地址","count":10},{"language":"zh","tag":"文档","count":10},{"language":"en","tag":"Essentials","count":9},{"language":"es","tag":"Esenciales","count":9},{"language":"fr","tag":"Essentiels","count":9},{"language":"pt","tag":"Essenciais","count":9},{"language":"zh","tag":"核心功能","count":9},{"language":"en","tag":"Smart Contract","count":8},{"language":"es","tag":"Contratos Inteligentes","count":8},{"language":"fr","tag":"Contrats Intelligents","count":8},{"language":"pt","tag":"Contratos Inteligentes","count":8},{"language":"zh","tag":"智能合约","count":8},{"language":"en","tag":"Transactions","count":7},{"language":"en","tag":"Master Wallet","count":7},{"language":"es","tag":"Transacciones","count":7},{"language":"es","tag":"Billetera Principal","count":7},{"language":"fr","tag":"Transactions","count":7},{"language":"fr","tag":"Portefeuille Principal","count":7},{"language":"pt","tag":"Transações","count":7},{"language":"pt","tag":"Carteira Principal","count":7},{"language":"zh","tag":"交易","count":7},{"language":"zh","tag":"主钱包","count":7},{"language":"en","tag":"Withdraw","count":6},{"language":"es","tag":"Retiro","count":6},{"language":"fr","tag":"Retrait","count":6},{"language":"pt","tag":"Saque","count":6},{"language":"zh","tag":"提款","count":6}]},"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":"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":"en/api-reference/authentication","slug":"/en/api-reference/authentication","pageMetadata":{"title":"Authentication","description":"Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the [dashboard](https://dashboard.yiksipay.com/developers).","icon":"lock","href":"/en/api-reference/authentication","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the \", _jsx(_components.a, {\n href: \"https://dashboard.yiksipay.com/developers\",\n children: \"dashboard\"\n }), \".\"]\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={code:`code`,p:`p`,..._provideComponents(),...props.components},{Info,Warning}=_components;if(!Info)_missingMdxReference(`Info`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`If for any reason you believe your api key has been compromised or you wish to reset them, you can do so from the dashboard.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Secure your api keys`,_jsx(`br`,{}),`\nDo not commit your api keys to git, or use them in client-side code.`]})}),`\n`,_jsxs(_components.p,{children:[`Request headers should be in the following format:`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`x-api-key: WALLET_API_KEY `})]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Sample Request Header`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`x-api-key: Ysz1aUX52Slt8sEXXrLBaQXjxtdT`})]})}),`\n`,_jsxs(_components.p,{children:[`API requests made without authentication will fail with the status code`,_jsx(`br`,{}),`\n`,_jsx(_components.code,{children:`401:Unauthorized`}),` . All API requests must be made over HTTPS.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Secure your requests`,_jsx(`br`,{}),`\nDo not set `,_jsx(_components.code,{children:`VERIFY_PEER`}),` to `,_jsx(_components.code,{children:`FALSE`}),`. Ensure your server verifies the SSL connection to Yiksi Pay.`]})})]})}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":"Authentication","description":"Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the [dashboard](https://dashboard.yiksipay.com/developers).","icon":"lock","href":"/en/api-reference/authentication","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"yiksipay","siteName":"Yiksi Pay","title":"Authentication - Yiksi Pay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/api-reference/authentication","matchLevel":0},"es":{"href":"/es/api-reference/authentication","matchLevel":1},"pt":{"href":"/pt/api-reference/authentication","matchLevel":1},"fr":{"href":"/fr/api-reference/authentication","matchLevel":1},"zh":{"href":"/zh/api-reference/authentication","matchLevel":1}}},"lastModified":"2026-03-17T18:53:09.675Z","originalFileLocation":"en/api-reference/authentication.mdx","locale":"en"},"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=\"Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the dashboard.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Yiksi Pay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_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/yiksipay/8MBDMq_4S2nKSqAD/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authentication - Yiksi Pay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the dashboard.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Yiksi Pay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.yiksipay.com/en/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://yiksipay.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Authentication\u0026amp;description=Authenticate+your+API+calls+by+including+your+api+key+in+the+request+header+of+every+request+you+make.+You+can+manage+your+API+keys+from+the+%5Bdashboard%5D%28https%3A%2F\u0026amp;theme=6e29a626a789cb40e8329fa5\u0026amp;signature=a1922fc9f722c7758b40862482e4861359617c9939b796dcb1187ec584e0b3cd\">\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 - Yiksi Pay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the dashboard.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://yiksipay.mintlify.app/_mintlify/api/og/v2?division=API+Documentation\u0026amp;title=Authentication\u0026amp;description=Authenticate+your+API+calls+by+including+your+api+key+in+the+request+header+of+every+request+you+make.+You+can+manage+your+API+keys+from+the+%5Bdashboard%5D%28https%3A%2F\u0026amp;theme=6e29a626a789cb40e8329fa5\u0026amp;signature=a1922fc9f722c7758b40862482e4861359617c9939b796dcb1187ec584e0b3cd\">\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/yiksipay/8MBDMq_4S2nKSqAD/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Yiksi Pay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6B53E2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.yiksipay.com/en/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/authentication.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.yiksipay.com/en/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.yiksipay.com/es/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.yiksipay.com/pt/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.yiksipay.com/fr/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.yiksipay.com/zh/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.yiksipay.com/en/api-reference/authentication\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.yiksipay.com/#organization\",\"name\":\"Yiksi Pay\",\"url\":\"https://docs.yiksipay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/yiksipay/4IZNODSIyaoI_2s_/logo/light.png?fit=max\u0026auto=format\u0026n=4IZNODSIyaoI_2s_\u0026q=85\u0026s=6d5bc3bce8ca8b192d20804f89f45456\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.yiksipay.com#website\",\"name\":\"Yiksi Pay\",\"url\":\"https://docs.yiksipay.com\",\"publisher\":{\"@id\":\"https://docs.yiksipay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.yiksipay.com/en/api-reference/authentication#webpage\",\"url\":\"https://docs.yiksipay.com/en/api-reference/authentication\",\"name\":\"Authentication\",\"description\":\"Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the dashboard.\",\"dateModified\":\"2026-03-17T18:53:09.675Z\",\"isPartOf\":{\"@id\":\"https://docs.yiksipay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.yiksipay.com/en/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.yiksipay.com/en/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://docs.yiksipay.com/en/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://docs.yiksipay.com/en/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.yiksipay.com/en/api-reference/authentication#article\",\"headline\":\"Authentication\",\"name\":\"Authentication\",\"description\":\"Authenticate your API calls by including your api key in the request header of every request you make. You can manage your API keys from the dashboard.\",\"url\":\"https://docs.yiksipay.com/en/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs.yiksipay.com/en/api-reference/authentication#webpage\"},\"dateModified\":\"2026-03-17T18:53:09.675Z\",\"publisher\":{\"@id\":\"https://docs.yiksipay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.yiksipay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Yiksi Pay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Yiksi Pay","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/en/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","description":"Learn how to seamlessly integrate our APIs into your application.","icon":"circle","href":"/en/api-reference/introduction"},{"title":"Authentication","icon":"lock","href":"/en/api-reference/authentication"},{"title":"Errors","description":"Yiksi Pay's API is RESTful and as such, uses conventional HTTP response codes to indicate the success or failure of requests.","icon":"exclamation","href":"/en/api-reference/errors"}]},{"group":"Master Wallet","pages":[{"openapi":"get /v1/wallets/{walletId}","title":"Get Wallet","href":"/en/api-reference/wallet/get-wallet"},{"openapi":"patch /v1/wallets/{walletId}","title":"Update wallet","href":"/en/api-reference/wallet/update-wallet"},{"openapi":"get /v1/wallets/{walletId}/balance","title":"Get Balance","href":"/en/api-reference/wallet/get-balance"},{"openapi":"get /v1/wallets/{walletId}/balances","title":"Get Balances","href":"/en/api-reference/wallet/get-balances"},{"openapi":"post /v1/wallets/{walletId}/rescan/blocks","title":"Deposit Finder","href":"/en/api-reference/wallet/deposit-finder"},{"openapi":"post /v1/wallets/{walletId}/sweep/assets","title":"Trigger Sweep Assets","href":"/en/api-reference/wallet/trigger-sweep-assets"},{"openapi":"get /v1/wallets/{walletId}/webhooks","title":"Webhooks Logs","href":"/en/api-reference/wallet/webhooks-logs"}]},{"group":"Address","pages":[{"openapi":"get /v1/wallets/{walletId}/addresses","title":"Get Addresses","href":"/en/api-reference/addresses/get-addresses"},{"openapi":"post /v1/wallets/{walletId}/addresses","title":"Generate Address","href":"/en/api-reference/addresses/generate-address"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}","title":"Get Address","href":"/en/api-reference/addresses/get-address"},{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}","title":"Update Address","href":"/en/api-reference/addresses/update-address"},{"openapi":"post /v1/wallets/{walletId}/addresses/whitelist","title":"Whitelist address","href":"/en/api-reference/addresses/whitelist-address"},{"openapi":"delete /v1/wallets/{walletId}/addresses/whitelist/{addressId}","title":"Unwhitelist address","href":"/en/api-reference/addresses/unwhitelist-address"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/balance","title":"Get Balance","href":"/en/api-reference/addresses/get-balance"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/balances","title":"Get Balances","href":"/en/api-reference/addresses/get-balances"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/transactions","title":"Get transactions","href":"/en/api-reference/addresses/get-transactions"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/transactions/{id}","title":"Get transaction","href":"/en/api-reference/addresses/get-transaction"}]},{"group":"Withdraw","pages":[{"openapi":"post /v1/wallets/{walletId}/withdraw/network-fee","title":"Master Wallet Network Fee","href":"/en/api-reference/withdraw/master-wallet-network-fee"},{"openapi":"post /v1/wallets/{walletId}/withdraw","title":"Master Wallet","href":"/en/api-reference/withdraw/master-wallet"},{"openapi":"post /v1/wallets/{walletId}/withdraw/sign","title":"Master Wallet Sign-Only","href":"/en/api-reference/withdraw/master-wallet-sign-only"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/withdraw","title":"Child Address","href":"/en/api-reference/withdraw/child-address"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/withdraw/sign","title":"Child Address Sign-Only","href":"/en/api-reference/withdraw/child-address-sign-only"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/withdraw/network-fee","title":"Child Address Network Fee","href":"/en/api-reference/withdraw/child-address-network-fee"}]},{"group":"Swap","pages":[{"openapi":"post /v1/wallets/{walletId}/swaps/quote","title":"Master Wallet Get Quote","href":"/en/api-reference/swap/master-wallet-get-quote"},{"openapi":"post /v1/wallets/{walletId}/swaps/execute","title":"Master Wallet Execute","href":"/en/api-reference/swap/master-wallet-execute"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/swaps/quote","title":"Child Address Get Quote","href":"/en/api-reference/swap/child-address-get-quote"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/swaps/execute","title":"Child Address Execute","href":"/en/api-reference/swap/child-address-execute"}]},{"group":"Smart Contract","pages":[{"openapi":"post /v1/wallets/{walletId}/contracts/network-fee","title":"Master Wallet Network Fee","href":"/en/api-reference/smart-contract/master-wallet-network-fee"},{"openapi":"post /v1/wallets/{walletId}/contracts/read","title":"Master Wallet Read","href":"/en/api-reference/smart-contract/master-wallet-read"},{"openapi":"post /v1/wallets/{walletId}/contracts/write","title":"Master Wallet Write","href":"/en/api-reference/smart-contract/master-wallet-write"},{"openapi":"post /v1/wallets/{walletId}/contracts/write/sign","title":"Master Wallet Write Sign-Only","href":"/en/api-reference/smart-contract/master-wallet-write-sign-only"},{"openapi":"post /wallets/{walletId}/addresses/{addressId}/contracts/network-fee","title":null,"href":"/en/api-reference/smart-contract/child-address-network-fee"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/contracts/read","title":"Child Address Read","href":"/en/api-reference/smart-contract/child-address-read"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/contracts/write","title":"Child Address Write","href":"/en/api-reference/smart-contract/child-address-write"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/contracts/write/sign","title":"Child Address Write Sign-Only","href":"/en/api-reference/smart-contract/child-address-write-sign-only"}]},{"group":"Signing","pages":[{"openapi":"post /v1/wallets/{walletId}/signing/typed-data","title":"Master Wallet Typed data","href":"/en/api-reference/signing/master-wallet-typed-data"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/signing/typed-data","title":"Child Address Typed data","href":"/en/api-reference/signing/child-address-typed-data"}]},{"group":"Asset Management","pages":[{"openapi":"get /v1/wallets/{walletId}/assets","title":"Get Wallet Assets","href":"/en/api-reference/asset/get-wallet-assets"},{"openapi":"post /v1/wallets/{walletId}/assets","title":"Add Asset to Wallet","href":"/en/api-reference/asset/add-asset-to-wallet"},{"openapi":"delete /v1/wallets/{walletId}/assets/{assetId}","title":"Remove Asset from Wallet","href":"/en/api-reference/asset/remove-asset-from-wallet"},{"openapi":"patch /v1/wallets/{walletId}/assets/{assetId}","title":"Update Wallet Asset","href":"/en/api-reference/asset/update-wallet-asset"}]},{"group":"Transactions","pages":[{"openapi":"get /v1/wallets/{walletId}/transactions","title":"Get Transactions","href":"/en/api-reference/transactions/get-transactions"},{"openapi":"get /v1/wallets/{walletId}/transactions/{id}","title":"Get transaction","href":"/en/api-reference/transactions/get-transaction"},{"openapi":"post /v1/wallets/{walletId}/transactions/webhooks/resend","title":"Resend Webhook","href":"/en/api-reference/transactions/resend-webhook"},{"openapi":"post /v1/wallets/{walletId}/transactions/sweep/assets","title":"Trigger Asset Sweep","href":"/en/api-reference/transactions/trigger-asset-sweep"},{"openapi":"get /v1/wallets/{walletId}/transactions/{transactionsId}/webhooks","title":"Webhook Logs","href":"/en/api-reference/transactions/webhook-logs"},{"openapi":"post /v1/wallets/{walletId}/transactions/cancel","title":"Cancel Transaction","href":"/en/api-reference/transactions/cancel-transaction"},{"openapi":"post /v1/wallets/{walletId}/transactions/retry","title":"Retry Transaction","href":"/en/api-reference/transactions/retry-transaction"}]},{"group":"AML","pages":[{"openapi":"get /v1/aml/lookup","title":"Lookup","href":"/en/api-reference/aml/lookup"}]},{"group":"Auto Settlements","pages":[{"openapi":"get /v1/wallets/{walletId}/auto-settlements","title":"Master Wallet","href":"/en/api-reference/auto-settlements/master-wallet"},{"openapi":"patch /v1/wallets/{walletId}/auto-settlements","title":"Master Wallet Update","href":"/en/api-reference/auto-settlements/master-wallet-update"},{"openapi":"get /v1/wallets/{walletId}/auto-settlements/rules","title":"Master Wallet Get Rules","href":"/en/api-reference/auto-settlements/master-wallet-get-rules"},{"openapi":"get /v1/wallets/{walletId}/auto-settlements/rules/{id}","title":"Master Wallet Get Rule","href":"/en/api-reference/auto-settlements/master-wallet-get-rule"},{"openapi":"post /v1/wallets/{walletId}/auto-settlements/rules","title":"Master Wallet Create Rule","href":"/en/api-reference/auto-settlements/master-wallet-create-rule"},{"openapi":"patch /v1/wallets/{walletId}/auto-settlements/rules/{id}","title":"Master Wallet Update Rule","href":"/en/api-reference/auto-settlements/master-wallet-update-rule"},{"openapi":"delete /v1/wallets/{walletId}/auto-settlements/rules/{id}","title":"Master Wallet Delete Rule","href":"/en/api-reference/auto-settlements/master-wallet-delete-rule"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements","title":"Child Address","href":"/en/api-reference/auto-settlements/child-address"},{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements","title":"Child Address Update","href":"/en/api-reference/auto-settlements/child-address-update"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules","title":"Child Address Get Rules","href":"/en/api-reference/auto-settlements/child-address-get-rules"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Get Rule","href":"/en/api-reference/auto-settlements/child-address-get-rule"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules","title":"Child Address Create Rule","href":"/en/api-reference/auto-settlements/child-address-create-rule"},{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Update Rule","href":"/en/api-reference/auto-settlements/child-address-update-rule"},{"openapi":"delete /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Delete Rule","href":"/en/api-reference/auto-settlements/child-address-delete-rule"}]},{"group":"Beneficiaries","pages":[{"openapi":"post /v1/wallets/{walletId}/beneficiaries","title":"Create","href":"/en/api-reference/beneficiaries/create"},{"openapi":"get /v1/wallets/{walletId}/beneficiaries","title":"Get all","href":"/en/api-reference/beneficiaries/get-all"},{"openapi":"get /v1/wallets/{walletId}/beneficiaries/{id}","title":"Get one","href":"/en/api-reference/beneficiaries/get-one"},{"openapi":"patch /v1/wallets/{walletId}/beneficiaries/{id}","title":"Update","href":"/en/api-reference/beneficiaries/update"},{"openapi":"delete /v1/wallets/{walletId}/beneficiaries/{id}","title":"Delete","href":"/en/api-reference/beneficiaries/delete"}]},{"group":"Asset Recovery","pages":[{"openapi":"post /v1/wallets/{walletId}/salvage/network-fee","title":"Network Fee","href":"/en/api-reference/asset-recovery/salvage-network-fee"},{"openapi":"post /v1/wallets/{walletId}/salvage","title":"Execute","href":"/en/api-reference/asset-recovery/salvage"}]},{"group":"Miscellaneous","pages":[{"openapi":"get /v1/assets","title":"Get Assets","href":"/en/api-reference/miscellaneous/get-assets"},{"openapi":"get /v1/blockchains","title":"Get Blockchains","href":"/en/api-reference/miscellaneous/get-blockchains"},{"openapi":"get /v1/assets/rates","title":"Get Rates","href":"/en/api-reference/miscellaneous/get-rates"}]}]},{"tab":"Security","pages":[{"title":"Security","href":"/en/security/introduction"}]}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/authentication"}]},{"language":"pt","pages":[{"title":"pt","href":"/pt/api-reference/authentication"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-reference/authentication"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/authentication"}]}]},"basePath":"","title":"Authentication - Yiksi Pay","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}