The payout amount, in paise. For example, pass 1000000 to transfer an amount of ₹10,000. Minimum value 100. The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.
The mode to be used to create the payout. Available mode is UPI. Ensure you enter the payout modes in upper case as the payout modes are case-sensitive.
The purpose of the payout that is being created. The following classifications are available in the system by default:
refund
cashback
payout
salary
utility bill
vendor bill
Additional purposes for payouts can be created via the Dashboard and then used in the API. However, it is not possible to create a new purpose for the payout via the API.
A user-generated reference given to the payout. Maximum length is 40 characters. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.
Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space. This is a custom note that also appears on the bank statement. If no value is passed for this parameter, it defaults to the Merchant Billing Label.
Enter the important text in the first 9 characters as banks truncate the rest as per their standards.
Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.
The payout amount, in paise. For example, if you want to transfer ₹10,000, pass 1000000. Minimum value 100. The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.
Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.
The purpose of the payout that is being created. The following classifications are available in the system by default:
refund
cashback
payout
salary
utility bill
vendor bill
Additional purposes for payouts can be created via the Dashboard and then used in the API. However, it is not possible to create a new purpose for the payout via the API.
Maximum length is 40 characters. A user-generated reference given to the payout. For example, Acme Transaction ID 12345. You can use this field to store your own transaction ID, if any.
Custom note that also appears on the bank statement. Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space.
If no value is passed for this parameter, it defaults to the Merchant Billing Label. Ensure that the most important text forms the first 9 characters as banks may truncate the rest as per their standards.
Indicates the fee type charged for the payout. Possible values is free_payout.
Last modified on October 8, 2026
Was this page helpful?
{"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":"6af5cd749aa4e2cefacb1506","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/x/payouts/create/vpa","slug":"/us/api/x/payouts/create/vpa","pageMetadata":{"title":"Create a Payout to a VPA","description":"Create a Payout to a VPA using API.","api":"POST /v1/payouts","href":"/us/api/x/payouts/create/vpa"},"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: \"Create a Payout to a VPA using API.\"\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`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,ParamField,ResponseField,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,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`,_jsxs(_components.p,{children:[`Use this endpoint to create a payout to fund account type `,_jsx(_components.code,{children:`vpa`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`To understand the status of the payouts, refer to `,_jsx(_components.a,{href:`/errors/x/payout-status-details`,children:`Payout Status Details`}),`.`]}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Watch Out!`})}),_jsxs(_components.p,{children:[`Ensure you `,_jsx(_components.a,{href:`/x/dashboard/allowlist-ip`,children:`allowlist IPs`}),` and pass the `,_jsx(_components.a,{href:`/us/api/x/payout-idempotency/make-request`,children:`idempotency key`}),` to make a successful payout.`]})]}),`\n`,`\n`,`\n`,_jsx(Heading,{level:`2`,id:`request-parameters`,children:`Request Parameters`}),`\n`,_jsxs(ParamField,{body:`account_number`,type:`string`,required:true,id:`param-account-number`,children:[_jsxs(_components.p,{children:[`The account from which you want to make the payout. For example, `,_jsx(_components.code,{children:`7878780080316316`}),`.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Pass your customer identifier if you want money to be deducted from RazorpayX Lite.`}),`\n`,_jsx(_components.li,{children:`Pass your Current Account number if you want money to be deducted from your Current Account.`}),`\n`]}),_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Watch Out!`})}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`This is `,_jsx(_components.strong,{children:`not`}),` your contact’s bank account number. Log in to your `,_jsx(_components.a,{href:`https://x.razorpay.com/auth/?intent=current_account`,children:_jsx(_components.strong,{children:`RazorpayX Dashboard`})}),` and go to `,_jsx(_components.strong,{children:`My Account \u0026 Settings → Banking → Customer Identifier`}),`.`]}),`\n`,_jsx(_components.li,{children:`This value is different for Test Mode and Live Mode.`}),`\n`,_jsxs(_components.li,{children:[`RazorpayX Lite is currently not available for new merchants. To set up a new RazorpayX account, refer to `,_jsx(_components.a,{href:`/x/account-types/current-account`,children:`Current Account`}),`.`]}),`\n`]})]})]}),`\n`,_jsx(ParamField,{body:`fund_account_id`,type:`string`,required:true,id:`param-fund-account-id`,children:_jsxs(_components.p,{children:[`The unique identifier linked to a fund account. For example, `,_jsx(_components.code,{children:`fa_00000000000001`}),`.`]})}),`\n`,_jsx(ParamField,{body:`amount`,type:`integer`,required:true,id:`param-amount`,children:_jsxs(_components.p,{children:[`The payout amount, in paise. For example, pass `,_jsx(_components.code,{children:`1000000`}),` to transfer an amount of ₹10,000. Minimum value `,_jsx(_components.code,{children:`100`}),`. `,_jsx(`br`,{}),` The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.`]})}),`\n`,_jsx(ParamField,{body:`currency`,type:`string`,required:true,id:`param-currency`,children:_jsxs(_components.p,{children:[`The payout currency. Here, it is `,_jsx(_components.code,{children:`INR`}),`.`]})}),`\n`,_jsx(ParamField,{body:`mode`,type:`string`,required:true,id:`param-mode`,children:_jsxs(_components.p,{children:[`The mode to be used to create the payout. Available mode is `,_jsx(_components.code,{children:`UPI`}),`. Ensure you enter the payout modes in upper case as the payout modes are case-sensitive.`]})}),`\n`,_jsxs(ParamField,{body:`purpose`,type:`string`,required:true,id:`param-purpose`,children:[_jsx(_components.p,{children:`The purpose of the payout that is being created. The following classifications are available in the system by default:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`refund`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`cashback`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`payout`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salary`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`utility bill`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`vendor bill`}),` `,_jsx(`br`,{})]}),`\n`]}),_jsxs(_components.p,{children:[`Additional purposes for payouts can be created via the `,_jsx(_components.a,{href:`https://x.razorpay.com/`,children:`Dashboard`}),` and then used in the API. However, it is not possible to create a new purpose for the payout via the API.`]})]}),`\n`,_jsxs(ParamField,{body:`queue_if_low_balance`,type:`boolean`,id:`param-queue-if-low-balance`,children:[_jsx(_components.p,{children:`Possible values:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`true`}),`: The payout is queued when your business account does not have sufficient balance to process the payout.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`false`}),` (default): The payout is never queued. The payout fails if your business account does not have sufficient balance to process the payout.`]}),`\n`]})]}),`\n`,_jsx(ParamField,{body:`reference_id`,type:`string`,id:`param-reference-id`,children:_jsxs(_components.p,{children:[`A user-generated reference given to the payout. Maximum length is 40 characters. For example, `,_jsx(_components.code,{children:`Acme Transaction ID 12345`}),`. You can use this field to store your own transaction ID, if any.`]})}),`\n`,_jsx(ParamField,{body:`narration`,type:`string`,id:`param-narration`,children:_jsxs(_components.p,{children:[`Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space. This is a custom note that also appears on the bank statement. If no value is passed for this parameter, it defaults to the Merchant Billing Label. `,_jsx(`br`,{}),` `,_jsx(`br`,{}),` Enter the important text in the first 9 characters as banks truncate the rest as per their standards.`]})}),`\n`,_jsx(ParamField,{body:`notes`,type:`array of objects`,id:`param-notes`,children:_jsxs(_components.p,{children:[`Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, `,_jsx(_components.code,{children:`\"note_key\": \"Beam me up Scotty”`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response-parameters`,children:`Response Parameters`}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:_jsxs(_components.p,{children:[`The unique identifier of the payout. For example, `,_jsx(_components.code,{children:`pout_00000000000001`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`entity`,type:`string`,id:`param-entity`,children:_jsxs(_components.p,{children:[`The entity being created. Here, it will be `,_jsx(_components.code,{children:`payout`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`fund_account_id`,type:`string`,id:`param-fund-account-id-1`,children:_jsxs(_components.p,{children:[`The unique identifier linked to the fund account. For example, `,_jsx(_components.code,{children:`fa_00000000000001`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`amount`,type:`integer`,id:`param-amount-1`,children:_jsxs(_components.p,{children:[`The payout amount, in paise. For example, if you want to transfer ₹10,000, pass `,_jsx(_components.code,{children:`1000000`}),`. Minimum value `,_jsx(_components.code,{children:`100`}),`. `,_jsx(`br`,{}),`The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.`]})}),`\n`,_jsx(ResponseField,{name:`currency`,type:`string`,id:`param-currency-1`,children:_jsxs(_components.p,{children:[`The payout’s currency. Here, it is `,_jsx(_components.code,{children:`INR`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`notes`,type:`array of objects`,id:`param-notes-1`,children:_jsxs(_components.p,{children:[`Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, `,_jsx(_components.code,{children:`\"note_key\": \"Beam me up Scotty”`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`fees`,type:`integer`,id:`param-fees`,children:_jsxs(_components.p,{children:[`The fees for the payout. This value is returned only when the payout moves to the `,_jsx(_components.code,{children:`processing`}),` state. For example, `,_jsx(_components.code,{children:`5`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`tax`,type:`integer`,id:`param-tax`,children:_jsxs(_components.p,{children:[`The tax that is applicable for the fee being charged. This value is returned only when the payout moves to the `,_jsx(_components.code,{children:`processing`}),` state. For example, `,_jsx(_components.code,{children:`1`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:[_jsx(_components.p,{children:`The status of the payout. Possible payout states:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`queued`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`pending`}),` (if you have `,_jsx(_components.a,{href:`/x/manage-teams/approval-workflow`,children:`Approval Workflow`}),` enabled)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`rejected`}),` (if you have `,_jsx(_components.a,{href:`/x/manage-teams/approval-workflow`,children:`Approval Workflow`}),` enabled)`]}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`processing`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`processed`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`cancelled`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`reversed`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`failed`})}),`\n`]}),_jsxs(_components.p,{children:[`Know more about `,_jsx(_components.a,{href:`/x/payouts/states-life-cycle`,children:`Payout States`}),` and `,_jsx(_components.a,{href:`/errors/x/payout-status-details`,children:`Payout Status Details`}),`.`]})]}),`\n`,_jsx(ResponseField,{name:`utr`,type:`string`,id:`param-utr`,children:_jsxs(_components.p,{children:[`The unique transaction number linked to a payout. For example, `,_jsx(_components.code,{children:`HDFCN00000000001`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`mode`,type:`string`,id:`param-mode-1`,children:[_jsx(_components.p,{children:`The mode used to make the payout. Available modes:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`NEFT`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`RTGS`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`IMPS`}),` `,_jsx(`br`,{})]}),`\n`]}),_jsx(_components.p,{children:`The payout modes are case-sensitive.`})]}),`\n`,_jsxs(ResponseField,{name:`purpose`,type:`string`,id:`param-purpose-1`,children:[_jsx(_components.p,{children:`The purpose of the payout that is being created. The following classifications are available in the system by default:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`refund`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`cashback`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`payout`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salary`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`utility bill`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`vendor bill`}),` `,_jsx(`br`,{})]}),`\n`]}),_jsxs(_components.p,{children:[`Additional purposes for payouts can be created via the `,_jsx(_components.a,{href:`https://x.razorpay.com/`,children:`Dashboard`}),` and then used in the API. However, it is not possible to create a new purpose for the payout via the API.`]})]}),`\n`,_jsx(ResponseField,{name:`reference_id`,type:`string`,id:`param-reference-id-1`,children:_jsxs(_components.p,{children:[`Maximum length is 40 characters. A user-generated reference given to the payout. For example, `,_jsx(_components.code,{children:`Acme Transaction ID 12345`}),`. You can use this field to store your own transaction ID, if any.`]})}),`\n`,_jsx(ResponseField,{name:`debit_account_number`,type:`string`,id:`param-debit-account-number`,children:_jsxs(_components.p,{children:[`The account from which the payout was processed. For example, `,_jsx(_components.code,{children:`002281300012871`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`narration`,type:`string`,id:`param-narration-1`,children:_jsxs(_components.p,{children:[`Custom note that also appears on the bank statement. Maximum length 30 characters. Allowed characters: `,_jsx(_components.code,{children:`a-z`}),`, `,_jsx(_components.code,{children:`A-Z`}),`, `,_jsx(_components.code,{children:`0-9`}),` and space. `,_jsx(`br`,{}),` `,_jsx(`br`,{}),` If no value is passed for this parameter, it defaults to the Merchant Billing Label. Ensure that the most important text forms the first 9 characters as banks may truncate the rest as per their standards.`]})}),`\n`,_jsx(ResponseField,{name:`batch_id`,type:`string`,id:`param-batch-id`,children:_jsxs(_components.p,{children:[`This value is returned if the contact was created as part of a bulk upload. For example, `,_jsx(_components.code,{children:`batch_00000000000001`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`status_details`,type:`object`,id:`param-status-details`,children:_jsxs(_components.p,{children:[`This parameter returns the current status of the payout. For example, `,_jsx(_components.code,{children:`IMPS is not enabled on beneficiary account, Retry with different mode.`})]})}),`\n`,_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description`,children:_jsxs(_components.p,{children:[`A description for the error. For example, `,_jsx(_components.code,{children:`IMPS is not enabled on beneficiary account, please retry with different mode`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`source`,type:`string`,id:`param-source`,children:[_jsx(_components.p,{children:`Possible values:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`gateway`}),`: Technical error at Razorpay Partner bank.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`beneficiary_bank`}),`: Technical error at beneficiary bank.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`business`}),`: Merchant action required.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`internal`}),`: Technical error at Razorpay’s server.`]}),`\n`]})]}),`\n`,_jsx(ResponseField,{name:`reason`,type:`string`,id:`param-reason`,children:_jsxs(_components.p,{children:[`The error reason. For example, `,_jsx(_components.code,{children:`imps_not_allowed`}),`. Know more about `,_jsx(_components.a,{href:`/errors/x/payout-status-details`,children:`Payout Status Details and Next Steps`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`created_at`,type:`integer`,id:`param-created-at`,children:_jsx(_components.p,{children:`Indicates the Unix timestamp when this payout was created.`})}),`\n`,_jsx(ResponseField,{name:`fee_type`,type:`string`,id:`param-fee-type`,children:_jsxs(_components.p,{children:[`Indicates the fee type charged for the payout. Possible values is `,_jsx(_components.code,{children:`free_payout`}),`.`]})})]})}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":"Create a Payout to a VPA","description":"Create a Payout to a VPA using API.","api":"POST /v1/payouts","href":"/us/api/x/payouts/create/vpa"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,ParamField,RequestExample,ResponseExample,ResponseField,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,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`,_jsxs(_components.p,{children:[`Use this endpoint to create a payout to fund account type `,_jsx(_components.code,{children:`vpa`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`To understand the status of the payouts, refer to `,_jsx(_components.a,{href:`/errors/x/payout-status-details`,children:`Payout Status Details`}),`.`]}),`\n`,_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Watch Out!`})}),_jsxs(_components.p,{children:[`Ensure you `,_jsx(_components.a,{href:`/x/dashboard/allowlist-ip`,children:`allowlist IPs`}),` and pass the `,_jsx(_components.a,{href:`/us/api/x/payout-idempotency/make-request`,children:`idempotency key`}),` to make a successful payout.`]})]}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`Curl`,numberOfLines:`19`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`19`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -u`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` \u003c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`YOUR_KE`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`Y`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`YOUR_SECRE`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`T`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-X `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.razorpay.com/v1/payouts`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"X-Payout-Idempotency: 53cda91c-8f81-4e77-bbb9-7388f4ac6bf4\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-d `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"account_number\": \"7878780080316316\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"fund_account_id\": \"fa_00000000000001\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"amount\": 1000000,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"currency\": \"INR\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"mode\": \"UPI\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"purpose\": \"refund\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"queue_if_low_balance\": true,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"reference_id\": \"Acme Transaction ID 12345\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"narration\": \"Acme Corp Fund Transfer\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"notes\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"notes_key_1\":\"Tea, Earl Grey, Hot\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"notes_key_2\":\"Tea, Earl Grey… decaf.\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`}'`})}),`\n`]})})})}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`Success`,numberOfLines:`26`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`26`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pout_00000000000001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"entity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"payout\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"fund_account_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"fa_00000000000001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1000000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"INR\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"notes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"notes_key_1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Tea, Earl Grey, Hot\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"notes_key_2\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Tea, Earl Grey… decaf.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"fees\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"tax\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"queued\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"utr\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"UPI\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"purpose\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"refund\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reference_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Acme Transaction ID 12345\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"narration\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Acme Corp Fund Transfer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"batch_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status_details\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Payout is queued as there is insufficient balance in your business account to process the payout\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"business\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"reason\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"low_balance\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 1545383037`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsx(Heading,{level:`2`,id:`request-parameters`,children:`Request Parameters`}),`\n`,_jsxs(ParamField,{body:`account_number`,type:`string`,required:true,id:`param-account-number`,children:[_jsxs(_components.p,{children:[`The account from which you want to make the payout. For example, `,_jsx(_components.code,{children:`7878780080316316`}),`.`]}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Pass your customer identifier if you want money to be deducted from RazorpayX Lite.`}),`\n`,_jsx(_components.li,{children:`Pass your Current Account number if you want money to be deducted from your Current Account.`}),`\n`]}),_jsxs(Warning,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Watch Out!`})}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`This is `,_jsx(_components.strong,{children:`not`}),` your contact’s bank account number. Log in to your `,_jsx(_components.a,{href:`https://x.razorpay.com/auth/?intent=current_account`,children:_jsx(_components.strong,{children:`RazorpayX Dashboard`})}),` and go to `,_jsx(_components.strong,{children:`My Account \u0026 Settings → Banking → Customer Identifier`}),`.`]}),`\n`,_jsx(_components.li,{children:`This value is different for Test Mode and Live Mode.`}),`\n`,_jsxs(_components.li,{children:[`RazorpayX Lite is currently not available for new merchants. To set up a new RazorpayX account, refer to `,_jsx(_components.a,{href:`/x/account-types/current-account`,children:`Current Account`}),`.`]}),`\n`]})]})]}),`\n`,_jsx(ParamField,{body:`fund_account_id`,type:`string`,required:true,id:`param-fund-account-id`,children:_jsxs(_components.p,{children:[`The unique identifier linked to a fund account. For example, `,_jsx(_components.code,{children:`fa_00000000000001`}),`.`]})}),`\n`,_jsx(ParamField,{body:`amount`,type:`integer`,required:true,id:`param-amount`,children:_jsxs(_components.p,{children:[`The payout amount, in paise. For example, pass `,_jsx(_components.code,{children:`1000000`}),` to transfer an amount of ₹10,000. Minimum value `,_jsx(_components.code,{children:`100`}),`. `,_jsx(`br`,{}),` The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.`]})}),`\n`,_jsx(ParamField,{body:`currency`,type:`string`,required:true,id:`param-currency`,children:_jsxs(_components.p,{children:[`The payout currency. Here, it is `,_jsx(_components.code,{children:`INR`}),`.`]})}),`\n`,_jsx(ParamField,{body:`mode`,type:`string`,required:true,id:`param-mode`,children:_jsxs(_components.p,{children:[`The mode to be used to create the payout. Available mode is `,_jsx(_components.code,{children:`UPI`}),`. Ensure you enter the payout modes in upper case as the payout modes are case-sensitive.`]})}),`\n`,_jsxs(ParamField,{body:`purpose`,type:`string`,required:true,id:`param-purpose`,children:[_jsx(_components.p,{children:`The purpose of the payout that is being created. The following classifications are available in the system by default:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`refund`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`cashback`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`payout`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salary`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`utility bill`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`vendor bill`}),` `,_jsx(`br`,{})]}),`\n`]}),_jsxs(_components.p,{children:[`Additional purposes for payouts can be created via the `,_jsx(_components.a,{href:`https://x.razorpay.com/`,children:`Dashboard`}),` and then used in the API. However, it is not possible to create a new purpose for the payout via the API.`]})]}),`\n`,_jsxs(ParamField,{body:`queue_if_low_balance`,type:`boolean`,id:`param-queue-if-low-balance`,children:[_jsx(_components.p,{children:`Possible values:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`true`}),`: The payout is queued when your business account does not have sufficient balance to process the payout.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`false`}),` (default): The payout is never queued. The payout fails if your business account does not have sufficient balance to process the payout.`]}),`\n`]})]}),`\n`,_jsx(ParamField,{body:`reference_id`,type:`string`,id:`param-reference-id`,children:_jsxs(_components.p,{children:[`A user-generated reference given to the payout. Maximum length is 40 characters. For example, `,_jsx(_components.code,{children:`Acme Transaction ID 12345`}),`. You can use this field to store your own transaction ID, if any.`]})}),`\n`,_jsx(ParamField,{body:`narration`,type:`string`,id:`param-narration`,children:_jsxs(_components.p,{children:[`Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space. This is a custom note that also appears on the bank statement. If no value is passed for this parameter, it defaults to the Merchant Billing Label. `,_jsx(`br`,{}),` `,_jsx(`br`,{}),` Enter the important text in the first 9 characters as banks truncate the rest as per their standards.`]})}),`\n`,_jsx(ParamField,{body:`notes`,type:`array of objects`,id:`param-notes`,children:_jsxs(_components.p,{children:[`Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, `,_jsx(_components.code,{children:`\"note_key\": \"Beam me up Scotty”`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response-parameters`,children:`Response Parameters`}),`\n`,_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:_jsxs(_components.p,{children:[`The unique identifier of the payout. For example, `,_jsx(_components.code,{children:`pout_00000000000001`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`entity`,type:`string`,id:`param-entity`,children:_jsxs(_components.p,{children:[`The entity being created. Here, it will be `,_jsx(_components.code,{children:`payout`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`fund_account_id`,type:`string`,id:`param-fund-account-id-1`,children:_jsxs(_components.p,{children:[`The unique identifier linked to the fund account. For example, `,_jsx(_components.code,{children:`fa_00000000000001`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`amount`,type:`integer`,id:`param-amount-1`,children:_jsxs(_components.p,{children:[`The payout amount, in paise. For example, if you want to transfer ₹10,000, pass `,_jsx(_components.code,{children:`1000000`}),`. Minimum value `,_jsx(_components.code,{children:`100`}),`. `,_jsx(`br`,{}),`The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.`]})}),`\n`,_jsx(ResponseField,{name:`currency`,type:`string`,id:`param-currency-1`,children:_jsxs(_components.p,{children:[`The payout’s currency. Here, it is `,_jsx(_components.code,{children:`INR`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`notes`,type:`array of objects`,id:`param-notes-1`,children:_jsxs(_components.p,{children:[`Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, `,_jsx(_components.code,{children:`\"note_key\": \"Beam me up Scotty”`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`fees`,type:`integer`,id:`param-fees`,children:_jsxs(_components.p,{children:[`The fees for the payout. This value is returned only when the payout moves to the `,_jsx(_components.code,{children:`processing`}),` state. For example, `,_jsx(_components.code,{children:`5`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`tax`,type:`integer`,id:`param-tax`,children:_jsxs(_components.p,{children:[`The tax that is applicable for the fee being charged. This value is returned only when the payout moves to the `,_jsx(_components.code,{children:`processing`}),` state. For example, `,_jsx(_components.code,{children:`1`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`status`,type:`string`,id:`param-status`,children:[_jsx(_components.p,{children:`The status of the payout. Possible payout states:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`queued`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`pending`}),` (if you have `,_jsx(_components.a,{href:`/x/manage-teams/approval-workflow`,children:`Approval Workflow`}),` enabled)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`rejected`}),` (if you have `,_jsx(_components.a,{href:`/x/manage-teams/approval-workflow`,children:`Approval Workflow`}),` enabled)`]}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`processing`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`processed`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`cancelled`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`reversed`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`failed`})}),`\n`]}),_jsxs(_components.p,{children:[`Know more about `,_jsx(_components.a,{href:`/x/payouts/states-life-cycle`,children:`Payout States`}),` and `,_jsx(_components.a,{href:`/errors/x/payout-status-details`,children:`Payout Status Details`}),`.`]})]}),`\n`,_jsx(ResponseField,{name:`utr`,type:`string`,id:`param-utr`,children:_jsxs(_components.p,{children:[`The unique transaction number linked to a payout. For example, `,_jsx(_components.code,{children:`HDFCN00000000001`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`mode`,type:`string`,id:`param-mode-1`,children:[_jsx(_components.p,{children:`The mode used to make the payout. Available modes:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`NEFT`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`RTGS`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`IMPS`}),` `,_jsx(`br`,{})]}),`\n`]}),_jsx(_components.p,{children:`The payout modes are case-sensitive.`})]}),`\n`,_jsxs(ResponseField,{name:`purpose`,type:`string`,id:`param-purpose-1`,children:[_jsx(_components.p,{children:`The purpose of the payout that is being created. The following classifications are available in the system by default:`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`refund`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`cashback`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`payout`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`salary`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`utility bill`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`vendor bill`}),` `,_jsx(`br`,{})]}),`\n`]}),_jsxs(_components.p,{children:[`Additional purposes for payouts can be created via the `,_jsx(_components.a,{href:`https://x.razorpay.com/`,children:`Dashboard`}),` and then used in the API. However, it is not possible to create a new purpose for the payout via the API.`]})]}),`\n`,_jsx(ResponseField,{name:`reference_id`,type:`string`,id:`param-reference-id-1`,children:_jsxs(_components.p,{children:[`Maximum length is 40 characters. A user-generated reference given to the payout. For example, `,_jsx(_components.code,{children:`Acme Transaction ID 12345`}),`. You can use this field to store your own transaction ID, if any.`]})}),`\n`,_jsx(ResponseField,{name:`debit_account_number`,type:`string`,id:`param-debit-account-number`,children:_jsxs(_components.p,{children:[`The account from which the payout was processed. For example, `,_jsx(_components.code,{children:`002281300012871`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`narration`,type:`string`,id:`param-narration-1`,children:_jsxs(_components.p,{children:[`Custom note that also appears on the bank statement. Maximum length 30 characters. Allowed characters: `,_jsx(_components.code,{children:`a-z`}),`, `,_jsx(_components.code,{children:`A-Z`}),`, `,_jsx(_components.code,{children:`0-9`}),` and space. `,_jsx(`br`,{}),` `,_jsx(`br`,{}),` If no value is passed for this parameter, it defaults to the Merchant Billing Label. Ensure that the most important text forms the first 9 characters as banks may truncate the rest as per their standards.`]})}),`\n`,_jsx(ResponseField,{name:`batch_id`,type:`string`,id:`param-batch-id`,children:_jsxs(_components.p,{children:[`This value is returned if the contact was created as part of a bulk upload. For example, `,_jsx(_components.code,{children:`batch_00000000000001`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`status_details`,type:`object`,id:`param-status-details`,children:_jsxs(_components.p,{children:[`This parameter returns the current status of the payout. For example, `,_jsx(_components.code,{children:`IMPS is not enabled on beneficiary account, Retry with different mode.`})]})}),`\n`,_jsx(ResponseField,{name:`description`,type:`string`,id:`param-description`,children:_jsxs(_components.p,{children:[`A description for the error. For example, `,_jsx(_components.code,{children:`IMPS is not enabled on beneficiary account, please retry with different mode`}),`.`]})}),`\n`,_jsxs(ResponseField,{name:`source`,type:`string`,id:`param-source`,children:[_jsx(_components.p,{children:`Possible values:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`gateway`}),`: Technical error at Razorpay Partner bank.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`beneficiary_bank`}),`: Technical error at beneficiary bank.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`business`}),`: Merchant action required.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`internal`}),`: Technical error at Razorpay’s server.`]}),`\n`]})]}),`\n`,_jsx(ResponseField,{name:`reason`,type:`string`,id:`param-reason`,children:_jsxs(_components.p,{children:[`The error reason. For example, `,_jsx(_components.code,{children:`imps_not_allowed`}),`. Know more about `,_jsx(_components.a,{href:`/errors/x/payout-status-details`,children:`Payout Status Details and Next Steps`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`created_at`,type:`integer`,id:`param-created-at`,children:_jsx(_components.p,{children:`Indicates the Unix timestamp when this payout was created.`})}),`\n`,_jsx(ResponseField,{name:`fee_type`,type:`string`,id:`param-fee-type`,children:_jsxs(_components.p,{children:[`Indicates the fee type charged for the payout. Possible values is `,_jsx(_components.code,{children:`free_payout`}),`.`]})})]})}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":"Create a Payout to a VPA","description":"Create a Payout to a VPA using API.","api":"POST /v1/payouts","href":"/us/api/x/payouts/create/vpa"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Request Parameters","slug":"request-parameters","depth":2,"children":[]},{"title":"Response Parameters","slug":"response-parameters","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"Curl","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"19\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> -u\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\"> \u0026#x3C;\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">YOUR_KE\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">Y\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">>\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">:\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">\u0026#x3C;\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">YOUR_SECRE\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">T\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">>\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-X \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">POST\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> https://api.razorpay.com/v1/payouts\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-H \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Content-Type: application/json\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-H \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"X-Payout-Idempotency: 53cda91c-8f81-4e77-bbb9-7388f4ac6bf4\"\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">-d \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">'{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"account_number\": \"7878780080316316\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"fund_account_id\": \"fa_00000000000001\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"amount\": 1000000,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"currency\": \"INR\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"mode\": \"UPI\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"purpose\": \"refund\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"queue_if_low_balance\": true,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"reference_id\": \"Acme Transaction ID 12345\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"narration\": \"Acme Corp Fund Transfer\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"notes\": {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"notes_key_1\":\"Tea, Earl Grey, Hot\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"notes_key_2\":\"Tea, Earl Grey… decaf.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">}'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"Success","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"26\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"pout_00000000000001\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"entity\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"payout\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"fund_account_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"fa_00000000000001\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"amount\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1000000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"currency\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"INR\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"notes\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"notes_key_1\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Tea, Earl Grey, Hot\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"notes_key_2\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Tea, Earl Grey… decaf.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"fees\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"tax\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"queued\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"utr\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"mode\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"UPI\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"purpose\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"refund\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"reference_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Acme Transaction ID 12345\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"narration\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Acme Corp Fund Transfer\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"batch_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"status_details\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"description\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Payout is queued as there is insufficient balance in your business account to process the payout\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"source\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"business\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"reason\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"low_balance\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"created_at\"\u003c/span>\u003cspan style=\"color:#82071E;--shiki-light-font-style:italic;--shiki-dark:#F44747;--shiki-dark-font-style:inherit\">:\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\"> 1545383037\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Create a Payout to a VPA","path":"/v1/payouts","servers":[{"url":"https://api.razorpay.com"}],"method":"post","request":{"security":[{"title":"Basic Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"basic","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"account_number":[{"type":"string","description":"The account from which you want to make the payout. For example, `7878780080316316` . Pass your customer identifier if you want money to be deducted from RazorpayX Lite. Pass your Current Account number if you want money to be deducted from your Current Account.","required":true}],"fund_account_id":[{"type":"string","description":"The unique identifier linked to a fund account. For example, `fa_00000000000001` .","required":true}],"amount":[{"type":"integer","description":"The payout amount, in paise. For example, pass `1000000` to transfer an amount of ₹10,000. Minimum value `100` . The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance.","required":true}],"currency":[{"type":"string","description":"The payout currency. Here, it is `INR` .","required":true}],"mode":[{"type":"string","description":"The mode to be used to create the payout. Available mode is `UPI` . Ensure you enter the payout modes in upper case as the payout modes are case-sensitive.","required":true}],"purpose":[{"type":"string","description":"The purpose of the payout that is being created. The following classifications are available in the system by default: `refund` `cashback` `payout` `salary` `utility bill` `vendor bill` Additional purposes for payouts can be created via the Dashboard and then used in the API. However, it is not possible to create a new purpose for the payout via the API.","required":true}],"queue_if_low_balance":[{"type":"boolean","description":"Possible values: `true` : The payout is queued when your business account does not have sufficient balance to process the payout. `false` (default): The payout is never queued. The payout fails if your business account does not have sufficient balance to process the payout."}],"reference_id":[{"type":"string","description":"A user-generated reference given to the payout. Maximum length is 40 characters. For example, `Acme Transaction ID 12345` . You can use this field to store your own transaction ID, if any."}],"narration":[{"type":"string","description":"Maximum length 30 characters. Allowed characters: a-z, A-Z, 0-9 and space. This is a custom note that also appears on the bank statement. If no value is passed for this parameter, it defaults to the Merchant Billing Label. Enter the important text in the first 9 characters as banks truncate the rest as per their standards."}],"notes":[{"type":"object","properties":{},"description":"Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, `\"note_key\": \"Beam me up Scotty”` ."}]}}],"examples":{"example":{"value":{"account_number":"\u003cstring>","fund_account_id":"\u003cstring>","amount":123,"currency":"\u003cstring>","mode":"\u003cstring>","purpose":"\u003cstring>","queue_if_low_balance":true,"reference_id":"\u003cstring>","narration":"\u003cstring>","notes":{}}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"id":[{"type":"string","description":"The unique identifier of the payout. For example, `pout_00000000000001` ."}],"entity":[{"type":"string","description":"The entity being created. Here, it will be `payout` ."}],"fund_account_id":[{"type":"string","description":"The unique identifier linked to the fund account. For example, `fa_00000000000001` ."}],"amount":[{"type":"integer","description":"The payout amount, in paise. For example, if you want to transfer ₹10,000, pass `1000000` . Minimum value `100` . The value passed here does not include fees and tax. Fees and tax, if any, are deducted from your account balance."}],"currency":[{"type":"string","description":"The payout’s currency. Here, it is `INR` ."}],"notes":[{"type":"object","properties":{},"description":"Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, `\"note_key\": \"Beam me up Scotty”` ."}],"fees":[{"type":"integer","description":"The fees for the payout. This value is returned only when the payout moves to the `processing` state. For example, `5` ."}],"tax":[{"type":"integer","description":"The tax that is applicable for the fee being charged. This value is returned only when the payout moves to the `processing` state. For example, `1` ."}],"status":[{"type":"string","description":"The status of the payout. Possible payout states: `queued` `pending` (if you have Approval Workflow enabled) `rejected` (if you have Approval Workflow enabled) `processing` `processed` `cancelled` `reversed` `failed` Know more about Payout States and Payout Status Details ."}],"utr":[{"type":"string","description":"The unique transaction number linked to a payout. For example, `HDFCN00000000001` ."}],"mode":[{"type":"string","description":"The mode used to make the payout. Available modes: `NEFT` `RTGS` `IMPS` The payout modes are case-sensitive."}],"purpose":[{"type":"string","description":"The purpose of the payout that is being created. The following classifications are available in the system by default: `refund` `cashback` `payout` `salary` `utility bill` `vendor bill` Additional purposes for payouts can be created via the Dashboard and then used in the API. However, it is not possible to create a new purpose for the payout via the API."}],"reference_id":[{"type":"string","description":"Maximum length is 40 characters. A user-generated reference given to the payout. For example, `Acme Transaction ID 12345` . You can use this field to store your own transaction ID, if any."}],"debit_account_number":[{"type":"string","description":"The account from which the payout was processed. For example, `002281300012871` ."}],"narration":[{"type":"string","description":"Custom note that also appears on the bank statement. Maximum length 30 characters. Allowed characters: `a-z` , `A-Z` , `0-9` and space. If no value is passed for this parameter, it defaults to the Merchant Billing Label. Ensure that the most important text forms the first 9 characters as banks may truncate the rest as per their standards."}],"batch_id":[{"type":"string","description":"This value is returned if the contact was created as part of a bulk upload. For example, `batch_00000000000001` ."}],"status_details":[{"type":"object","properties":{},"description":"This parameter returns the current status of the payout. For example, `IMPS is not enabled on beneficiary account, Retry with different mode.`"}],"description":[{"type":"string","description":"A description for the error. For example, `IMPS is not enabled on beneficiary account, please retry with different mode` ."}],"source":[{"type":"string","description":"Possible values: `gateway` : Technical error at Razorpay Partner bank. `beneficiary_bank` : Technical error at beneficiary bank. `business` : Merchant action required. `internal` : Technical error at Razorpay’s server."}],"reason":[{"type":"string","description":"The error reason. For example, `imps_not_allowed` . Know more about Payout Status Details and Next Steps ."}],"created_at":[{"type":"integer","description":"Indicates the Unix timestamp when this payout was created."}],"fee_type":[{"type":"string","description":"Indicates the fee type charged for the payout. Possible values is `free_payout` ."}]}}],"examples":{"example":{"value":{"id":"\u003cstring>","entity":"\u003cstring>","fund_account_id":"\u003cstring>","amount":123,"currency":"\u003cstring>","notes":{},"fees":123,"tax":123,"status":"\u003cstring>","utr":"\u003cstring>","mode":"\u003cstring>","purpose":"\u003cstring>","reference_id":"\u003cstring>","debit_account_number":"\u003cstring>","narration":"\u003cstring>","batch_id":"\u003cstring>","status_details":{},"description":"\u003cstring>","source":"\u003cstring>","reason":"\u003cstring>","created_at":123,"fee_type":"\u003cstring>"}}}}}},"deprecated":false}},"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":"Create a Payout to a VPA - Razorpay","navMaps":{"firstHrefInVersion":{"India":{"href":"/api/x/payouts/create/vpa","matchLevel":1},"Singapore":{"href":"/sg/home","matchLevel":4},"United States":{"href":"/us/api/x/payouts/create/vpa","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-08T16:37:49.163Z","gitLastModified":"2026-10-08T16:35:44.000Z","originalFileLocation":"us/api/x/payouts/create/vpa.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=\"Create a Payout to a VPA using API.\">\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=\"Create a Payout to a VPA - Razorpay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a Payout to a VPA using API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Razorpay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://razorpay.com/docs/us/api/x/payouts/create/vpa\">\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=Create+and+Manage+Payouts\u0026amp;title=Create+a+Payout+to+a+VPA\u0026amp;description=Create+a+Payout+to+a+VPA+using+API.\u0026amp;theme=a4f414a96152b37051aa45a2\u0026amp;signature=ac787cc29e4c79e7c027b7d9200222b71c3e46419a75cba77dc81b17add914d5\">\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=\"Create a Payout to a VPA - Razorpay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a Payout to a VPA using API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://razorpay-881012b3.mintlify.site/docs/_mintlify/api/og/v2?division=Create+and+Manage+Payouts\u0026amp;title=Create+a+Payout+to+a+VPA\u0026amp;description=Create+a+Payout+to+a+VPA+using+API.\u0026amp;theme=a4f414a96152b37051aa45a2\u0026amp;signature=ac787cc29e4c79e7c027b7d9200222b71c3e46419a75cba77dc81b17add914d5\">\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/x/payouts/create/vpa\">\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/x/payouts/create/vpa.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/x/payouts/create/vpa#webpage\",\"url\":\"https://razorpay.com/docs/us/api/x/payouts/create/vpa\",\"name\":\"Create a Payout to a VPA\",\"description\":\"Create a Payout to a VPA using API.\",\"dateModified\":\"2026-10-08T16:35:44.000Z\",\"isPartOf\":{\"@id\":\"https://razorpay.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://razorpay.com/docs/us/api/x/payouts/create/vpa#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://razorpay.com/docs/us/api/x/payouts/create/vpa#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payouts\",\"item\":\"https://razorpay.com/docs/us/api/x\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create and Manage Payouts\",\"item\":\"https://razorpay.com/docs/us/api/x/payouts/entity\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a Payout to a VPA\",\"item\":\"https://razorpay.com/docs/us/api/x/payouts/create/vpa\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://razorpay.com/docs/us/api/x/payouts/create/vpa#apireference\",\"headline\":\"Create a Payout to a VPA\",\"name\":\"Create a Payout to a VPA\",\"description\":\"Create a Payout to a VPA using API.\",\"url\":\"https://razorpay.com/docs/us/api/x/payouts/create/vpa\",\"mainEntityOfPage\":{\"@id\":\"https://razorpay.com/docs/us/api/x/payouts/create/vpa#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/x/payouts/create/vpa.md","siteName":"Razorpay","nav":{"global":null,"versions":[{"version":"India","default":true,"pages":[{"title":"India","href":"/api/x/payouts/create/vpa"}]},{"version":"Singapore","pages":[{"title":"Singapore","href":"/sg/home"}]},{"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","href":"/us/api/understand"},{"title":"API Authentication","sidebarTitle":"Authentication","href":"/us/api/authentication"},{"title":"API Sandbox Setup","sidebarTitle":"Sandbox Setup","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","description":"Create a Payout to a Bank Account using APIs.","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","description":"Fetch All Payouts using API.","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":"Create a Payout to a VPA - Razorpay","buildId":"dpl_6PxPD4Fj1JDU9BJxEHvfdUmxKThw","deploymentId":"dpl_6PxPD4Fj1JDU9BJxEHvfdUmxKThw","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CASS2Vpq.js","utils-4k9fyWRu.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-UU-UueZb.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BgJ0LOYq.js","snippetPresets-CMgzlMR-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BzEJegkK.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CZuQIZdk.js","shallow-Bw5arfMA.js","getApiPlaygroundDisplay-Ds834aVN.js","CodeSnippet-CKzmjw9L.js","CodeSnippets-BRpgomdp.js","Page-DvEUoD2H.js","getPastedJson-B0N-Tn76.js","icon-DASMs9nC.js","MethodPill-BA6DBLqx.js","DuplicateIcon-BMT5qfbJ.js","createIcon-CNfwVWPx.js","DynamicMarkdown-JYyBNlrJ.js","SectionHeading-BbZnmz8a.js","axios-vUo_bRtp.js"]}