Available in🇮🇳 India🇲🇾 Malaysia🇸🇬 Singapore🇺🇸 United States
Check how to authenticate the APIs.All Razorpay APIs are authenticated using Basic Auth. Basic auth requires the following:
[YOUR_KEY_ID]
[YOUR_KEY_SECRET]
Basic auth expects an Authorization header for each request in the Basic base64token format. Here, base64token is a base64 encoded string of YOUR_KEY_ID:YOUR_KEY_SECRET.
Watch Out!The Authorization header value should strictly adhere to the format mentioned above. Invalid formats will result in authentication failures.
Few examples of invalid headers are: BASIC base64token, basic base64token, Basic "base64token" and Basic $base64token.
Watch this video to see how to generate API keys in the Test mode.
Live Mode API Keys
Watch this video to see how to generate API keys in the Live mode.
Log in to your Dashboard with the appropriate credentials.
Select the mode (Test or Live) for which you want to generate the API key.
Test Mode: The test mode is a simulation mode that you can use to test your integration flow. Your customers will not be able to make payments in this mode.
Live Mode: When your integration is complete, switch to live mode and generate live mode API keys. In the integration, replace test mode keys with live mode keys to accept customer payments.
Navigate to Account & Settings → API Keys (under Website and app settings) → Generate Key to generate key for the selected mode.
Watch Out!
After generating the keys from the Dashboard, download and save them securely. You can use only one set of API keys. If you do not remember your API keys, you must regenerate them from the Dashboard and update them wherever the previous keys were used for payment gateway integrations.
API Keys are universal; that is, they are applicable to all websites and apps that you have whitelisted for your Merchant ID.
Do not share your API Key secret with anyone or on any public platforms. This can pose security threats to your Razorpay account.
Once you generate the API Keys, only the Key Id is visible on the Dashboard, not the Key secret, as it can pose security threats to your Razorpay account.
Use the Live API Keys to accept live payments and the Test API Keys for test transactions.
You can roll the Live and Test mode API keys if you have lost them or exposed them. You can choose to regenerate the API keys by deactivating them immediately or after 24 hours.Know how to regenerate Razorpay API keys.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Razorpay","colors":{"primary":"#3395FF","light":"#66B2FF","dark":"#0B62C4"},"logo":{"light":"https://mintcdn.com/razorpay-881012b3/puuu1wI-BbW3rsp2/logo/light.svg?fit=max\u0026auto=format\u0026n=puuu1wI-BbW3rsp2\u0026q=85\u0026s=e0750375ee2004193a685f9f211963fe","dark":"https://mintcdn.com/razorpay-881012b3/puuu1wI-BbW3rsp2/logo/dark.svg?fit=max\u0026auto=format\u0026n=puuu1wI-BbW3rsp2\u0026q=85\u0026s=038b180f26d19ddb4eb40ede0cf84821","href":"https://razorpay.com/docs/"},"favicon":"https://mintcdn.com/razorpay-881012b3/puuu1wI-BbW3rsp2/favicon.png?fit=max\u0026auto=format\u0026n=puuu1wI-BbW3rsp2\u0026q=85\u0026s=9bebe786d3a21e9452fd2e31243e5fb3","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"basic"},"server":"https://api.razorpay.com"}},"navbar":{"links":[{"href":"https://razorpay.com/support/","label":"Support"},{"href":"https://razorpay.com/blog/","label":"Blog"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.razorpay.com/"}},"footer":{"socials":{"x":"https://x.com/Razorpay","linkedin":"https://www.linkedin.com/company/razorpay","github":"https://github.com/razorpay","youtube":"https://www.youtube.com/razorpay"},"links":[{"header":"Products","items":[{"label":"Payment Gateway","href":"https://razorpay.com/payment-gateway"},{"label":"Payment Links","href":"https://razorpay.com/payment-links"},{"label":"RazorpayX","href":"https://razorpay.com/x"},{"label":"Payroll","href":"https://razorpay.com/payroll"}]},{"header":"Resources","items":[{"label":"Documentation","href":"https://razorpay.com/docs"},{"label":"API Reference","href":"https://razorpay.com/docs/api"},{"label":"Support","href":"https://razorpay.com/support"},{"label":"Blog","href":"https://razorpay.com/blog"}]},{"header":"Company","items":[{"label":"About Us","href":"https://razorpay.com/about"},{"label":"Careers","href":"https://razorpay.com/jobs"},{"label":"Pricing","href":"https://razorpay.com/pricing"}]}]},"seo":{"metatags":{"canonical":"https://razorpay.com/docs"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"razorpay-881012b3","hasAudioNarration":false,"actualSubdomain":"razorpay-881012b3","customDomains":["razorpay.com"],"gitSource":{"type":"github","owner":"razorpay-vendor-integrations","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af576126aaba2f8a1d42b85","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Payments","count":1648},{"language":"default","tag":"API Reference","count":772},{"language":"default","tag":"Payment Gateway","count":237},{"language":"default","tag":"Dashboard","count":213},{"language":"default","tag":"Subscriptions","count":190},{"language":"default","tag":"Payouts","count":158},{"language":"default","tag":"Payment Links","count":129},{"language":"default","tag":"Banking Plus","count":123},{"language":"default","tag":"Developer Tools","count":104},{"language":"default","tag":"Ecommerce Plugins","count":104}],"searchSettings":{"maxResults":8}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar ul.sidebar-group.mt-6,ul.sidebar-group.mt-6{margin-top:1rem}[data-component-part=\"callout-content\"]>[data-as=\"p\"]:first-child>strong,[data-component-part=\"callout-content\"]>[data-as=\"p\"]:first-child strong,[data-component-part=\"callout-content\"]>strong:first-child{font-size:1.125rem!important;font-weight:700!important;line-height:1.4!important}.error-code-cards [data-component-part=\"card-title\"]{display:inline-block!important;font-family:ui-monospace, \"SF Mono\", SFMono-Regular, Menlo, Consolas,\n \"Liberation Mono\", monospace!important;font-size:0.875rem!important;font-weight:600!important;line-height:1.3!important;padding:0.25rem 0.75rem!important;border-radius:9999px!important;background:rgba(107, 114, 128, 0.10)!important;border:1px solid rgba(107, 114, 128, 0.25)!important}.dark .error-code-cards [data-component-part=\"card-title\"]{background:rgba(255, 255, 255, 0.06)!important;border-color:rgba(255, 255, 255, 0.15)!important}[data-http-method]{font-weight:700!important;border-color:transparent!important}[data-http-method=\"get\"]{color:#15803d!important;background:rgba(74, 222, 128, 0.2)!important}[data-http-method=\"post\"]{color:#1d4ed8!important;background:rgba(96, 165, 250, 0.2)!important}[data-http-method=\"put\"]{color:#a16207!important;background:rgba(250, 204, 21, 0.2)!important}[data-http-method=\"patch\"]{color:#c2410c!important;background:rgba(251, 146, 60, 0.2)!important}[data-http-method=\"delete\"]{color:#b91c1c!important;background:rgba(248, 113, 113, 0.2)!important}.dark [data-http-method=\"get\"]{color:#4ade80!important}.dark [data-http-method=\"post\"]{color:#60a5fa!important}.dark [data-http-method=\"put\"]{color:#facc15!important}.dark [data-http-method=\"patch\"]{color:#fb923c!important}.dark [data-http-method=\"delete\"]{color:#f87171!important}ul.sidebar-group.mt-6{margin-top:5px}.sticky .panel:has(>.rzp-code-selector){display:grid;grid-auto-rows:minmax(0, 1fr);gap:1.5rem;overflow:hidden}.sticky:has(>.panel>.rzp-code-selector)>div:not(.panel){display:none}.rzp-code-selector{position:relative;display:flex;flex-direction:column;min-height:0;overflow:hidden;padding:0.125rem;border:1px solid rgba(3, 7, 18, 0.1);border-radius:1rem;background:rgb(244, 247, 250)}.dark .rzp-code-selector{border-color:rgba(255, 255, 255, 0.1);background:rgba(255, 255, 255, 0.05)}.rzp-code-selector-bar{display:flex;align-items:center;justify-content:space-between;gap:0.5rem;flex:none;flex-wrap:wrap;padding:0.25rem 4.25rem 0.375rem 0.5rem}.rzp-code-selector-field{position:relative;display:inline-flex;align-items:center;flex:0 0 auto}.rzp-code-selector-select{appearance:none;-webkit-appearance:none;min-width:max-content;padding:0.125rem 1.75rem 0.125rem 0.375rem;border:0;border-radius:0.5rem;background:transparent;color:var(--color-gray-600, #4b5563);font-size:0.75rem;font-weight:500;line-height:1.5rem;cursor:pointer}.dark .rzp-code-selector-select{color:var(--color-gray-300, #d1d5db)}.rzp-code-selector-select:hover{background:rgba(3, 7, 18, 0.05)}.dark .rzp-code-selector-select:hover{background:rgba(255, 255, 255, 0.08)}.rzp-code-selector-chevron{position:absolute;right:0.25rem;width:0.875rem;height:0.875rem;pointer-events:none;opacity:0.6}.rzp-code-selector-body{flex:1 1 auto;min-height:0;overflow-y:auto;overscroll-behavior:contain}.rzp-code-selector-body>.code-block{margin:0!important;min-width:0;border-radius:0 0 0.875rem 0.875rem;position:static!important}.rzp-code-selector-body [data-component-part=\"code-block-root\"]{border-radius:0 0 0.875rem 0.875rem}.rzp-code-selector-body .code-block-fade-overlay{display:none}.rzp-code-selector::after{content:\"\";position:absolute;inset:auto 0 0;height:2rem;border-radius:0 0 0.875rem 0.875rem;pointer-events:none;background:linear-gradient(to bottom, rgba(255, 255, 255, 0), #fff)}.dark .rzp-code-selector::after{background:linear-gradient(to bottom, rgba(11, 12, 14, 0), rgb(11, 12, 14))}.rzp-code-selector>.rzp-code-selector-body>.code-block>.absolute{top:0.5rem;right:0.75rem}"},{"filePath":"static/docs-home/styles.css","href":"/docs/_mintlify/custom/razorpay-881012b3/5b8b615a0125ba7b/static/docs-home/styles.css"},{"filePath":"static/nav-more.css","content":"#navbar .nav-tabs{min-width:0;column-gap:1rem}#navbar .nav-tabs:not(.rzpn-more) .nav-tabs-item{display:block;flex:0 1 auto;min-width:3.5rem;min-width:calc-size(max-content, min(size, 5.25rem));white-space:nowrap;overflow:hidden;text-overflow:ellipsis;line-height:3rem}#navbar .nav-tabs:not(.rzpn-more) .nav-tabs-item>svg{display:inline-block;vertical-align:middle;margin:-2px 8px 0 0}#navbar .nav-tabs.rzpn-more .nav-tabs-item{flex:none;white-space:nowrap}#navbar .nav-tabs-item[data-rzpn-hidden]{display:none}#navbar .rzpn-more-wrap{position:relative;flex:none}#navbar .rzpn-more-wrap:not([hidden]){display:flex}#navbar .rzpn-more-menu:not([hidden]){display:flex;flex-direction:column}#navbar .rzpn-more-btn{background:none;border:0;padding:0;cursor:pointer;white-space:nowrap}#navbar .rzpn-more-menu{position:absolute;top:calc(100% - 4px);right:0;z-index:50;min-width:12rem;padding:6px;border-radius:12px;box-shadow:0 8px 24px rgba(0,0,0,.12)}#navbar .rzpn-more-menu a{display:flex;align-items:center;gap:8px;padding:8px 10px;border-radius:8px;white-space:nowrap}#navbar .rzpn-more-menu a:hover,#navbar .rzpn-more-menu a:focus-visible{background:rgba(127,127,127,.12)}"}],"page":{"pagePath":"us/api/authentication","slug":"/us/api/authentication","pageMetadata":{"title":"API Authentication","sidebarTitle":"Authentication","description":"Authentication process for Razorpay APIs.","href":"/us/api/authentication"},"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: \"Authentication process for Razorpay APIs.\"\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`,li:`li`,ol:`ol`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Card,CardGroup,Heading,OptimizedFrame,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedFrame)_missingMdxReference(`OptimizedFrame`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(`div`,{style:{display:`flex`,flexWrap:`wrap`,alignItems:`center`,gap:`0.35rem 0.9rem`,border:`1px solid rgba(128,128,128,0.28)`,borderRadius:`0.5rem`,padding:`0.45rem 0.75rem`,margin:`0 0 1.25rem`,fontSize:`0.875rem`},children:[_jsx(`span`,{style:{fontWeight:600},children:`Available in`}),_jsx(`span`,{children:`🇮🇳 India`}),_jsx(`span`,{children:`🇲🇾 Malaysia`}),_jsx(`span`,{children:`🇸🇬 Singapore`}),_jsx(`span`,{children:`🇺🇸 United States`})]}),`\n`,_jsx(_components.p,{children:`Check how to authenticate the APIs.`}),`\n`,_jsxs(_components.p,{children:[`All Razorpay APIs are authenticated using `,_jsx(_components.code,{children:`Basic Auth`}),`. Basic auth requires the following:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`[YOUR_KEY_ID]`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`[YOUR_KEY_SECRET]`})}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Basic auth expects an `,_jsx(_components.code,{children:`Authorization`}),` header for each request in the `,_jsx(_components.code,{children:`Basic base64token`}),` format. Here, `,_jsx(_components.code,{children:`base64token`}),` is a base64 encoded string of `,_jsx(_components.code,{children:`YOUR_KEY_ID:YOUR_KEY_SECRET`}),`.`]}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Watch Out!`})}),_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`Authorization`}),` header value should strictly adhere to the format mentioned above. Invalid formats will result in authentication failures.\nFew examples of `,_jsx(_components.strong,{children:`invalid`}),` headers are: `,_jsx(_components.code,{children:`BASIC base64token`}),`, `,_jsx(_components.code,{children:`basic base64token`}),`, `,_jsx(_components.code,{children:`Basic \"base64token\"`}),` and `,_jsx(_components.code,{children:`Basic $base64token`}),`.`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`generate-api-keys`,children:`Generate API Keys`}),`\n`,_jsx(_components.p,{children:`Follow these steps to generate API keys:`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsxs(Card,{title:`Test Mode API Keys`,children:[_jsx(_components.p,{children:`Watch this video to see how to generate API keys in the Test mode.`}),_jsx(OptimizedFrame,{width:`495`,height:`315`,src:`https://www.youtube.com/embed/VOn8JlGPG2I?si=WTAbAeLB3Hnp1n3r`,title:`YouTube video player`,frameBorder:`0`,allow:`accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture`,allowFullScreen:true})]}),_jsxs(Card,{title:`Live Mode API Keys`,children:[_jsx(_components.p,{children:`Watch this video to see how to generate API keys in the Live mode.`}),_jsx(OptimizedFrame,{width:`495`,height:`315`,src:`https://www.youtube.com/embed/Cer8UfBGX_E?si=Libr1RXoFSEDfY1c`,title:`YouTube video player`,frameBorder:`0`,allow:`accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture`,allowFullScreen:true})]})]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`Log in to your Dashboard with the appropriate credentials.`}),`\n`,_jsxs(_components.li,{children:[`Select the mode (`,_jsx(_components.strong,{children:`Test`}),` or `,_jsx(_components.strong,{children:`Live`}),`) for which you want to generate the API key.`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Test Mode`}),`: The test mode is a simulation mode that you can use to test your integration flow. `,_jsx(_components.strong,{children:`Your customers will not be able to make payments in this mode`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Live Mode`}),`: When your integration is complete, switch to live mode and generate live mode API keys. In the integration, `,_jsx(_components.strong,{children:`replace test mode keys with live mode keys to accept customer payments`}),`.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`Navigate to `,_jsx(_components.strong,{children:`Account \u0026 Settings`}),` → `,_jsx(_components.strong,{children:`API Keys`}),` (under `,_jsx(_components.strong,{children:`Website and app settings`}),`) → `,_jsx(_components.strong,{children:`Generate Key`}),` to generate key for the selected mode.`,_jsx(`br`,{})]}),`\n`]}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Watch Out!`})}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`After generating the keys from the Dashboard, download and save them securely. You can use only one set of API keys. If you do not remember your API keys, you must `,_jsx(_components.a,{href:`/us/payments/dashboard/account-settings/api-keys#regenerate-api-keys`,children:`regenerate them`}),` from the Dashboard and update them wherever the previous keys were used for payment gateway integrations.`]}),`\n`,_jsx(_components.li,{children:`API Keys are universal; that is, they are applicable to all websites and apps that you have whitelisted for your Merchant ID.`}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Do not share your API Key secret`}),` with anyone or on any public platforms. `,_jsx(_components.strong,{children:`This can pose security threats to your Razorpay account`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Once you generate the API Keys, only the\\xA0`,_jsx(_components.strong,{children:`Key Id`}),`\\xA0is visible on the Dashboard, `,_jsx(_components.strong,{children:`not\\xA0the Key secret`}),`, as it can pose security threats to your Razorpay account.`]}),`\n`,_jsxs(_components.li,{children:[`Use the `,_jsx(_components.strong,{children:`Live API Keys`}),` to accept live payments and the `,_jsx(_components.strong,{children:`Test API Keys`}),` for test transactions.`]}),`\n`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`roll-api-keys`,children:`Roll API Keys`}),`\n`,_jsx(_components.p,{children:`You can roll the Live and Test mode API keys if you have lost them or exposed them. You can choose to regenerate the API keys by deactivating them immediately or after 24 hours.`}),`\n`,_jsxs(_components.p,{children:[`Know how to `,_jsx(_components.a,{href:`/us/payments/dashboard/account-settings/api-keys#regenerate-api-keys`,children:`regenerate Razorpay API keys`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`related-information`,children:`Related Information`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/us/api/understand`,children:`Understand Razorpay APIs`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/us/errors`,children:`Errors`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/us/api/best-practices`,children:`Best Practices`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/us/api/glossary`,children:`Glossary`})}),`\n`]})]})}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 Authentication","sidebarTitle":"Authentication","description":"Authentication process for Razorpay APIs.","href":"/us/api/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Generate API Keys","slug":"generate-api-keys","depth":2,"children":[]},{"title":"Roll API Keys","slug":"roll-api-keys","depth":2,"children":[{"title":"Related Information","slug":"related-information","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/razorpay-881012b3/ccee8c0e9edccd6b/country-switcher.js","/docs/_mintlify/custom/razorpay-881012b3/d04f2910efb9afc8/static/docs-home/script.js","/docs/_mintlify/custom/razorpay-881012b3/e78183bdfe89167a/ga4.js","/docs/_mintlify/custom/razorpay-881012b3/0ccbc66d726b02ea/static/nav-more.js","/docs/_mintlify/custom/razorpay-881012b3/fe07c43033bf9a19/hreflang.js"],"subdomain":"razorpay-881012b3","siteName":"Razorpay","title":"API Authentication - Razorpay","navMaps":{"firstHrefInVersion":{"India":{"href":"/api/authentication","matchLevel":1},"Singapore":{"href":"/sg/api/authentication","matchLevel":1},"United States":{"href":"/us/api/authentication","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-08T16:37:49.654Z","gitLastModified":"2026-10-08T16:35:44.000Z","originalFileLocation":"us/api/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=\"description\" content=\"Authentication process for Razorpay APIs.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Razorpay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_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=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Authentication - Razorpay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Authentication process for Razorpay APIs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Razorpay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://razorpay.com/docs/us/api/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://razorpay-881012b3.mintlify.site/docs/_mintlify/api/og/v2?division=Introduction\u0026amp;title=API+Authentication\u0026amp;description=Authentication+process+for+Razorpay+APIs.\u0026amp;theme=a4f414a96152b37051aa45a2\u0026amp;signature=af87f8df8af7029d56e65817ffe3610c76e1711dea4be2d99f095a3fc1b00c24\">\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 Authentication - Razorpay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Authentication process for Razorpay APIs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://razorpay-881012b3.mintlify.site/docs/_mintlify/api/og/v2?division=Introduction\u0026amp;title=API+Authentication\u0026amp;description=Authentication+process+for+Razorpay+APIs.\u0026amp;theme=a4f414a96152b37051aa45a2\u0026amp;signature=af87f8df8af7029d56e65817ffe3610c76e1711dea4be2d99f095a3fc1b00c24\">\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=\"/docs/mintlify-assets/_mintlify/favicons/razorpay-881012b3/gWy2bjt_zV_OZ2iN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Razorpay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3395FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://razorpay.com/docs/us/api/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/us/api/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://razorpay.com/#organization\",\"name\":\"Razorpay\",\"url\":\"https://razorpay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/razorpay-881012b3/puuu1wI-BbW3rsp2/logo/light.svg?fit=max\u0026auto=format\u0026n=puuu1wI-BbW3rsp2\u0026q=85\u0026s=e0750375ee2004193a685f9f211963fe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://razorpay.com/docs#website\",\"name\":\"Razorpay\",\"url\":\"https://razorpay.com/docs\",\"publisher\":{\"@id\":\"https://razorpay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://razorpay.com/docs/us/api/authentication#webpage\",\"url\":\"https://razorpay.com/docs/us/api/authentication\",\"name\":\"API Authentication\",\"description\":\"Authentication process for Razorpay APIs.\",\"dateModified\":\"2026-10-08T16:35:44.000Z\",\"isPartOf\":{\"@id\":\"https://razorpay.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://razorpay.com/docs/us/api/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://razorpay.com/docs/us/api/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Introduction\",\"item\":\"https://razorpay.com/docs/us/api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Authentication\",\"item\":\"https://razorpay.com/docs/us/api/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://razorpay.com/docs/us/api/authentication#article\",\"headline\":\"API Authentication\",\"name\":\"API Authentication\",\"description\":\"Authentication process for Razorpay APIs.\",\"url\":\"https://razorpay.com/docs/us/api/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://razorpay.com/docs/us/api/authentication#webpage\"},\"dateModified\":\"2026-10-08T16:35:44.000Z\",\"publisher\":{\"@id\":\"https://razorpay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://razorpay.com/docs#website\"}}]}\u003c/script>","agentPointerHref":"/docs/us/api/authentication.md","siteName":"Razorpay","nav":{"global":null,"versions":[{"version":"India","default":true,"pages":[{"title":"India","href":"/api/authentication"}]},{"version":"Singapore","pages":[{"title":"Singapore","href":"/sg/api/authentication"}]},{"version":"United States","tabs":[{"tab":"Home","icon":"house","pages":[{"title":"Home","href":"/us/home"}]},{"tab":"Payments","icon":"credit-card","pages":[{"title":"Payments","href":"/us/payments"}]},{"tab":"API Reference","icon":"code","pages":[{"group":"Introduction","root":{"title":"API Reference Guide","href":"/us/api"},"pages":[{"title":"API Changelog","href":"/us/api/changelog"},{"title":"Understand Razorpay APIs","description":"Explanation of Razorpay API structure and the various components such as HTTP methods, status codes, data types and parameter types. Details on versioning, rate limiting and pagination.","href":"/us/api/understand"},{"title":"API Authentication","sidebarTitle":"Authentication","href":"/us/api/authentication"},{"title":"API Sandbox Setup","sidebarTitle":"Sandbox Setup","description":"Sandbox setup for testing Razorpay APIs.","href":"/us/api/sandbox-setup"},{"title":"Install the Razorpay CLI","sidebarTitle":"Install CLI","href":"/us/api/install-cli"},{"title":"Best Practices","href":"/us/api/best-practices"},{"title":"Glossary","href":"/us/api/glossary"}]},{"group":"Payments","root":{"title":"Payments","href":"/us/api/payments"},"pages":[{"group":"Orders","pages":[{"title":"Orders Entity","href":"/us/api/orders/entity"},{"title":"Create an Order","api":"POST /v1/orders","href":"/us/api/orders/create"},{"title":"Fetch All Orders","api":"GET /v1/orders","href":"/us/api/orders/fetch-all"},{"title":"Fetch All Orders (With Expanded Payments)","api":"GET /v1/orders?expand[]=payments","href":"/us/api/orders/fetch-all-expanded-payments"},{"title":"Fetch All Orders (With Expand Card Payments)","api":"GET /v1/orders?expand[]=payments.card","href":"/us/api/orders/fetch-all-expanded-card-payments"},{"title":"Fetch an Order With ID","api":"GET /v1/orders/:id","href":"/us/api/orders/fetch-with-id"},{"title":"Fetch Payments for an Order","api":"GET /v1/orders/:id/payments","href":"/us/api/orders/fetch-payments"},{"title":"Update an Order","api":"PATCH /v1/orders/:id","href":"/us/api/orders/update"}]},{"group":"Payments","pages":[{"title":"Payments Entity","href":"/us/api/payments/entity"},{"title":"Capture a Payment","api":"POST /v1/payments/:id/capture","href":"/us/api/payments/capture"},{"title":"Fetch a Payment With ID","api":"GET /v1/payments/:id","href":"/us/api/payments/fetch-with-id"},{"title":"Fetch a Payment (With Expanded Card Details)","api":"GET /v1/payments/:id/?expand[]=card","href":"/us/api/payments/fetch-payment-expanded-card"},{"title":"Fetch a Payment with Expanded EMI Details","api":"GET /v1/payments/:id/?expand[]=emi","href":"/us/api/payments/fetch-payment-expanded-emi"},{"title":"Fetch a Payment with Expanded Offers Details","api":"GET /v1/payments/:id/?expand[]=offers","href":"/us/api/payments/fetch-payment-expanded-offers"},{"title":"Fetch All Payments","api":"GET /v1/payments","href":"/us/api/payments/fetch-all-payments"},{"title":"Fetch All Payments (With Expanded Card Details)","api":"GET /v1/payments?expand[]=card","href":"/us/api/payments/fetch-all-payments-with-expanded-card-details"},{"title":"Fetch All Payments (With Expanded EMI Details)","api":"GET /v1/payments?expand[]=emi","href":"/us/api/payments/fetch-all-payments-with-expanded-emi-details"},{"title":"Fetch Payments Based on Orders","api":"GET /v1/orders/:id/payments","href":"/us/api/payments/fetch-payments-orders"},{"title":"Fetch Card Details of a Payment","api":"GET /v1/payments/:id/card","href":"/us/api/payments/fetch-card-details-payment"},{"title":"Update a Payment","api":"PATCH /v1/payments/:id/","href":"/us/api/payments/update"}]},{"group":"Downtime","pages":[{"title":"Payment Downtime","sidebarTitle":"Downtime","href":"/us/api/payments/downtime"},{"title":"Payment Downtime Entity","href":"/us/api/payments/downtime/entity"},{"title":"Fetch All Payment Downtime Details","api":"GET /v1/payments/downtimes","href":"/us/api/payments/downtime/fetch-all"},{"title":"Fetch Payment Downtime Details With ID","api":"GET /v1/payments/downtimes/:id","href":"/us/api/payments/downtime/fetch-with-id"}]},{"group":"Settlements","pages":[{"title":"Settlements Entity","href":"/us/api/settlements/entity"},{"title":"Fetch All Settlements","api":"GET /v1/settlements/","href":"/us/api/settlements/fetch-all"},{"title":"Fetch Settlements With ID","api":"GET /v1/settlements/:id","href":"/us/api/settlements/fetch-with-id"},{"title":"Fetch Settlement Recon Details","api":"GET /v1/settlements/recon/combined?year=yyyy\u0026month=mm","href":"/us/api/settlements/fetch-recon"}]},{"group":"Instant Settlements","pages":[{"title":"Instant Settlements Entity","href":"/us/api/settlements/instant/entity"},{"title":"Create an Instant Settlement","api":"POST /v1/settlements/ondemand","href":"/us/api/settlements/instant/create"},{"title":"Fetch All Instant Settlements","api":"GET /v1/settlements/ondemand","href":"/us/api/settlements/instant/fetch-all"},{"title":"Fetch Instant Settlement With ID","api":"GET /v1/settlements/ondemand/:id","href":"/us/api/settlements/instant/fetch-with-id"},{"title":"Fetch All Instant Settlements With Payout Details","api":"GET /v1/settlements/ondemand/?expand[]=ondemand_payouts","href":"/us/api/settlements/instant/fetch-all-payout"},{"title":"Fetch Instant Settlement With ID and Payout Details","api":"GET /v1/settlements/ondemand/:id?expand[]=ondemand_payouts","href":"/us/api/settlements/instant/fetch-with-id-payout"}]},{"group":"Refunds","pages":[{"title":"Refunds Entity","href":"/us/api/refunds/entity"},{"title":"Create a Normal Refund","api":"POST /v1/payments/:id/refund","href":"/us/api/refunds/create-normal"},{"title":"Create an Instant Refund","api":"POST /v1/payments/:id/refund","href":"/us/api/refunds/create-instant"},{"title":"Fetch Multiple Refunds for a Payment","api":"GET /v1/payments/:id/refunds","href":"/us/api/refunds/fetch-multiple-refund-payment"},{"title":"Fetch a Specific Refund for a Payment","api":"GET /v1/payments/:payment_id/refunds/:refund_id","href":"/us/api/refunds/fetch-specific-refund-payment"},{"title":"Fetch All Refunds","api":"GET /v1/refunds/","href":"/us/api/refunds/fetch-all"},{"title":"Fetch Refund With ID","api":"GET /v1/refunds/:id","href":"/us/api/refunds/fetch-with-id"},{"title":"Update a Refund","api":"PATCH /v1/refunds/:id/","href":"/us/api/refunds/update"}]},{"group":"Disputes","pages":[{"title":"Disputes Entity","href":"/us/api/disputes/entity"},{"title":"Fetch All Disputes","api":"GET /v1/disputes","href":"/us/api/disputes/fetch-all"},{"title":"Fetch a Dispute With ID","api":"GET /v1/disputes/:id","href":"/us/api/disputes/fetch"},{"title":"Fetch a Dispute With ID (With Expanded Payments Details)","api":"GET /v1/disputes/:id?expand[]=payment","href":"/us/api/disputes/fetch-dispute-expanded-payment"},{"title":"Fetch a Dispute With ID (With Expanded transaction.settlement Details)","api":"GET /v1/disputes/:id?expand[]=transaction.settlement","href":"/us/api/disputes/fetch-dispute-expanded-transaction"},{"title":"Accept a Dispute","api":"POST /v1/disputes/:id/accept","href":"/us/api/disputes/accept"},{"title":"Contest a Dispute","api":"PATCH /v1/disputes/:id/contest","href":"/us/api/disputes/contest"}]},{"group":"Documents","pages":[{"title":"Documents Entity","href":"/us/api/documents/entity"},{"title":"Create a Document","api":"POST /v1/documents","href":"/us/api/documents/create"},{"title":"Fetch Document Information","api":"GET /v1/documents/:id","href":"/us/api/documents/fetch-info"},{"title":"Fetch Document Content","api":"GET /v1/documents/:id/content","href":"/us/api/documents/fetch-content"}]},{"group":"Customers","pages":[{"title":"Customers Entity","href":"/us/api/customers/entity"},{"title":"Create a Customer","api":"POST /v1/customers","href":"/us/api/customers/create"},{"title":"Edit Customer Details","api":"PUT /v1/customers/:id","href":"/us/api/customers/edit"},{"title":"Fetch All Customers","api":"GET /v1/customers","href":"/us/api/customers/fetch-all"},{"title":"Fetch Customer With ID","api":"GET /v1/customers/:id","href":"/us/api/customers/fetch-with-id"}]},{"group":"Payment Links","pages":[{"title":"Payment Links Entity","href":"/us/api/payments/payment-links/entity"},{"title":"Create a Standard Payment Link","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/create-standard"},{"title":"Create a UPI Payment Link","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/create-upi"},{"title":"Fetch All Standard Payment Links","api":"GET /v1/payment_links/","href":"/us/api/payments/payment-links/fetch-all-standard"},{"title":"Fetch All UPI Payment Links","api":"GET /v1/payment_links/","href":"/us/api/payments/payment-links/fetch-all-upi"},{"title":"Fetch Standard Payment Links With ID","api":"GET /v1/payment_links/:id","href":"/us/api/payments/payment-links/fetch-id-standard"},{"title":"Fetch UPI Payment Links With ID","api":"GET /v1/payment_links/:id","href":"/us/api/payments/payment-links/fetch-id-upi"},{"title":"Send or Resend Notifications","api":"POST /v1/payment_links/:id/notify_by/:medium","href":"/us/api/payments/payment-links/resend"},{"title":"Update Standard Payment Link","api":"PATCH /v1/payment_links/:id","href":"/us/api/payments/payment-links/update-standard"},{"title":"Update UPI Payment Link","api":"PATCH /v1/payment_links/:id","href":"/us/api/payments/payment-links/update-upi"},{"title":"Cancel a Standard Payment Link","api":"POST /v1/payment_links/:id/cancel","href":"/us/api/payments/payment-links/cancel-standard"},{"title":"Cancel a UPI Payment Link","api":"POST /v1/payment_links/:id/cancel","href":"/us/api/payments/payment-links/cancel-upi"},{"title":"Implement Thematic Changes in Payment Links Checkout Section","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/checkout-theme"},{"title":"Change Business Name","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/change-business-name"},{"title":"Customise Payment Methods - Options and Method Parameters","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/customise-payment-methods"},{"title":"Customise Payment Methods - Options and Config Parameters","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/customise-options-config"},{"title":"Rename Labels in Checkout Section","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/rename-checkout-labels"},{"title":"Rename Labels in Payment Details Section","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/rename-payment-details-labels"},{"title":"Offers on Payment Links","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/offers"},{"title":"Transfer Payments Received Using Payment Links","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/transfer-payments"},{"title":"Perform Third-Party Validation Using Payment Links","api":"POST /v1/payment_links","href":"/us/api/payments/payment-links/third-party-validation"}]},{"group":"QR Codes","pages":[{"title":"QR Codes Entity","href":"/us/api/qr-codes/entity"},{"title":"Create a QR Code","api":"POST /v1/payments/qr_codes","href":"/us/api/qr-codes/create"},{"title":"Close a QR Code","api":"POST /v1/payments/qr_codes/:id/close","href":"/us/api/qr-codes/close"},{"title":"Fetch All QR Codes","api":"GET /v1/payments/qr_codes?count=2","href":"/us/api/qr-codes/fetch-all"},{"title":"Fetch a QR Code","api":"GET /v1/payments/qr_codes/:id","href":"/us/api/qr-codes/fetch-with-id"},{"title":"Fetch QR Codes for a Customer ID","api":"GET /v1/payments/qr_codes?customer_id=\\{customer_id\\}","href":"/us/api/qr-codes/fetch-customer-id"},{"title":"Fetch QR Codes for a Payment ID","api":"GET /v1/payments/qr_codes?payment_id=\\{payment_id\\}","href":"/us/api/qr-codes/fetch-payment-id"},{"title":"Fetch Payments for a QR Code","api":"GET /v1/payments/qr_codes/:id/payments","href":"/us/api/qr-codes/fetch-payments"},{"title":"Update a QR Code","api":"PATCH /v1/payments/qr_codes/:id/","href":"/us/api/qr-codes/update"}]},{"group":"Invoices","pages":[{"title":"Invoices Entity","href":"/us/api/payments/invoices/entity"},{"title":"Create an Invoice With Customer ID","api":"POST /v1/invoices","href":"/us/api/payments/invoices/create-with-customer-id"},{"title":"Create an Invoice With Customer Details","api":"POST /v1/invoices","href":"/us/api/payments/invoices/create-with-details"},{"title":"Update an Invoice","api":"PATCH /v1/invoices/:id","href":"/us/api/payments/invoices/update"},{"title":"Issue an Invoice","api":"POST /v1/invoices/:id/issue","href":"/us/api/payments/invoices/issue"},{"title":"Delete an Invoice","api":"DELETE /v1/invoices/:id","href":"/us/api/payments/invoices/delete"},{"title":"Cancel an Invoice","api":"POST /v1/invoices/:id/cancel","href":"/us/api/payments/invoices/cancel"},{"title":"Fetch an Invoice With ID","api":"GET /v1/invoices/:id","href":"/us/api/payments/invoices/fetch-with-id"},{"title":"Fetch All Invoices","api":"GET /v1/invoices","href":"/us/api/payments/invoices/fetch-all"},{"title":"Send Notifications","api":"POST /v1/invoices/:id/notify_by/:medium","href":"/us/api/payments/invoices/resend"},{"title":"Items Entity","href":"/us/api/payments/invoices/item-entity"},{"title":"Create an Item","api":"POST /v1/items","href":"/us/api/payments/invoices/create-item"},{"title":"Fetch Item With ID","api":"GET /v1/items/:id","href":"/us/api/payments/invoices/fetch-with-id-item"},{"title":"Fetch All Items","api":"GET /v1/items","href":"/us/api/payments/invoices/fetch-all-items"},{"title":"Update an Item","api":"PATCH /v1/items/:id","href":"/us/api/payments/invoices/update-item"},{"title":"Delete an Item","api":"DELETE /v1/items/:id","href":"/us/api/payments/invoices/delete-item"}]},{"group":"Subscriptions","pages":[{"title":"Plans Entity","href":"/us/api/payments/subscriptions/plans-entity"},{"title":"Create a Plan","api":"POST /v1/plans","href":"/us/api/payments/subscriptions/create-plan"},{"title":"Fetch All Plans","api":"GET /v1/plans","href":"/us/api/payments/subscriptions/fetch-all-plans"},{"title":"Fetch a Plan With ID","api":"GET /v1/plans/:id","href":"/us/api/payments/subscriptions/fetch-a-plan"},{"title":"Subscriptions Entity","href":"/us/api/payments/subscriptions/entity"},{"title":"Create a Subscription","api":"POST /v1/subscriptions","href":"/us/api/payments/subscriptions/create-subscription"},{"title":"Create a Subscription Link","api":"POST /v1/subscriptions","href":"/us/api/payments/subscriptions/create-subscription-link"},{"title":"Fetch All Subscriptions","api":"GET /v1/subscriptions","href":"/us/api/payments/subscriptions/fetch-subscriptions"},{"title":"Fetch a Subscription With ID","api":"GET /v1/subscriptions/:id","href":"/us/api/payments/subscriptions/fetch-subscription-id"},{"title":"Cancel a Subscription","api":"POST /v1/subscriptions/:id/cancel","href":"/us/api/payments/subscriptions/cancel-subscription"},{"title":"Update a Subscription","api":"PATCH /v1/subscriptions/:id","href":"/us/api/payments/subscriptions/update-subscription"},{"title":"Fetch Details of a Pending Update","api":"GET /v1/subscriptions/:id/retrieve_scheduled_changes","href":"/us/api/payments/subscriptions/fetch-pending-update-details"},{"title":"Cancel an Update","api":"POST /v1/subscriptions/:id/cancel_scheduled_changes","href":"/us/api/payments/subscriptions/cancel-update"},{"title":"Pause a Subscription","api":"POST /v1/subscriptions/:id/pause","href":"/us/api/payments/subscriptions/pause-subscription"},{"title":"Resume a Subscription","api":"POST /v1/subscriptions/:id/resume","href":"/us/api/payments/subscriptions/resume-subscription"},{"title":"Fetch All Invoices of a Subscription","api":"GET /v1/invoices?subscription_id=:sub_id","href":"/us/api/payments/subscriptions/fetch-invoices"},{"title":"Link an Offer to a Subscription","api":"POST /v1/subscriptions","href":"/us/api/payments/subscriptions/link-offer"},{"title":"Delete an Offer Linked to a Subscription","api":"DELETE /v1/subscriptions/:sub_id/:offer_id","href":"/us/api/payments/subscriptions/delete-offer"}]},{"group":"Route","pages":[{"title":"Linked Account Entity","href":"/us/api/payments/route/linked-account-entity"},{"title":"Create a Linked Account","api":"POST /v2/accounts","href":"/us/api/payments/route/create-linked-account"},{"title":"Update a Linked Account","api":"PATCH /v2/accounts/:account_id","href":"/us/api/payments/route/update-linked-accounts"},{"title":"Fetch a Linked Account With ID","api":"GET /v2/accounts/:account_id","href":"/us/api/payments/route/fetch-with-id"},{"title":"Stakeholder Entity","href":"/us/api/payments/route/stakeholder-entity"},{"title":"Create a Stakeholder Account","api":"POST /v2/accounts/:account_id/stakeholders","href":"/us/api/payments/route/create-stakeholder"},{"title":"Update a Stakeholder Account","api":"PATCH /v2/accounts/:account_id/stakeholders/:stakeholder_id","href":"/us/api/payments/route/update-stakeholder"},{"title":"Product Configuration Entity","href":"/us/api/payments/route/product-configuration-entity"},{"title":"Request a Product Configuration","api":"POST /v2/accounts/:account_id/products","href":"/us/api/payments/route/request-product-config"},{"title":"Update a Product Configuration","api":"PATCH /v2/accounts/:account_id/products/:product_id","href":"/us/api/payments/route/update-product-config"},{"title":"Fetch a Product Configuration","api":"GET /v2/accounts/:account_id/products/:product_id","href":"/us/api/payments/route/fetch-product-config"},{"title":"Transfers Entity","href":"/us/api/payments/route/transfers-entity"},{"title":"Create Transfers From Orders","api":"POST /v1/orders","href":"/us/api/payments/route/create-transfers-orders"},{"title":"Create Transfers From Payments","api":"POST /v1/payments/:id/transfers","href":"/us/api/payments/route/create-transfers-payments"},{"title":"Create a Direct Transfer","api":"POST /v1/transfers","href":"/us/api/payments/route/direct-transfers"},{"title":"Create a Direct Transfer (Idempotent Request)","api":"POST /v1/transfers","href":"/us/api/payments/route/direct-transfers-idempotent-request"},{"title":"Fetch Transfers for a Payment","api":"GET /v1/payments/:id/transfers","href":"/us/api/payments/route/fetch-transfers-payment"},{"title":"Fetch Transfer for an Order","api":"GET /v1/orders/:id/?expand[]=transfers\u0026status=processing","href":"/us/api/payments/route/fetch-transfer-order"},{"title":"Fetch a Transfer With ID","api":"GET /v1/transfers/:id","href":"/us/api/payments/route/fetch-a-transfer"},{"title":"Fetch Transfers for a Settlement","api":"GET /v1/transfers?recipient_settlement_id=:id","href":"/us/api/payments/route/fetch-transfers-for-a-settlement"},{"title":"Fetch Settlement Details","api":"GET /v1/transfers?expand[]=recipient_settlement","href":"/us/api/payments/route/fetch-settlement-details"},{"title":"Fetch Payments of a Linked Account","api":"GET /v1/payments/","href":"/us/api/payments/route/fetch-payments-linked-account"},{"title":"Refund Payments and Reverse Transfer from a Linked Account","api":"POST /v1/payments/:id/refund","href":"/us/api/payments/route/refund-payments-and-reverse-transfer"},{"title":"Reverse a Transfer","api":"POST /v1/transfers/:id/reversals","href":"/us/api/payments/route/reverse-a-transfer"},{"title":"Fetch Reversals for a Transfer","api":"GET /v1/transfers/:id/reversals","href":"/us/api/payments/route/fetch-reversals"},{"title":"Modify Settlement Hold for Transfers","api":"PATCH /v1/transfers/:id","href":"/us/api/payments/route/modify-settlement-hold"}]},{"group":"Smart Collect","pages":[{"title":"Smart Collect Entity","href":"/us/api/payments/smart-collect/entity"},{"title":"Create a Customer Identifier With Bank Account Receiver","api":"POST /v1/virtual_accounts","href":"/us/api/payments/smart-collect/create-cust-id-bank-account"},{"title":"Close a Customer Identifier","api":"POST /v1/virtual_accounts/:id/close","href":"/us/api/payments/smart-collect/close"},{"title":"Fetch a Customer Identifier Using id","api":"GET /v1/virtual_accounts/:id","href":"/us/api/payments/smart-collect/fetch-with-id"},{"title":"Fetch All Customer Identifiers","api":"GET /v1/virtual_accounts","href":"/us/api/payments/smart-collect/fetch-all"},{"title":"Fetch Payments for a Customer Identifier","api":"GET /v1/virtual_accounts/:id/payments","href":"/us/api/payments/smart-collect/fetch-payments-cust-id"},{"title":"Fetch Payments Made Using Bank Transfer","api":"GET /v1/payments/:id/bank_transfer","href":"/us/api/payments/smart-collect/fetch-payments-bank-transfer"},{"title":"Fetch Payments Using UTR Number","api":"GET /v1/payments?skip=0\u0026count=25\u0026va_transaction_id=:id\u0026virtual_account=1","href":"/us/api/payments/smart-collect/fetch-payments-bank-transfer-utr"},{"title":"Update a Customer Identifier","api":"PATCH /v1/virtual_accounts/:id","href":"/us/api/payments/smart-collect/update"},{"title":"Smart Collect With TPV","sidebarTitle":"Smart Collect TPV","href":"/us/api/payments/smart-collect-tpv"},{"title":"Smart Collect With TPV Entity","href":"/us/api/payments/smart-collect-tpv/entity"},{"title":"Create a Customer Identifier With TPV","api":"POST /v1/virtual_accounts","href":"/us/api/payments/smart-collect-tpv/create"},{"title":"Add an Allowed Payer Account","api":"POST /v1/virtual_accounts/:va_id/allowed_payers","href":"/us/api/payments/smart-collect-tpv/add-allowed-payer"},{"title":"Fetch a Customer Identifier Using id With TPV","api":"GET /v1/virtual_accounts/:id","href":"/us/api/payments/smart-collect-tpv/fetch-with-id"},{"title":"Fetch All Customer Identifiers With TPV","api":"GET /v1/virtual_accounts","href":"/us/api/payments/smart-collect-tpv/fetch-all"},{"title":"Fetch Payments for a Customer Identifier With TPV","api":"GET /v1/virtual_accounts/:id/payments","href":"/us/api/payments/smart-collect-tpv/fetch-payments"},{"title":"Fetch Payment Details using ID and Transfer Method","api":"GET /v1/payments/:id/bank_transfer","href":"/us/api/payments/smart-collect-tpv/fetch-payment-id-transfer"},{"title":"Delete an Allowed Payer Account","api":"DELETE /v1/virtual_accounts/:va_id/allowed_payers/:id","href":"/us/api/payments/smart-collect-tpv/delete-allowed-payer"},{"title":"Smart Collect 2.0 APIs","sidebarTitle":"Smart Collect 2.0","href":"/us/api/payments/smart-collect-2"},{"title":"Smart Collect 2.0 Entity","href":"/us/api/payments/smart-collect-2/entity"},{"title":"Create a Customer Identifier With VPA and Bank Account Receivers With Smart Collect 2.0","api":"POST /v1/virtual_accounts","href":"/us/api/payments/smart-collect-2/create-cust-id-bank-account-vpa"},{"title":"Add VPA Receiver to an Existing Customer Identifier","api":"POST /v1/virtual_accounts/:id/receivers","href":"/us/api/payments/smart-collect-2/add-receiver-vpa"},{"title":"Fetch Payments Made Using UPI Payment Method","api":"GET /v1/payments/:id/upi_transfer","href":"/us/api/payments/smart-collect-2/fetch-payments-upi"}]}]},{"group":"Bills","root":{"title":"About Bills","href":"/us/api/bills"},"pages":[{"title":"Bills Entity","href":"/us/api/bills/entity"},{"title":"Create a Bill","api":"POST /v1/bills","href":"/us/api/bills/create"},{"title":"Update a Bill","api":"PATCH /v1/bills/:bill_id","href":"/us/api/bills/update"},{"title":"Delete a Bill","api":"DELETE /v1/bills/:bill_id","href":"/us/api/bills/delete"}]},{"group":"Partners","pages":[{"group":"Account","pages":[{"title":"Account Entity","href":"/us/api/partners/account-onboarding/entity"},{"title":"Create an Account","api":"POST /v2/accounts","href":"/us/api/partners/account-onboarding/create"},{"title":"Fetch an Account","api":"GET /v2/accounts/:account_id","href":"/us/api/partners/account-onboarding/fetch"},{"title":"Update an Account","api":"PATCH /v2/accounts/:account_id","href":"/us/api/partners/account-onboarding/update"},{"title":"Delete an Account","api":"DELETE /v2/accounts/:account_id","href":"/us/api/partners/account-onboarding/delete"}]},{"group":"Product Configuration","pages":[{"title":"Product Configuration Entity","href":"/us/api/partners/product-configuration/entity"},{"title":"Request a Product Configuration","api":"POST /v2/accounts/:account_id/products","href":"/us/api/partners/product-configuration/request"},{"title":"Fetch a Product Configuration","api":"GET /v2/accounts/:account_id/products/:product_id","href":"/us/api/partners/product-configuration/fetch"},{"title":"Update Settlement Account Details","api":"PATCH /v2/accounts/:account_id/products/:product_id","href":"/us/api/partners/product-configuration/update-settlement-account-details"},{"title":"Request Payment Methods","api":"PATCH /v2/accounts/:account_id/products/:product_id","href":"/us/api/partners/product-configuration/update-request-payment-methods"}]},{"group":"Stakeholder","pages":[{"title":"Stakeholder Entity","href":"/us/api/partners/stakeholder/entity"},{"title":"Create a Stakeholder","api":"POST /v2/accounts/:account_id/stakeholders","href":"/us/api/partners/stakeholder/create"},{"title":"Fetch a Stakeholder With ID","api":"GET /v2/accounts/:account_id/stakeholders/:stakeholder_id","href":"/us/api/partners/stakeholder/fetch-with-id"},{"title":"Fetch All Stakeholders","api":"GET /v2/accounts/:account_id/stakeholders","href":"/us/api/partners/stakeholder/fetch-all"},{"title":"Update a Stakeholder","api":"PATCH /v2/accounts/:account_id/stakeholders/:stakeholder_id","href":"/us/api/partners/stakeholder/update"}]},{"group":"Documents","pages":[{"title":"Upload Account Documents","api":"POST /v2/accounts/:account_id/documents","href":"/us/api/partners/upload-document/upload-account-documents"},{"title":"Upload Stakeholder Documents","api":"POST /v2/accounts/:account_id/stakeholders/:stakeholder_id/documents","href":"/us/api/partners/upload-document/upload-stakeholder-documents"},{"title":"Fetch Account Documents","api":"GET /v2/accounts/:account_id/documents","href":"/us/api/partners/upload-document/fetch-account-documents"},{"title":"Fetch Stakeholder Documents","api":"GET /v2/accounts/:account_id/stakeholders/:stakeholder_id/documents","href":"/us/api/partners/upload-document/fetch-stakeholder-documents"}]},{"group":"Webhooks","pages":[{"title":"Webhooks Entity","href":"/us/api/partners/webhooks/entity"},{"title":"Create a Webhook","api":"POST /v2/accounts/:account_id/webhooks","href":"/us/api/partners/webhooks/create"},{"title":"Fetch a Webhook With ID","api":"GET /v2/accounts/:account_id/webhooks/:webhook_id","href":"/us/api/partners/webhooks/fetch-with-id"},{"title":"Fetch All Webhooks","api":"GET /v2/accounts/:account_id/webhooks","href":"/us/api/partners/webhooks/fetch-all"},{"title":"Update a Webhook","api":"PATCH /v2/accounts/:account_id/webhooks/:webhook_id","href":"/us/api/partners/webhooks/update"},{"title":"Delete a Webhook","api":"DELETE /v2/accounts/:account_id/webhooks/:webhook_id","href":"/us/api/partners/webhooks/delete"}]}]},{"group":"Payouts","root":{"title":"Get Started","href":"/us/api/x"},"pages":[{"group":"Account Validation","pages":[{"title":"Account Validation Entity","href":"/us/api/x/account-validation/entity"},{"title":"Create a Contact","api":"POST /v1/contacts","href":"/us/api/x/account-validation/create-contact"},{"title":"Create a Fund Account of Type Bank Account","api":"POST /v1/fund_accounts","href":"/us/api/x/account-validation/bank-account/create-fund-account"},{"title":"Validate a Bank Account","api":"POST /v1/fund_accounts/validations","href":"/us/api/x/account-validation/bank-account"},{"title":"Create a Fund Account of Type VPA","api":"POST /v1/fund_accounts","href":"/us/api/x/account-validation/vpa/create-fund-account"},{"title":"Validate a VPA","api":"POST /v1/fund_accounts/validations","href":"/us/api/x/account-validation/vpa"},{"title":"Validate Bank Account (VPA) via Reverse Penny Drop","api":"POST /v1/fund_accounts/validations","href":"/us/api/x/account-validation/reverse-penny-drop"},{"title":"Fetch All Account Validation Transactions","api":"GET /v1/fund_accounts/validations?account_number=\\{account number\\}","href":"/us/api/x/account-validation/fetch-all-transactions"},{"title":"Fetch Account Validation Transaction With ID","api":"GET /v1/fund_accounts/validations/:id","href":"/us/api/x/account-validation/fetch-transactions-with-id"}]},{"group":"Composite Account Validation","pages":[{"title":"Composite Account Validation Entity","href":"/us/api/x/composite-account-validation/entity"},{"title":"Validate a Bank Account","api":"POST /v1/fund_accounts/validations","href":"/us/api/x/composite-account-validation/bank-account"},{"title":"Validate a VPA","api":"POST /v1/fund_accounts/validations","href":"/us/api/x/composite-account-validation/vpa"},{"title":"Fetch All Account Validation Transactions","api":"GET /v1/fund_accounts/validations?account_number=\\{account number\\}","href":"/us/api/x/composite-account-validation/fetch-all-transactions"},{"title":"Fetch Account Validation Transaction With ID","api":"GET /v1/fund_accounts/validations/:id","href":"/us/api/x/composite-account-validation/fetch-transactions-with-id"}]},{"group":"Contacts","pages":[{"title":"Contacts Entity","href":"/us/api/x/contacts/entity"},{"title":"Create a Contact","api":"POST /v1/contacts","href":"/us/api/x/contacts/create"},{"title":"Update a Contact","api":"PATCH /v1/contacts/:id","href":"/us/api/x/contacts/update"},{"title":"Fetch All Contacts","api":"GET /v1/contacts","href":"/us/api/x/contacts/fetch-all"},{"title":"Fetch Contact With ID","api":"GET /v1/contacts/:id","href":"/us/api/x/contacts/fetch-with-id"},{"title":"Activate or Deactivate a Contact","api":"PATCH /v1/contacts/:id","href":"/us/api/x/contacts/activate-or-deactivate"}]},{"group":"Fund Accounts","pages":[{"title":"Fund Accounts Entity","href":"/us/api/x/fund-accounts/entity"},{"title":"Create a Fund Account of Type Bank Account","api":"POST /v1/fund_accounts","href":"/us/api/x/fund-accounts/create/bank-account"},{"title":"Create a Fund Account of Type VPA","api":"POST /v1/fund_accounts","href":"/us/api/x/fund-accounts/create/vpa"},{"title":"Fetch All Fund Accounts","api":"GET /v1/fund_accounts","href":"/us/api/x/fund-accounts/fetch-all"},{"title":"Fetch a Fund Account With ID","api":"GET /v1/fund_accounts/:id","href":"/us/api/x/fund-accounts/fetch-with-id"},{"title":"Activate or Deactivate a Fund Account","api":"PATCH /v1/fund_accounts/:id","href":"/us/api/x/fund-accounts/activate-or-deactivate"}]},{"group":"Create and Manage Payouts","pages":[{"title":"Payouts Entity","href":"/us/api/x/payouts/entity"},{"title":"Create a Payout to a Bank Account","api":"POST /v1/payouts","href":"/us/api/x/payouts/create/bank-account"},{"title":"Create a Payout to a VPA","api":"POST /v1/payouts","href":"/us/api/x/payouts/create/vpa"},{"title":"Fetch All Payouts","api":"GET /v1/payouts?account_number=\\{account number\\}","href":"/us/api/x/payouts/fetch-all"},{"title":"Fetch Payout With ID","api":"GET /v1/payouts/:id","href":"/us/api/x/payouts/fetch-with-id"},{"title":"Cancel a Queued Payout","api":"POST /v1/payouts/:id/cancel","href":"/us/api/x/payouts/cancel"}]},{"group":"Payouts to Cards","pages":[{"title":"Payouts to Cards Entity","href":"/us/api/x/payouts-cards/entity"},{"title":"Create a Payout Without Saving Card","api":"POST /v1/payouts","href":"/us/api/x/payouts-cards/create/without-saving-card"},{"title":"Create a Fund Account for Externally Tokenised Card","api":"POST /v1/fund_accounts","href":"/us/api/x/payouts-cards/create/save-card/external-token/fund-account"},{"title":"Create a Payout to Externally Tokenised Card","api":"POST /v1/payouts","href":"/us/api/x/payouts-cards/create/save-card/external-token/payout"},{"title":"Create a Fund Account for Card with Razorpay TokenHQ","api":"POST /v1/fund_accounts","href":"/us/api/x/payouts-cards/create/save-card/razorpay-tokenhq/fund-account"},{"title":"Create a Payout to Card with Razorpay TokenHQ","api":"POST /v1/payouts","href":"/us/api/x/payouts-cards/create/save-card/razorpay-tokenhq/payout"}]},{"group":"Payout Composite","pages":[{"title":"Payout Composite Entity","href":"/us/api/x/payout-composite/entity"},{"title":"Create a Payout to Bank Account Using Composite API","api":"POST /v1/payouts","href":"/us/api/x/payout-composite/create/bank-account"},{"title":"Create a Payout to VPA Using Composite API","api":"POST /v1/payouts","href":"/us/api/x/payout-composite/create/vpa"},{"title":"Create a Payout to Card Using Composite API","api":"POST /v1/payouts","href":"/us/api/x/payout-composite/create/card"}]},{"group":"Payouts Approval","pages":[{"title":"Payouts Approval Entity","href":"/us/api/x/payouts-approval/entity"},{"title":"Approve Payouts","api":"POST /v1/payouts/:id/approve","href":"/us/api/x/payouts-approval/approve"},{"title":"Reject Payouts","api":"POST /v1/payouts/:id/reject","href":"/us/api/x/payouts-approval/reject"}]},{"group":"Payout Idempotency","pages":[{"title":"Make a Request Idempotent","api":"POST /v1/payouts","href":"/us/api/x/payout-idempotency/make-request"}]},{"group":"Payout Links","pages":[{"title":"Payout Links Entity","href":"/us/api/x/payout-links/entity"},{"title":"Create Payout Links Using Contact Details","api":"POST /v1/payout-links","href":"/us/api/x/payout-links/create/use-contact-details"},{"title":"Create Payout Links Using Contact ID","api":"POST /v1/payout-links","href":"/us/api/x/payout-links/create/use-contact-id"},{"title":"Fetch All Payout Links","api":"GET /v1/payout-links","href":"/us/api/x/payout-links/fetch-all"},{"title":"Fetch a Payout Link With ID","api":"GET v1/payout-links/:id?expand[l=payouts","href":"/us/api/x/payout-links/fetch-with-id"},{"title":"Cancel a Payout Link","api":"POST /v1/payout-links/:id/cancel","href":"/us/api/x/payout-links/cancel"}]},{"group":"Payout Wallet - Amazon","pages":[{"title":"Payout Wallet - Amazon Entity","href":"/us/api/x/payout-wallet/entity"},{"title":"Create a Contact","api":"POST /v1/contacts/","href":"/us/api/x/payout-wallet/create/contact"},{"title":"Create a Fund Account of Type Wallet","api":"POST /v1/fund-accounts/","href":"/us/api/x/payout-wallet/create/fund-account"},{"title":"Create a Payout to Amazon Pay Wallet","api":"POST /v1/payouts","href":"/us/api/x/payout-wallet/create/payout"},{"title":"Make Payouts to Amazon Pay Wallet Using Composite API","api":"POST /v1/payouts","href":"/us/api/x/payout-wallet/create/payout-composite"}]},{"group":"Balance","pages":[{"title":"Fetch Balance","api":"GET /v1/banking_balances","href":"/us/api/x/account-validation/balance-fetch"}]},{"group":"Transactions","pages":[{"title":"Transactions Entity","href":"/us/api/x/transactions/entity"},{"title":"Fetch All Transactions","api":"GET /v1/transactions?account_number=\\{account number\\}","href":"/us/api/x/transactions/fetch-all"},{"title":"Fetch Transactions With ID","api":"GET /v1/transactions/:id","href":"/us/api/x/transactions/fetch-with-id"}]}]}]},{"tab":"Developer Tools","icon":"screwdriver-wrench","pages":[{"title":"Developer Tools","href":"/us/developer-tools"}]},{"tab":"Prerequisites (Payments)","hidden":true,"pages":[{"title":"Prerequisites (Payments)","href":"/us/payments/payment-gateway/ecommerce-plugins/shopify-razorpay-secure"}]},{"tab":"Recurring Payments","hidden":true,"pages":[{"title":"Recurring Payments","href":"/us/payments/recurring-payments"}]},{"tab":"Web Integration - Razorpay Custom Checkout","hidden":true,"pages":[{"title":"Web Integration - Razorpay Custom Checkout","href":"/us/payments/payment-gateway/web-integration/custom"}]}]},{"version":"Malaysia","href":"https://curlec.com/docs"}]},"basePath":"","title":"API Authentication - Razorpay","buildId":"dpl_6PxPD4Fj1JDU9BJxEHvfdUmxKThw","deploymentId":"dpl_6PxPD4Fj1JDU9BJxEHvfdUmxKThw","dynamics":[],"chunks":[]}