Use this API to retrieve the current consent status for a user and determine whether you may request protected financial or personal information for verification.
It displays the type of information you require from the individual.
Possible values are
- PROFILE: It contains the basic information of the individual.
- SUMMARY: It contains the summary of the financial information of the individual.
- TRANSACTIONS: It contains the transactional information of the individual.
It contains the filter options to sort the finanical information of the individual.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cashfree Developer Documentation","colors":{"primary":"#6930ca","light":"#cfb8f5","dark":"#130851"},"logo":{"light":"https://mintcdn.com/cashfreepayments-d00050e9/6mQw7is1us8FhXrb/static/logo/light.svg?fit=max\u0026auto=format\u0026n=6mQw7is1us8FhXrb\u0026q=85\u0026s=8a2837083063d8a01e0be6b454a1baf1","dark":"https://mintcdn.com/cashfreepayments-d00050e9/6mQw7is1us8FhXrb/static/logo/dark.svg?fit=max\u0026auto=format\u0026n=6mQw7is1us8FhXrb\u0026q=85\u0026s=5c7de40784c6f6f9eebdad085ec5a7ef"},"favicon":"https://mintcdn.com/cashfreepayments-d00050e9/NpjCgm3mwC7v6gp-/static/favicon.png?fit=max\u0026auto=format\u0026n=NpjCgm3mwC7v6gp-\u0026q=85\u0026s=ba85dcd024bd70845e38c3f3957514c6","appearance":{"default":"light","strict":false},"background":{"color":{"light":"#fbfbfb","dark":"#000000"}},"navbar":{"links":[{"href":"https://www.cashfree.com/support/","label":"Contact Us"}],"primary":{"type":"button","label":"Get Started","href":"https://merchant.cashfree.com/merchants/signup?source-action=docs%20page\u0026action=Sign%20Up\u0026button-id=StartNow_Navbar"}},"footer":{"socials":{"github":"https://github.com/cashfree","youtube":"https://www.youtube.com/channel/UCxO0W7xVngh7TfkChPa_nwg","website":"https://www.cashfree.com/blog/category/engineering","discord":"https://discord.com/invite/w97HT9RKCF"}},"search":{"prompt":"Search or ask..."},"seo":{"metatags":{"og:title":"Cashfree Developer Documentation","og:description":"Welcome to the Cashfree developer documentation. You will find help about Cashfree products and APIs that will help you start using our products quickly.","og:site_name":"Cashfree Developer Documentation","twitter:site":"@gocashfree","google-site-verification":"T69Ao_T0Ps8pkRbluKzW179qvd_aCsWISCApeSsIhRU"},"indexing":"all"},"fonts":{"heading":{"family":"Inter","weight":600},"body":{"family":"Inter","weight":400}},"styling":{"codeblocks":"dark","latex":true},"integrations":{"ga4":{"measurementId":"G-56SCQ867FW"},"gtm":{"tagId":"GTM-5SRVH4P"}},"contextual":{"options":["chatgpt","claude","copy","view",{"title":"Open in Discord","description":"Join our Discord community","icon":"discord","href":"https://discord.com/invite/w97HT9RKCF"}],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cashfreepayments-d00050e9","hasAudioNarration":false,"actualSubdomain":"cashfreepayments-d00050e9","customDomains":["www.cashfree.com"],"gitSource":{"type":"github","owner":"cashfree","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae49f2dbfaae13da36b452f","collectionId":"849e9bcc-f7f0-46ac-84be-219ff7da0505","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae49f2dbfaae13da36b452f"},"feedback":{"thumbs":true,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae49f2dbfaae13da36b452f","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Payments APIs","count":520},{"language":"default","tag":"Other Versions","count":349},{"language":"default","tag":"Payments","count":305},{"language":"default","tag":"v2026-01-01","count":159},{"language":"default","tag":"Subscription","count":151},{"language":"default","tag":"v2025-01-01","count":150},{"language":"default","tag":"v2023-08-01","count":142},{"language":"default","tag":"Payment Gateway","count":136},{"language":"default","tag":"Secure ID","count":106},{"language":"default","tag":"Payouts","count":105}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":false,"email":"documentation@cashfree.com","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6916d346c181a220cfa37e8d","deploymentId":"66d5827f2de686bc28e7722b","questionText":"How do I accept payments online?","status":"active","generatedBy":"manual","createdAt":"2025-11-14T06:59:18.295Z","updatedAt":"2025-11-14T06:59:18.295Z","__v":0},{"_id":"6916d306c181a220cfa370e8","deploymentId":"66d5827f2de686bc28e7722b","questionText":"What is Cashfree Hosted Checkout?","status":"active","generatedBy":"manual","createdAt":"2025-11-14T06:58:14.574Z","updatedAt":"2025-11-14T06:58:14.574Z","__v":0},{"_id":"6916d2dbc181a220cfa368a4","deploymentId":"66d5827f2de686bc28e7722b","questionText":"How do I create a payment link?","status":"active","generatedBy":"manual","createdAt":"2025-11-14T06:57:31.657Z","updatedAt":"2025-11-14T06:57:31.657Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/docs/_mintlify/custom/cashfreepayments-d00050e9/e1e3b3ccb8bef592/style.css"},{"filePath":"grid.css","content":".container,.container-fluid{margin-right:auto;margin-left:auto}.container{padding-top:3rem;padding-bottom:3rem}.container-fluid{padding:3rem 2rem}.col-xs,.row{box-sizing:border-box}.row{display:-webkit-box;display:-ms-flexbox;display:flex;-webkit-box-flex:0;-ms-flex:0 1 auto;flex:0 1 auto;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-ms-flex-direction:row;flex-direction:row;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-right:-.5rem;margin-left:-.5rem}.col.reverse,.row.reverse{-webkit-box-orient:horizontal;-webkit-box-direction:reverse;-ms-flex-direction:row-reverse;flex-direction:row-reverse}.col.reverse{-webkit-box-orient:vertical;-ms-flex-direction:column-reverse;flex-direction:column-reverse}.col-xs{-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9,.col-xs-offset-0,.col-xs-offset-1,.col-xs-offset-10,.col-xs-offset-11,.col-xs-offset-12,.col-xs-offset-2,.col-xs-offset-3,.col-xs-offset-4,.col-xs-offset-5,.col-xs-offset-6,.col-xs-offset-7,.col-xs-offset-8,.col-xs-offset-9{box-sizing:border-box;-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-xs{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:0;flex-basis:0;max-width:100%}.col-xs-1{-ms-flex-preferred-size:8.33333333%;flex-basis:8.33333333%;max-width:8.33333333%}.col-xs-2{-ms-flex-preferred-size:16.66666667%;flex-basis:16.66666667%;max-width:16.66666667%}.col-xs-3{-ms-flex-preferred-size:25%;flex-basis:25%;max-width:25%}.col-xs-4{-ms-flex-preferred-size:33.33333333%;flex-basis:33.33333333%;max-width:33.33333333%}.col-xs-5{-ms-flex-preferred-size:41.66666667%;flex-basis:41.66666667%;max-width:41.66666667%}.col-xs-6{-ms-flex-preferred-size:50%;flex-basis:50%;max-width:50%}.col-xs-7{-ms-flex-preferred-size:58.33333333%;flex-basis:58.33333333%;max-width:58.33333333%}.col-xs-8{-ms-flex-preferred-size:66.66666667%;flex-basis:66.66666667%;max-width:66.66666667%}.col-xs-9{-ms-flex-preferred-size:75%;flex-basis:75%;max-width:75%}.col-xs-10{-ms-flex-preferred-size:83.33333333%;flex-basis:83.33333333%;max-width:83.33333333%}.col-xs-11{-ms-flex-preferred-size:91.66666667%;flex-basis:91.66666667%;max-width:91.66666667%}.col-xs-12{-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%}.col-xs-offset-0{margin-left:0}.col-xs-offset-1{margin-left:8.33333333%}.col-xs-offset-2{margin-left:16.66666667%}.col-xs-offset-3{margin-left:25%}.col-xs-offset-4{margin-left:33.33333333%}.col-xs-offset-5{margin-left:41.66666667%}.col-xs-offset-6{margin-left:50%}.col-xs-offset-7{margin-left:58.33333333%}.col-xs-offset-8{margin-left:66.66666667%}.col-xs-offset-9{margin-left:75%}.col-xs-offset-10{margin-left:83.33333333%}.col-xs-offset-11{margin-left:91.66666667%}.start-xs{-webkit-box-pack:start;-ms-flex-pack:start;justify-content:flex-start;text-align:start}.center-xs{-webkit-box-pack:center;-ms-flex-pack:center;justify-content:center;text-align:center}.end-xs{-webkit-box-pack:end;-ms-flex-pack:end;justify-content:flex-end;text-align:end}.top-xs{-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start}.middle-xs{-webkit-box-align:center;-ms-flex-align:center;align-items:center}.bottom-xs{-webkit-box-align:end;-ms-flex-align:end;align-items:flex-end}.around-xs{-ms-flex-pack:distribute;justify-content:space-around}.between-xs{-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.first-xs{-webkit-box-ordinal-group:0;-ms-flex-order:-1;order:-1}.last-xs{-webkit-box-ordinal-group:2;-ms-flex-order:1;order:1}@media only screen and (min-width:48em){.container{width:49rem}.col-sm{box-sizing:border-box;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-offset-0,.col-sm-offset-1,.col-sm-offset-10,.col-sm-offset-11,.col-sm-offset-12,.col-sm-offset-2,.col-sm-offset-3,.col-sm-offset-4,.col-sm-offset-5,.col-sm-offset-6,.col-sm-offset-7,.col-sm-offset-8,.col-sm-offset-9{box-sizing:border-box;-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-sm{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:0;flex-basis:0;max-width:100%}.col-sm-1{-ms-flex-preferred-size:8.33333333%;flex-basis:8.33333333%;max-width:8.33333333%}.col-sm-2{-ms-flex-preferred-size:16.66666667%;flex-basis:16.66666667%;max-width:16.66666667%}.col-sm-3{-ms-flex-preferred-size:25%;flex-basis:25%;max-width:25%}.col-sm-4{-ms-flex-preferred-size:33.33333333%;flex-basis:33.33333333%;max-width:33.33333333%}.col-sm-5{-ms-flex-preferred-size:41.66666667%;flex-basis:41.66666667%;max-width:41.66666667%}.col-sm-6{-ms-flex-preferred-size:50%;flex-basis:50%;max-width:50%}.col-sm-7{-ms-flex-preferred-size:58.33333333%;flex-basis:58.33333333%;max-width:58.33333333%}.col-sm-8{-ms-flex-preferred-size:66.66666667%;flex-basis:66.66666667%;max-width:66.66666667%}.col-sm-9{-ms-flex-preferred-size:75%;flex-basis:75%;max-width:75%}.col-sm-10{-ms-flex-preferred-size:83.33333333%;flex-basis:83.33333333%;max-width:83.33333333%}.col-sm-11{-ms-flex-preferred-size:91.66666667%;flex-basis:91.66666667%;max-width:91.66666667%}.col-sm-12{-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%}.col-sm-offset-0{margin-left:0}.col-sm-offset-1{margin-left:8.33333333%}.col-sm-offset-2{margin-left:16.66666667%}.col-sm-offset-3{margin-left:25%}.col-sm-offset-4{margin-left:33.33333333%}.col-sm-offset-5{margin-left:41.66666667%}.col-sm-offset-6{margin-left:50%}.col-sm-offset-7{margin-left:58.33333333%}.col-sm-offset-8{margin-left:66.66666667%}.col-sm-offset-9{margin-left:75%}.col-sm-offset-10{margin-left:83.33333333%}.col-sm-offset-11{margin-left:91.66666667%}.start-sm{-webkit-box-pack:start;-ms-flex-pack:start;justify-content:flex-start;text-align:start}.center-sm{-webkit-box-pack:center;-ms-flex-pack:center;justify-content:center;text-align:center}.end-sm{-webkit-box-pack:end;-ms-flex-pack:end;justify-content:flex-end;text-align:end}.top-sm{-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start}.middle-sm{-webkit-box-align:center;-ms-flex-align:center;align-items:center}.bottom-sm{-webkit-box-align:end;-ms-flex-align:end;align-items:flex-end}.around-sm{-ms-flex-pack:distribute;justify-content:space-around}.between-sm{-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.first-sm{-webkit-box-ordinal-group:0;-ms-flex-order:-1;order:-1}.last-sm{-webkit-box-ordinal-group:2;-ms-flex-order:1;order:1}}@media only screen and (min-width:64em){.container{width:65rem}.col-md{box-sizing:border-box;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-offset-0,.col-md-offset-1,.col-md-offset-10,.col-md-offset-11,.col-md-offset-12,.col-md-offset-2,.col-md-offset-3,.col-md-offset-4,.col-md-offset-5,.col-md-offset-6,.col-md-offset-7,.col-md-offset-8,.col-md-offset-9{box-sizing:border-box;-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-md{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:0;flex-basis:0;max-width:100%}.col-md-1{-ms-flex-preferred-size:8.33333333%;flex-basis:8.33333333%;max-width:8.33333333%}.col-md-2{-ms-flex-preferred-size:16.66666667%;flex-basis:16.66666667%;max-width:16.66666667%}.col-md-3{-ms-flex-preferred-size:25%;flex-basis:25%;max-width:25%}.col-md-4{-ms-flex-preferred-size:33.33333333%;flex-basis:33.33333333%;max-width:33.33333333%}.col-md-5{-ms-flex-preferred-size:41.66666667%;flex-basis:41.66666667%;max-width:41.66666667%}.col-md-6{-ms-flex-preferred-size:50%;flex-basis:50%;max-width:50%}.col-md-7{-ms-flex-preferred-size:58.33333333%;flex-basis:58.33333333%;max-width:58.33333333%}.col-md-8{-ms-flex-preferred-size:66.66666667%;flex-basis:66.66666667%;max-width:66.66666667%}.col-md-9{-ms-flex-preferred-size:75%;flex-basis:75%;max-width:75%}.col-md-10{-ms-flex-preferred-size:83.33333333%;flex-basis:83.33333333%;max-width:83.33333333%}.col-md-11{-ms-flex-preferred-size:91.66666667%;flex-basis:91.66666667%;max-width:91.66666667%}.col-md-12{-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%}.col-md-offset-0{margin-left:0}.col-md-offset-1{margin-left:8.33333333%}.col-md-offset-2{margin-left:16.66666667%}.col-md-offset-3{margin-left:25%}.col-md-offset-4{margin-left:33.33333333%}.col-md-offset-5{margin-left:41.66666667%}.col-md-offset-6{margin-left:50%}.col-md-offset-7{margin-left:58.33333333%}.col-md-offset-8{margin-left:66.66666667%}.col-md-offset-9{margin-left:75%}.col-md-offset-10{margin-left:83.33333333%}.col-md-offset-11{margin-left:91.66666667%}.start-md{-webkit-box-pack:start;-ms-flex-pack:start;justify-content:flex-start;text-align:start}.center-md{-webkit-box-pack:center;-ms-flex-pack:center;justify-content:center;text-align:center}.end-md{-webkit-box-pack:end;-ms-flex-pack:end;justify-content:flex-end;text-align:end}.top-md{-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start}.middle-md{-webkit-box-align:center;-ms-flex-align:center;align-items:center}.bottom-md{-webkit-box-align:end;-ms-flex-align:end;align-items:flex-end}.around-md{-ms-flex-pack:distribute;justify-content:space-around}.between-md{-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.first-md{-webkit-box-ordinal-group:0;-ms-flex-order:-1;order:-1}.last-md{-webkit-box-ordinal-group:2;-ms-flex-order:1;order:1}}@media only screen and (min-width:75em){.container{width:76rem}.col-lg{box-sizing:border-box;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-offset-0,.col-lg-offset-1,.col-lg-offset-10,.col-lg-offset-11,.col-lg-offset-12,.col-lg-offset-2,.col-lg-offset-3,.col-lg-offset-4,.col-lg-offset-5,.col-lg-offset-6,.col-lg-offset-7,.col-lg-offset-8,.col-lg-offset-9{box-sizing:border-box;-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-lg{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:0;flex-basis:0;max-width:100%}.col-lg-1{-ms-flex-preferred-size:8.33333333%;flex-basis:8.33333333%;max-width:8.33333333%}.col-lg-2{-ms-flex-preferred-size:16.66666667%;flex-basis:16.66666667%;max-width:16.66666667%}.col-lg-3{-ms-flex-preferred-size:25%;flex-basis:25%;max-width:25%}.col-lg-4{-ms-flex-preferred-size:33.33333333%;flex-basis:33.33333333%;max-width:33.33333333%}.col-lg-5{-ms-flex-preferred-size:41.66666667%;flex-basis:41.66666667%;max-width:41.66666667%}.col-lg-6{-ms-flex-preferred-size:50%;flex-basis:50%;max-width:50%}.col-lg-7{-ms-flex-preferred-size:58.33333333%;flex-basis:58.33333333%;max-width:58.33333333%}.col-lg-8{-ms-flex-preferred-size:66.66666667%;flex-basis:66.66666667%;max-width:66.66666667%}.col-lg-9{-ms-flex-preferred-size:75%;flex-basis:75%;max-width:75%}.col-lg-10{-ms-flex-preferred-size:83.33333333%;flex-basis:83.33333333%;max-width:83.33333333%}.col-lg-11{-ms-flex-preferred-size:91.66666667%;flex-basis:91.66666667%;max-width:91.66666667%}.col-lg-12{-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%}.col-lg-offset-0{margin-left:0}.col-lg-offset-1{margin-left:8.33333333%}.col-lg-offset-2{margin-left:16.66666667%}.col-lg-offset-3{margin-left:25%}.col-lg-offset-4{margin-left:33.33333333%}.col-lg-offset-5{margin-left:41.66666667%}.col-lg-offset-6{margin-left:50%}.col-lg-offset-7{margin-left:58.33333333%}.col-lg-offset-8{margin-left:66.66666667%}.col-lg-offset-9{margin-left:75%}.col-lg-offset-10{margin-left:83.33333333%}.col-lg-offset-11{margin-left:91.66666667%}.start-lg{-webkit-box-pack:start;-ms-flex-pack:start;justify-content:flex-start;text-align:start}.center-lg{-webkit-box-pack:center;-ms-flex-pack:center;justify-content:center;text-align:center}.end-lg{-webkit-box-pack:end;-ms-flex-pack:end;justify-content:flex-end;text-align:end}.top-lg{-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start}.middle-lg{-webkit-box-align:center;-ms-flex-align:center;align-items:center}.bottom-lg{-webkit-box-align:end;-ms-flex-align:end;align-items:flex-end}.around-lg{-ms-flex-pack:distribute;justify-content:space-around}.between-lg{-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.first-lg{-webkit-box-ordinal-group:0;-ms-flex-order:-1;order:-1}.last-lg{-webkit-box-ordinal-group:2;-ms-flex-order:1;order:1}}"},{"filePath":"typography.css","content":".landing-page h1{font-size:2.4rem}.landing-page h2{font-size:2rem}.landing-page h3{font-size:1.6rem}.landing-page h4{font-size:1.2rem}.landing-page h5{font-size:1rem}.landing-page h6{font-size:.8rem}.bold{font-weight:700}.semibold{font-weight:600}.medium{font-weight:500}.regular{font-weight:400}.light{font-weight:300}"}],"page":{"pagePath":"api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status","slug":"/api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status","pageMetadata":{"openapi":"get /aa/consent","og:title":"AA Consent Status | Cashfree","og:description":"Check the live status of a Cashfree Account Aggregator consent request to confirm whether the customer has approved, paused, or revoked financial data sharing.","noindex":true,"hidden":true,"keywords":["account aggregator","consent management","financial data","API reference","REST API"],"title":"Get Consent Status","description":"Use this API to retrieve the current consent status for a user and determine whether you may request protected financial or personal information for verification.","href":"/api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status","hiddenSetByFrontmatter":true},"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: \"Use this API to retrieve the current consent status for a user and determine whether you may request protected financial or personal information for verification.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"openapi":"get /aa/consent","og:title":"AA Consent Status | Cashfree","og:description":"Check the live status of a Cashfree Account Aggregator consent request to confirm whether the customer has approved, paused, or revoked financial data sharing.","noindex":true,"hidden":true,"keywords":["account aggregator","consent management","financial data","API reference","REST API"],"title":"Get Consent Status","description":"Use this API to retrieve the current consent status for a user and determine whether you may request protected financial or personal information for verification.","href":"/api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status","hiddenSetByFrontmatter":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/cashfreepayments-d00050e9/0a1efd0b138512b4/util/downloadImages.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/7b49b0aba32ccd66/util/checkLinks.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/6520965c686ab08e/util/updateFrontmatter.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/e6313895ea4c2bf0/export-docs/export.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/6459e4b38b43a234/export-docs/sync-kb.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/82d5b75dd1e333d2/snippets/postman-buttons/postman-links.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/e8f71dc9fab8d95d/scripts/ga4-video-tracking.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/e3b0c44298fc1c14/scripts/generate-postman-buttons.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/bc4eac15553663a2/scripts/openapi-rm-desc.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/5748000362acad1e/scripts/quote-openapi.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/0a7365ce97b5cca7/scripts/script.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/d99a96c0c4b010fe/scripts/updateHelpAccordionsWithPostHog.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/bd8561d01634fd2e/scripts/updateIframeSrc.js"],"openApiReferenceData":{"operation":{"tags":["Account Aggregator"],"description":"Use this API to retrieve the current consent status for a user and determine whether you may request protected financial or personal information for verification.","summary":"Get Consent Status","operationId":"VrsAaGetConsentStatus","security":["ede4cf51-f7b8-40d1-b852-86cc70402aea"],"parameters":["2e09490c-1938-4484-b6dd-0831e2c06633","c3dc5e37-3551-4c3f-83da-74573f1495e9"],"responses":{"200":"8eb2cc9b-931a-4234-8d19-8449c2c98b3d","400":"498c4662-68ed-4744-a2da-8ce332928ab5","401":"7a27d32c-36a5-4eaf-a223-67b13d25938b","403":"d882e43a-911d-44b7-815e-422564c35f78","422":"e578bff2-d662-4693-b614-0746ec43c4fe","429":"64301055-0e7a-4f6a-87e9-519816558dfe","500":"1d7fcc08-a80b-4db0-963f-16789ca4585a"},"method":"get","type":"path","servers":["46c81061-81d2-4a48-9b1f-8ccc3114ac86","6f583a9b-e5f2-4bdd-912a-790bafb666e1"],"path":"/aa/consent","baseUrlOptions":["https://sandbox.cashfree.com/verification","https://api.cashfree.com/verification"],"title":"Get Consent Status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2e09490c-1938-4484-b6dd-0831e2c06633":{"name":"consent_ref_id","description":"It is the unique ID created by Cashfree that you receive in the response of Consent Request API.","in":"query","required":false,"schema":{"type":"string","default":"1358","isRequired":false,"description":"It is the unique ID created by Cashfree that you receive in the response of Consent Request API.","uniqueKey":"","typeLabel":"string"}},"c3dc5e37-3551-4c3f-83da-74573f1495e9":{"name":"consent_verification_id","description":"It is the unique ID you created to identify the verification request.","in":"query","required":false,"schema":{"type":"string","default":"ABC00123","isRequired":false,"description":"It is the unique ID you created to identify the verification request.","uniqueKey":"","typeLabel":"string"}}},"responses":{"8eb2cc9b-931a-4234-8d19-8449c2c98b3d":{"description":"Consent created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"consent_verification_id":{"type":"string","example":"","description":"It displays the unique ID you created to identify the consent request.","uniqueKey":"consent_verification_id","typeLabel":"string"},"consent_ref_id":{"type":"number","example":10,"description":"It displays the unique ID created by Cashfree for reference purpose.","uniqueKey":"consent_ref_id","typeLabel":"number"},"consent_redirect_url":{"type":"string","example":"string","description":"It displays the URL that redirects the individual to the consent request page.","uniqueKey":"consent_redirect_url","typeLabel":"string"},"status":{"type":"string","example":"SUCCESS","description":"It displays the status of the consent request.\n Possible values are\n\n - `PENDING`\n - `PROCESSING`\n - `SUCCESS`\n - `PAUSED`\n - `EXPIRED`\n - `REVOKED`\n - `REJECTED`","uniqueKey":"status","typeLabel":"string"},"customer_identifiers":{"type":"array","description":"It should contain the information related to the individual.","items":{"type":"object","properties":{"type":{"type":"string","example":"MOBILE","description":"It is the unique piece of information to recognize and distinguish the individual.\nPossible values are\n- `MOBILE`","uniqueKey":"customer_identifiers.items.[INDEX].type","typeLabel":"string"},"value":{"type":"string","example":"","description":"It is the mobile number of the individual.","uniqueKey":"customer_identifiers.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"customer_identifiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_identifiers","typeLabel":"object[]"},"consent_expiry":{"type":"string","format":"date-time","example":"dateTime","description":"It is the expiry date and time of the consent request.","uniqueKey":"consent_expiry","typeLabel":"string\u003cdate-time>"},"fi_from":{"type":"string","format":"date-time","example":"dateTime","description":"It is the starting date and time of the financial information you require.","uniqueKey":"fi_from","typeLabel":"string\u003cdate-time>"},"fi_to":{"type":"string","format":"date-time","example":"dateTime","description":"It is the ending date and time of the financial information you require.","uniqueKey":"fi_to","typeLabel":"string\u003cdate-time>"},"redirect_url":{"type":"string","example":"string","description":"It is the URL that you need to provide that takes the individual to after viewing the consent request.","uniqueKey":"redirect_url","typeLabel":"string"},"consent_mode":{"type":"string","example":"STORE","description":"It is the type of configuration for handling the financial information of the individual.\nPossible values are\n - `VIEW`: It indicates that the information is for viewing purpose.\n - `STORE`: It indicates that the information is for storing purpose.\n - `QUERY`: It indicates that the information is for querying purposes, including performing searches, filtering results, or making data-driven decisions.\n - `STREAM`: It indicates that the information is for streaming purposes.","uniqueKey":"consent_mode","typeLabel":"string"},"consent_type":{"type":"array","description":"It displays the type of information you require from the individual.\n\n Possible values are\n - `PROFILE`: It contains the basic information of the individual.\n - `SUMMARY`: It contains the summary of the financial information of the individual.\n - `TRANSACTIONS`: It contains the transactional information of the individual.","items":{"type":"string","example":"PROFILE","uniqueKey":"consent_type.items.[INDEX]","typeLabel":"string"},"uniqueKey":"consent_type","typeLabel":"string[]"},"fi_types":{"type":"array","description":"It displays the type of financial information you require from the individual.\n\n Possible values are\n - `DEPOSIT`","items":{"type":"string","example":"DEPOSIT","uniqueKey":"fi_types.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fi_types","typeLabel":"string[]"},"consent_start":{"type":"string","format":"date-time","description":"It is the start date and time of the consent validity for the individual's financial information.","example":"dateTime","uniqueKey":"consent_start","typeLabel":"string\u003cdate-time>"},"data_life_expiry":{"type":"string","format":"date","example":"date","description":"It displays the expiry date of the information fetched.","uniqueKey":"data_life_expiry","typeLabel":"string\u003cdate>"},"filter":{"type":"array","description":"It contains the filter options to sort the finanical information of the individual.","items":{"type":"object","properties":{"type":{"type":"string","example":"TRANSACTION_AMOUNT","description":"It displays the type of detail in the financial information.\nPossible value - `TRANSACTIONAMOUNT`","uniqueKey":"filter.items.[INDEX].type","typeLabel":"string"},"operator":{"type":"string","example":"LESS_THAN","description":"It displays the filter criteria.\nPossible values are\n- `LESS_THAN` - `GREATER_THAN` - `EQUAL_TO` - `NOT_EQUAL_TO` - `GREATER_THAN_EQUAL_TO` - `LESS_THAN_EQUAL_TO`","uniqueKey":"filter.items.[INDEX].operator","typeLabel":"string"},"value":{"type":"string","example":"20000","uniqueKey":"filter.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"filter.items.[INDEX]","typeLabel":"object"},"uniqueKey":"filter","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"consent_verification_id":"abc12345","consent_ref_id":67890,"consent_redirect_url":"https://example.com/redirect","status":"SUCCESS","customer_identifiers":[{"type":"MOBILE","value":"9876543210"}],"consent_start":"2024-01-01T00:00:00Z","consent_expiry":"2024-12-31T23:59:59Z","fi_from":"2024-01-01T00:00:00Z","fi_to":"2024-12-31T23:59:59Z","redirect_url":"https://example.com/redirect","consent_mode":"STORE","consent_type":["PROFILE","SUMMARY","TRANSACTION"],"fi_types":["DEPOSIT"],"data_life_expiry":"2024-01-07","filter":[{"type":"TRANSACTION_AMOUNT","operator":"LESS_THAN","value":"20000"}]},"examples":{"Example":{"title":"Example","value":{"consent_verification_id":"abc12345","consent_ref_id":67890,"consent_redirect_url":"https://example.com/redirect","status":"SUCCESS","customer_identifiers":[{"type":"MOBILE","value":"9876543210"}],"consent_start":"2024-01-01T00:00:00Z","consent_expiry":"2024-12-31T23:59:59Z","fi_from":"2024-01-01T00:00:00Z","fi_to":"2024-12-31T23:59:59Z","redirect_url":"https://example.com/redirect","consent_mode":"STORE","consent_type":["PROFILE","SUMMARY","TRANSACTION"],"fi_types":["DEPOSIT"],"data_life_expiry":"2024-01-07","filter":[{"type":"TRANSACTION_AMOUNT","operator":"LESS_THAN","value":"20000"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"498c4662-68ed-4744-a2da-8ce332928ab5":{"description":"Validation errors for GetStatus API of Consent.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"X-Client-Id Missing":{"title":"X-Client-Id Missing","value":{"type":"validation_error","code":"x-client-id_missing","message":"x-client-id is missing in the request."}},"X-Client-Secret Missing":{"title":"X-Client-Secret Missing","value":{"type":"validation_error","code":"x-client-secret_missing","message":"x-client-secret is missing in the request."}},"verification_id and reference_id missing":{"title":"verification_id and reference_id missing","value":{"type":"validation_error","code":"invalid_request","message":"provide consent_verification_id or consent_ref_id"}},"Invalid reference_id format":{"title":"Invalid reference_id format","value":{"type":"validation_error","code":"consent_ref_id_value_invalid","message":"Bad request, please check API documentation"}}},"exampleType":"examples"}},"exampleType":"examples"},"7a27d32c-36a5-4eaf-a223-67b13d25938b":{"description":"Invalid client ID and client secret combination.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid client ID and client secret combination":{"title":"Invalid client ID and client secret combination","value":{"type":"authentication_error","code":"authentication_failed","message":"Invalid clientId and clientSecret combination"}}},"exampleType":"examples"}},"exampleType":"examples"},"d882e43a-911d-44b7-815e-422564c35f78":{"description":"Authentication error (IP not whitelisted).","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"IP not whitelisted":{"title":"IP not whitelisted","value":{"type":"authentication_error","code":"ip_validation_failed","message":"IP not whitelisted your current ip is 106.51.91.104.For IP whitelisting assistance, visit our guide at https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification"}},"x-cf-signature header missing":{"title":"x-cf-signature header missing","value":{"type":"validation_error","code":"authentication_failed","message":"x-cf-signature missing in the request header"}}},"exampleType":"examples"}},"exampleType":"examples"},"e578bff2-d662-4693-b614-0746ec43c4fe":{"description":"Validation error because of insufficient balance to process this request.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Insufficient balance":{"title":"Insufficient balance","value":{"type":"validation_error","code":"insufficient_balance","message":"Insufficient balance to process this request"}}},"exampleType":"examples"}},"exampleType":"examples"},"64301055-0e7a-4f6a-87e9-519816558dfe":{"description":"Rate limit exceed error.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Rate limit error per operation":{"title":"Rate limit error per operation","value":{"type":"rate_limit_error","code":"too_many_requests_per_operation","message":"Too many requests for this operation, rate limit reached"}},"Rate limit error per IP":{"title":"Rate limit error per IP","value":{"type":"rate_limit_error","code":"too_many_requests_per_ip","message":"Too many requests from the IP, rate limit reached"}}},"exampleType":"examples"}},"exampleType":"examples"},"1d7fcc08-a80b-4db0-963f-16789ca4585a":{"description":"Internal error.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Internal Server Error":{"title":"Internal Server Error","value":{"type":"internal_error","code":"verification_failed","message":"something went wrong"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ede4cf51-f7b8-40d1-b852-86cc70402aea":{"XClientID":{"type":"apiKey","in":"header","name":"x-client-id","description":"Your unique client identifier issued by Cashfree. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","scopes":[],"schemeName":"XClientID"},"XClientSecret":{"type":"apiKey","in":"header","name":"x-client-secret","description":"The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","scopes":[],"schemeName":"XClientSecret"}}},"servers":{"46c81061-81d2-4a48-9b1f-8ccc3114ac86":{"description":"Sandbox Server","url":"https://sandbox.cashfree.com/verification"},"6f583a9b-e5f2-4bdd-912a-790bafb666e1":{"description":"Production Server","url":"https://api.cashfree.com/verification"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-client-id","description":"Your unique client identifier issued by Cashfree. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","scopes":[],"schemeName":"XClientID"},"schema":{"title":"x-client-id","type":"string","description":"Your unique client identifier issued by Cashfree. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"XClientID","name":"x-client-id"},{"scheme":{"type":"apiKey","in":"header","name":"x-client-secret","description":"The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","scopes":[],"schemeName":"XClientSecret"},"schema":{"title":"x-client-secret","type":"string","description":"The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"XClientSecret","name":"x-client-secret"}],"title":"XClientID \u0026 XClientSecret"}]},"originalFileLocation":"openapi/vrs/vrsv2.yaml"},"subdomain":"cashfreepayments-d00050e9","siteName":"Cashfree Developer Documentation","title":"AA Consent Status | Cashfree","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"manual"},"contextualStarterQuestions":[{"_id":"6a79b17c3629fc88876e00c2","deploymentId":"66d5827f2de686bc28e7722b","questionText":"Can I request user financial data?","status":"active","generatedBy":"contextual","path":"api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status","createdAt":"2026-08-10T11:09:48.780Z","updatedAt":"2026-08-10T11:09:48.780Z","__v":0},{"_id":"6a79b17c3629fc88876e00c1","deploymentId":"66d5827f2de686bc28e7722b","questionText":"What does consent status tell me?","status":"active","generatedBy":"contextual","path":"api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status","createdAt":"2026-08-10T11:09:48.780Z","updatedAt":"2026-08-10T11:09:48.780Z","__v":0},{"_id":"6a79b17c3629fc88876e00c0","deploymentId":"66d5827f2de686bc28e7722b","questionText":"How do I check user consent status?","status":"active","generatedBy":"contextual","path":"api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status","createdAt":"2026-08-10T11:09:48.780Z","updatedAt":"2026-08-10T11:09:48.780Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-09T10:17:23.803Z","originalFileLocation":"api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status.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=\"light\"}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=\"Use this API to retrieve the current consent status for a user and determine whether you may request protected financial or personal information for verification.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cashfree Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"AA Consent Status | Cashfree\">\u003cmeta data-mint-head property=\"og:description\" content=\"Check the live status of a Cashfree Account Aggregator consent request to confirm whether the customer has approved, paused, or revoked financial data sharing.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cashfree Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.cashfree.com/docs/api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cashfreepayments-d00050e9.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Get+Consent+Status\u0026amp;description=Use+this+API+to+retrieve+the+current+consent+status+for+a+user+and+determine+whether+you+may+request+protected+financial+or+personal+information+for+verificatio\u0026amp;theme=2adde9c6a50d91a75e16dbfe\u0026amp;signature=8aa3a36fa3bd7cfdf0277b78926a062c499ab384310bc51410e8a07c4b8de3c5\">\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=\"AA Consent Status | Cashfree\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Check the live status of a Cashfree Account Aggregator consent request to confirm whether the customer has approved, paused, or revoked financial data sharing.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cashfreepayments-d00050e9.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Get+Consent+Status\u0026amp;description=Use+this+API+to+retrieve+the+current+consent+status+for+a+user+and+determine+whether+you+may+request+protected+financial+or+personal+information+for+verificatio\u0026amp;theme=2adde9c6a50d91a75e16dbfe\u0026amp;signature=8aa3a36fa3bd7cfdf0277b78926a062c499ab384310bc51410e8a07c4b8de3c5\">\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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cashfree Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6930ca\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"T69Ao_T0Ps8pkRbluKzW179qvd_aCsWISCApeSsIhRU\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.cashfree.com/docs/api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/vrs/v2/account-aggregator/account-aggregator-get-consent-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cashfree Developer Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cashfree Developer Documentation","nav":{"global":null,"tabs":[{"tab":"Payments","groups":[{"group":"Payments","pages":[{"title":"Introduction","sidebarTitle":"Introduction","href":"/payments/introduction"},{"title":"Quickstart Guide","sidebarTitle":"Quickstart","href":"/payments/quickstart-guide"},{"group":"Dashboards","pages":[{"title":"Web Dashboard","sidebarTitle":"Web Dashboard","href":"/payments/dashboard"},{"title":"Mobile Dashboard","sidebarTitle":"Mobile Dashboard","href":"/payments/mobile-dashboard"},{"title":"Cashfree Spark","sidebarTitle":"Spark","href":"/payments/spark-ai"}]}]},{"group":"Payment Gateway","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/overview"},{"group":"Cashfree Hosted Checkout","pages":[{"title":"Web Integration","sidebarTitle":"Web Integration","href":"/payments/online/web/redirect"},{"group":"Mobile Integration","pages":[{"title":"Android Integration","sidebarTitle":"Android Integration","href":"/payments/online/mobile/android"},{"title":"React Native Integration","sidebarTitle":"React Native Integration","href":"/payments/online/mobile/react-native"},{"title":"Flutter Integration","sidebarTitle":"Flutter Integration","href":"/payments/online/mobile/flutter"},{"title":"iOS Integration","sidebarTitle":"iOS Integration","href":"/payments/online/mobile/ios"},{"title":"Cordova Integration","sidebarTitle":"Cordova Integration","href":"/payments/online/mobile/cordova"},{"group":"Miscellaneous","pages":[{"title":"Cashfree Integrity","sidebarTitle":"Cashfree Integrity","href":"/payments/online/mobile/misc/cashfree_integrity"},{"title":"Integrity Prod Setup","sidebarTitle":"Integrity Prod Setup","href":"/payments/online/mobile/misc/cashfree_integrity_prod_testing"},{"group":"UPI Intent","pages":[{"title":"UPI Intent Test APK","sidebarTitle":"UPI Intent Test APK","href":"/payments/online/mobile/misc/cashfree_upi_simulator_apk"},{"title":"UPI Intent in JS SDK","sidebarTitle":"UPI Intent in JS SDK","href":"/payments/online/mobile/misc/upi_intent_support_js_sdk"},{"title":"UPI Intent in iOS","sidebarTitle":"UPI Intent in iOS","href":"/payments/online/web/custom-checkout-ios"}]}]},{"title":"Integration FAQs","sidebarTitle":"FAQs","href":"/payments/online/mobile/integration-faqs"}]}]},{"group":"Custom Checkout","pages":[{"group":"Web Integration","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/online/element/overview"},{"title":"SDK Libraries","sidebarTitle":"SDK Libraries","href":"/payments/online/element/sdks"},{"group":"Element SDK","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/online/element/element-sdk"},{"title":"Web Element SDK","sidebarTitle":"Web Element SDK","href":"/payments/online/element/introduction"}]},{"group":"Components","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/online/element/component-overview"},{"title":"Cards Component","sidebarTitle":"Cards Component","href":"/payments/online/element/cards"},{"title":"UPI Component","sidebarTitle":"UPI Component","href":"/payments/online/element/upi"},{"title":"Wallets, Net Banking and BNPL Components","sidebarTitle":"Wallets, Net Banking and BNPL Components","href":"/payments/online/element/other-components"}]},{"title":"Customise Component","sidebarTitle":"Customise a Component","href":"/payments/online/element/customize"},{"title":"Configuring Payment Options","sidebarTitle":"Configuring Payment Options","href":"/payments/online/element/payment-options"},{"title":"Examples","sidebarTitle":"Examples","href":"/payments/online/element/examples"},{"title":"Appendix","sidebarTitle":"Appendix","href":"/payments/online/element/appendix"}]},{"group":"Mobile Integration","pages":[{"title":"Android Element Integration","sidebarTitle":"Android Integration","href":"/payments/online/element/mobile/android"},{"title":"React Native Element Integration","sidebarTitle":"React Native Integration","href":"/payments/online/element/mobile/react-native"},{"title":"Flutter Element Integration","sidebarTitle":"Flutter Integration","href":"/payments/online/element/mobile/flutter"},{"group":"Custom Card","pages":[{"title":"Android Element Custom Card Component (Non-PCI)","sidebarTitle":"Android Non-PCI Integration","href":"/payments/online/element/custom-card/android-custom-card"},{"title":"iOS Element Custom Card Component (Non-PCI)","sidebarTitle":"iOS Non-PCI Integration","href":"/payments/online/element/custom-card/ios-custom-card"},{"title":"React Native Element Custom Card Component","sidebarTitle":"React Native Non-PCI Integration","href":"/payments/online/element/custom-card/react-native-custom-card"}]}]},{"title":"BNPL Plus - Native Web","sidebarTitle":"BNPL Plus - Native Web","href":"/payments/online/bnpl-plus"}]},{"group":"No Code Solutions","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/no-code/overview"},{"group":"Payment Links","pages":[{"title":"Payment Links","sidebarTitle":"Overview","href":"/payments/no-code/payment-link"},{"group":"Customise a Payment Link","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/no-code/customize/overview"},{"title":"Send Reminder","sidebarTitle":"Send Reminder","href":"/payments/no-code/customize/send-reminder"},{"title":"Copy Link","sidebarTitle":"Copy Link","href":"/payments/no-code/customize/copy-link"},{"title":"Edit Payment Link","sidebarTitle":"Edit Payment Link","href":"/payments/no-code/customize/edit-payment-link"},{"title":"Cancel Payment Link","sidebarTitle":"Cancel Payment Link","href":"/payments/no-code/customize/cancel-payment-link"}]},{"title":"WhatsApp Payment Links","sidebarTitle":"WhatsApp Payment Links","href":"/payments/no-code/whatsapp-payment-links"},{"title":"Custom SMS Message","sidebarTitle":"Custom SMS Message","href":"/payments/no-code/customize/custom-sms"}]},{"group":"Payment Forms","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/no-code/payment-forms/overview"},{"title":"Intelliforms","sidebarTitle":"Intelliforms","href":"/payments/no-code/payment-forms/intelliforms-docs"},{"title":"Personalised Payment Form","sidebarTitle":"Personalised Payment Form","href":"/payments/no-code/payment-forms/personalise-payment-form"},{"title":"UTM Tracking on Payment Forms","sidebarTitle":"UTM Tracking","href":"/payments/no-code/payment-forms/utm-tracking"},{"title":"Subscription Payment Form","sidebarTitle":"Subscription Payment Form","href":"/payments/no-code/payment-forms/subscription-payment-form"},{"title":"Customer Verification on Payment Forms","sidebarTitle":"Customer Verification","href":"/payments/no-code/customize/identity"},{"title":"Frequently Asked Questions","sidebarTitle":"FAQs","href":"/payments/no-code/payment-forms/faq"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/payments/no-code/payment-forms/webhooks"}]},{"title":"Payment Button","sidebarTitle":"Payment Button","href":"/payments/no-code/payment-button"},{"title":"Payment Handle","sidebarTitle":"Payment Handle","href":"/payments/no-code/payment-handle"},{"group":"E-Commerce Plugins","pages":[{"title":"E-Commerce Plugins","sidebarTitle":"Overview","href":"/payments/plugins/overview"},{"title":"Wix Payment Plugin","sidebarTitle":"Wix","href":"/payments/plugins/wix"},{"title":"Magento Payment Plugin","sidebarTitle":"Magento","href":"/payments/plugins/magento"},{"title":"Zoho Payment Plugin","sidebarTitle":"Zoho","href":"/payments/plugins/zoho"},{"title":"WordPress","sidebarTitle":"WordPress","href":"/payments/plugins/wordpress"},{"title":"Other E-Commerce Plugins","sidebarTitle":"Others","href":"/payments/plugins/others"}]}]},{"group":"Webhooks","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/online/webhooks/overview"},{"title":"Configuration","sidebarTitle":"Configuration","href":"/payments/online/webhooks/configure"},{"title":"Webhook Signature Verification","sidebarTitle":"Signature Verification","href":"/payments/online/webhooks/signature-verification"},{"title":"Webhook Security Checklist","sidebarTitle":"Security Checklist","href":"/payments/online/webhooks/security-checklist"},{"title":"Webhook Idempotency","sidebarTitle":"Webhook Idempotency","icon":"webhook","href":"/payments/online/webhooks/webhook-indempotency"},{"title":"Troubleshooting","sidebarTitle":"Troubleshooting","href":"/payments/online/webhooks/troubleshooting"}]},{"group":"Going Live","pages":[{"title":"Go Live Checklist","sidebarTitle":"Go Live Checklist","href":"/payments/online/go-live/checklist"},{"title":"Whitelist Your Website or App","sidebarTitle":"Whitelist Your Website or App","href":"/payments/online/go-live/whitelist"},{"title":"API Logs and Metrics","sidebarTitle":"API Logs and Metrics","href":"/payments/online/go-live/api-logs"}]},{"group":"Resources","pages":[{"title":"Payment Lifecycle","sidebarTitle":"Payment Lifecycle","href":"/payments/online/resources/payment-lifecycle"},{"title":"Payment Icons","sidebarTitle":"Payment Icons","href":"/payments/online/resources/payment-icons"},{"title":"Rate Limits and Integration Usage","sidebarTitle":"Rate Limits and Integration Usage","href":"/payments/online/resources/rate-limits"},{"title":"Sandbox Environment","sidebarTitle":"Sandbox Environment","href":"/payments/online/resources/sandbox-environment"}]},{"group":"Payment Methods","pages":[{"title":"Payment Methods","sidebarTitle":"Overview","href":"/payments/manage/payment-methods/overview"},{"group":"Credit and Debit Cards","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/manage/payment-methods/credit-and-debit-cards/overview"},{"group":"Apple Pay","pages":[{"title":"Apple Pay","sidebarTitle":"Overview","href":"/payments/manage/payment-methods/credit-and-debit-cards/apple-pay/overview"},{"title":"Apple Pay Hosted Checkout","sidebarTitle":"Hosted Checkout","href":"/payments/manage/payment-methods/credit-and-debit-cards/apple-pay/hosted-checkout"},{"group":"Custom Checkout","pages":[{"title":"Apple Pay Custom Checkout","sidebarTitle":"Overview","href":"/payments/manage/payment-methods/credit-and-debit-cards/apple-pay/custom-checkout/overview"},{"title":"Merchant Decrypts Apple Pay","sidebarTitle":"Merchant Decrypts","href":"/payments/manage/payment-methods/credit-and-debit-cards/apple-pay/custom-checkout/merchant-decrypts"},{"title":"Apple Pay Via Orchestrator","sidebarTitle":"Orchestrator","href":"/payments/manage/payment-methods/credit-and-debit-cards/apple-pay/custom-checkout/orchestrator"}]}]},{"title":"Google Pay","sidebarTitle":"Google Pay","href":"/payments/manage/payment-methods/credit-and-debit-cards/google-pay"}]},{"group":"UPI","pages":[{"title":"UPI Payments","sidebarTitle":"UPI Payments","href":"/payments/manage/payment-methods/upi"},{"title":"UPI Collect Flow Deprecation","sidebarTitle":"UPI Collect Flow Deprecation","icon":null,"href":"/payments/manage/payment-methods/upi-collect"},{"title":"UPI AutoPay Interoperability","sidebarTitle":"UPI AutoPay Interoperability","href":"/payments/manage/payment-methods/upi-autopay-interoperability"}]},{"title":"Netbanking","sidebarTitle":"Netbanking","href":"/payments/manage/payment-methods/netbanking"},{"title":"Bank Transfers (Challans)","sidebarTitle":"Bank Transfers","href":"/payments/manage/payment-methods/bank-transfers"},{"title":"Wallets","sidebarTitle":"Wallets","href":"/payments/manage/payment-methods/wallets"},{"title":"Paylater and Cardless EMIs","sidebarTitle":"Paylater and Cardless EMIs","href":"/payments/manage/payment-methods/paylaters-and-cardless-emis"}]},{"group":"Manage","pages":[{"title":"Payment Method Eligibility","sidebarTitle":"Payment Method Eligibility","icon":null,"iconType":"solid","href":"/payments/manage/payment-method-eligibility"},{"title":"Monitoring and Observability","sidebarTitle":"Monitoring and Observability","href":"/payments/manage/monitor"},{"group":"Refunds","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/manage/refunds/overview"},{"title":"Refund Details","sidebarTitle":"Refund Details","href":"/payments/manage/refunds/refund-details"},{"title":"Instant Refund","sidebarTitle":"Instant Refund","href":"/payments/manage/refunds/instant-refunds"}]},{"group":"Chargebacks and Disputes","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/manage/disputes/overview"},{"title":"Disputes Types","sidebarTitle":"Disputes Types","href":"/payments/manage/disputes/disputes-types"},{"title":"Disputes States","sidebarTitle":"Disputes States","href":"/payments/manage/disputes/disputes-states"},{"title":"Dispute Process Flow","sidebarTitle":"Dispute Process Flow","href":"/payments/manage/disputes/disputes-process-flow"},{"title":"Reason Codes and Documents","sidebarTitle":"Reason Codes and Documents","href":"/payments/manage/disputes/reason-codes"},{"title":"Disputes Actions","sidebarTitle":"Disputes Actions","href":"/payments/manage/disputes/disputes-actions"},{"title":"Dashboard Actions","sidebarTitle":"Dashboard Actions","href":"/payments/manage/disputes/dashboard-actions"},{"title":"Disputes APIs","sidebarTitle":"Disputes APIs","href":"/payments/manage/disputes/disputes-apis"},{"title":"Disputes FAQs","sidebarTitle":"Disputes FAQs","href":"/payments/manage/disputes/disputes-faqs"}]},{"title":"Settlements","sidebarTitle":"Settlements","href":"/payments/manage/settlements"},{"title":"Reports","sidebarTitle":"Reports","href":"/payments/manage/reports"},{"title":"Schedule Reports","sidebarTitle":"Schedule Reports","href":"/payments/manage/schedule-reports"},{"title":"Transactions","sidebarTitle":"Transactions","href":"/payments/manage/transactions"},{"title":"Downtimes","sidebarTitle":"Downtimes","href":"/payments/manage/downtimes"}]},{"group":"Features","pages":[{"title":"Show Purchase Context on Checkout","sidebarTitle":"Contextual Checkout","href":"/payments/features/contextual-checkout"},{"title":"Banking Connect","sidebarTitle":"Banking Connect","href":"/payments/features/banking-connect"},{"title":"Card Link","sidebarTitle":"Card Link","href":"/payments/features/card-link"},{"title":"PayFast","sidebarTitle":"PayFast","href":"/payments/features/payfast"},{"title":"UPI App Priority Reordering","sidebarTitle":"UPI App Priority Reordering","href":"/payments/features/upi-app-reordering"},{"title":"Native OTP","sidebarTitle":"Native OTP","href":"/payments/features/native-otp"},{"title":"Token Vault","sidebarTitle":"Token Vault","href":"/payments/features/token-vault"},{"title":"CVV-Less Card Payments","sidebarTitle":"CVV-Less Card Payments","href":"/payments/features/cvv-less"},{"title":"Preauthorisation","sidebarTitle":"Preauthorisation","href":"/payments/features/pre-authorisation"},{"title":"Third Party Validation","sidebarTitle":"Third Party Validation","href":"/payments/features/tpv"},{"title":"Payment Account Reference","sidebarTitle":"Payment Account Reference","href":"/payments/features/payment-account-reference"},{"title":"Card BIN Details","sidebarTitle":"Card BIN Details","href":"/payments/features/card-bin-details"}]},{"group":"Quick Guide","pages":[{"title":"Payment Gateway","sidebarTitle":"Payment Gateway","icon":"faBook","href":"/payments/quick-guide/payment"},{"title":"Refunds","sidebarTitle":"Refunds","icon":"faBook","href":"/payments/quick-guide/refunds"},{"title":"Settlements","sidebarTitle":"Settlements","icon":"faBook","href":"/payments/quick-guide/settlement"}]},{"title":"Payments: General FAQs","sidebarTitle":"General FAQs","href":"/payments/general-faqs"}]},{"group":"Checkout","pages":[{"group":"Shopify","pages":[{"title":"Shopify","sidebarTitle":"Overview","href":"/payments/shopify/overview"},{"title":"Cashfree Plugin for Shopify","sidebarTitle":"Payments Plugin","href":"/payments/shopify/payments"},{"title":"BNPL Plus Plugin","sidebarTitle":"BNPL Plus","href":"/payments/shopify/bnpl"},{"title":"One Click Checkout for Shopify","sidebarTitle":"One Click Checkout","href":"/payments/shopify/one-click-checkout"}]},{"title":"WooCommerce","sidebarTitle":"WooCommerce","href":"/payments/checkout/woocommerce"},{"group":"Customisation","pages":[{"title":"Visual Customisation","sidebarTitle":"Visual Customisation","href":"/payments/checkout/customise-checkout"},{"title":"Business Customisation","sidebarTitle":"Business Customisation","href":"/payments/checkout/bussiness-customisation"}]},{"group":"One Click Checkout","pages":[{"title":"One Click Checkout","sidebarTitle":"Overview","href":"/payments/checkout/one-click-checkout"},{"title":"Integrations","sidebarTitle":"Integrations","href":"/payments/checkout/integration-one-click-checkout"},{"title":"Go Live Checklist","sidebarTitle":"Go Live Checklist","href":"/payments/checkout/checklist"},{"title":"Customer Login and Address-Prefilling","sidebarTitle":"Login and Address","href":"/payments/checkout/address-prefill"},{"group":"Managing COD","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/checkout/cod/overview"},{"title":"Configure Cash on Delivery","sidebarTitle":"Configure Cash on Delivery","href":"/payments/checkout/cod/configure"},{"title":"RTO Intelligence","sidebarTitle":"RTO Intelligence","href":"/payments/checkout/cod/rto"},{"title":"Blacklist Cash on Delivery (COD)","sidebarTitle":"Blacklist Cash on Delivery (COD)","href":"/payments/checkout/cod/blacklist-cod"}]},{"group":"Abandoned Checkout","pages":[{"title":"Abandoned Checkout","sidebarTitle":"Overview","href":"/payments/checkout/abandoned-checkout/abandoned-checkout"},{"title":"Abandoned Checkout Webhook","sidebarTitle":"Webhook","icon":"webhook","href":"/payments/checkout/abandoned-checkout/webhook"},{"title":"Ecom360 Webhook","sidebarTitle":"Ecom360 Webhook","icon":"webhook","href":"/payments/checkout/abandoned-checkout/ecom360"}]},{"group":"Shipping and Delivery","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/checkout/shipping-overview"},{"title":"Managing Shipping and Delivery","sidebarTitle":"Managing Shipping and Delivery","href":"/payments/checkout/shipping-managing-creation"}]},{"title":"One Click Checkout FAQs","sidebarTitle":"FAQs","icon":null,"iconType":"solid","href":"/payments/checkout/one-click-checkout-faq"}]},{"group":"Improving Conversion","pages":[{"title":"Recovering Abandoned Orders via WhatsApp","sidebarTitle":"Cart Recovery","href":"/payments/checkout/cart-recovery"},{"group":"Offers","pages":[{"title":"Managing Offers","sidebarTitle":"Overview","href":"/payments/checkout/offers"},{"title":"Shopify Discounts","sidebarTitle":"Shopify Discounts","href":"/payments/checkout/offers/shopify"},{"title":"No Cost EMIs","sidebarTitle":"No Cost EMIs","href":"/payments/checkout/offers/no-cost-emi"},{"title":"Offers FAQs","sidebarTitle":"FAQs","href":"/payments/checkout/offers/offers-faqs"}]}]},{"group":"After Payment","pages":[{"title":"Payment Analytics","sidebarTitle":"Payment Analytics","href":"/payments/checkout/after/analytics"},{"title":"External Analytics","sidebarTitle":"External Analytics","href":"/payments/checkout/after/external-analytics"},{"title":"Customer Hub","sidebarTitle":"Managing Customer","href":"/payments/checkout/after/customer-hub"}]},{"title":"Social Proofing","sidebarTitle":"Social Proofing","href":"/payments/checkout/social-proofing"},{"title":"Cashfree Trusted Badge","sidebarTitle":"Cashfree Trusted Badge","href":"/payments/checkout/trusted-badge"}]},{"group":"International Payments","pages":[{"group":"Collect from India","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/international-payments/collect-from-india/overview"},{"title":"Transaction Verification","sidebarTitle":"Transaction Verification","href":"/payments/international-payments/collect-from-india/transaction-verification"}]},{"group":"Collect from the World","pages":[{"group":"IPG","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/international-payments/ipg/overview"},{"title":"Currencies","sidebarTitle":"Currencies","href":"/payments/international-payments/ipg/currencies-supported"},{"title":"Pay in Native Currency","sidebarTitle":"Pay in Native Currency","href":"/payments/international-payments/ipg/pay-native"},{"title":"Paypal for International Payments","sidebarTitle":"Paypal","href":"/payments/international-payments/ipg/paypal"}]},{"group":"Global Collections","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/international-payments/global-collections/introduction"},{"title":"Collection Accounts","sidebarTitle":"Collection Accounts","href":"/payments/international-payments/global-collections/collection-accounts"},{"title":"Transactions","sidebarTitle":"Transactions","href":"/payments/international-payments/global-collections/transactions"},{"title":"Global Collections FAQs","sidebarTitle":"FAQs","href":"/payments/international-payments/global-collections/faqs"}]}]}]},{"group":"Flowwise","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/flowwise/overview"},{"title":"Add a Gateway","sidebarTitle":"Add a Gateway","href":"/payments/flowwise/add-gateway"},{"group":"Configure","pages":[{"title":"Dynamic Routing","sidebarTitle":"Dynamic Routing","href":"/payments/flowwise/routing/dynamic-routing"},{"title":"Add a New Configuration","sidebarTitle":"Add a New Configuration","href":"/payments/flowwise/routing/add-rules"},{"group":"Gateways","pages":[{"title":"PayU","sidebarTitle":"PayU","href":"/payments/flowwise/gateways/payu"},{"title":"Paytm","sidebarTitle":"Paytm","href":"/payments/flowwise/gateways/paytm"},{"title":"Razorpay","sidebarTitle":"Razorpay","href":"/payments/flowwise/gateways/razorpay"},{"title":"Cashfree","sidebarTitle":"Cashfree","href":"/payments/flowwise/gateways/cashfree"},{"title":"Easebuzz","sidebarTitle":"Easebuzz","href":"/payments/flowwise/gateways/easebuzz"},{"title":"CCAvenue","sidebarTitle":"CCAvenue","href":"/payments/flowwise/gateways/ccavenue"},{"title":"Plural","sidebarTitle":"Plural","href":"/payments/flowwise/gateways/plural"},{"title":"Billdesk","sidebarTitle":"Billdesk","href":"/payments/flowwise/gateways/billdesk"},{"title":"HDFC","sidebarTitle":"HDFC","href":"/payments/flowwise/gateways/hdfc"},{"title":"Lyra","sidebarTitle":"Lyra","href":"/payments/flowwise/gateways/lyra"}]}]},{"title":"Flowwise FAQs","sidebarTitle":"FAQs","href":"/payments/flowwise/flowwise-faq"}]},{"group":"RiskShield","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/risk-shield/overview"},{"title":"Fraud Risk Indicator","sidebarTitle":"Fraud Risk Indicator","href":"/payments/risk-shield/fraud-risk-indicator"},{"title":"Risky Transactions","sidebarTitle":"Risky Transactions","href":"/payments/risk-shield/risky-transactions"},{"group":"Setup Rules","pages":[{"title":"Smart Rules","sidebarTitle":"Smart Rules","href":"/payments/risk-shield/smart-rules"},{"title":"Blacklists","sidebarTitle":"Blacklists","href":"/payments/risk-shield/my-blacklists"},{"title":"Whitelists","sidebarTitle":"Whitelists","href":"/payments/risk-shield/whitelists"}]}]},{"group":"Subscription","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/subscription/introduction"},{"title":"Supported Payment Methods","sidebarTitle":"Supported Payment Methods","href":"/payments/subscription/payment-modes"},{"title":"UPI One-Time Mandate","sidebarTitle":"UPI One-Time Mandate","href":"/payments/subscription/upi-otm"},{"title":"Create a Subscription","sidebarTitle":"Create a Subscription","href":"/payments/subscription/create"},{"title":"Charge a Subscription","sidebarTitle":"Charge a Subscription","href":"/payments/subscription/charge"},{"group":"Cashfree Hosted Checkout","pages":[{"title":"Web Integration","sidebarTitle":"Web Integration","href":"/payments/subscription/hosted-checkout"},{"group":"Mobile Integration","pages":[{"title":"Android Integration","sidebarTitle":"Android Integration","href":"/payments/subscription/subscription_checkout_android_sdk"},{"title":"React Native Integration","sidebarTitle":"React Native Integration","href":"/payments/subscription/subscription_checkout_react_native_sdk"},{"title":"Flutter Integration","sidebarTitle":"Flutter Integration","href":"/payments/subscription/subscription_checkout_flutter_sdk"},{"title":"iOS Integration","sidebarTitle":"iOS Integration","href":"/payments/subscription/subscription_checkout_ios_sdk"},{"title":"Cordova Integration","sidebarTitle":"Cordova Integration","href":"/payments/subscription/subscription_checkout_cordova_sdk"}]}]},{"group":"Custom Checkout","pages":[{"group":"Mobile Integration","pages":[{"title":"Android Subscription Integration","sidebarTitle":"Android Integration","href":"/payments/subscription/custom-checkout/mobile/android-subscription-element"},{"title":"iOS Subscription Integration","sidebarTitle":"iOS Integration","href":"/payments/subscription/custom-checkout/mobile/ios-subscription-element"},{"title":"Flutter Subscription Integration","sidebarTitle":"Flutter Integration","href":"/payments/subscription/custom-checkout/mobile/flutter-subscription-element"},{"title":"React Native Subscription Integration","sidebarTitle":"React Native Integration","href":"/payments/subscription/custom-checkout/mobile/react-native-subscription-element"}]},{"group":"Custom Card","pages":[{"title":"Android Custom Card Component (Non-PCI)","sidebarTitle":"Android Non-PCI Integration","href":"/payments/subscription/custom-checkout/custom-card/android-custom-card"},{"title":"iOS Custom Card Component (Non-PCI)","sidebarTitle":"iOS Non-PCI Integration","href":"/payments/subscription/custom-checkout/custom-card/ios-custom-card"}]}]},{"title":"Manage Subscriptions","sidebarTitle":"Manage Subscriptions","href":"/payments/subscription/manage"},{"title":"Import Mandates","sidebarTitle":"Import Mandates","href":"/payments/subscription/import"},{"group":"Webhooks","pages":[{"title":"Events","sidebarTitle":"Events","icon":"webhook","href":"/payments/subscription/webhooks"},{"title":"Signature Verification","sidebarTitle":"Signature Verification","icon":"shield-check","href":"/payments/subscription/webhook-signature"}]},{"title":"Subscription FAQs","sidebarTitle":"FAQs","href":"/payments/subscription/faq"}]},{"group":"Other Products","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/other-products"},{"group":"Easy Split","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/payments/split/overview"},{"title":"Use Cases","sidebarTitle":"Use Cases","icon":null,"iconType":"solid","href":"/payments/split/use-cases"},{"title":"Features","sidebarTitle":"Features","icon":null,"iconType":"solid","href":"/payments/split/features"},{"group":"Split Recipes","pages":[{"title":"Scenarios","sidebarTitle":"Scenarios","icon":null,"iconType":"solid","href":"/payments/split/recipes/scenarios"},{"title":"Split After Payment","sidebarTitle":"Split After Payment","icon":null,"iconType":"solid","href":"/payments/split/recipes/split-a-payment"}]},{"group":"Vendors","pages":[{"title":"Add Vendor","sidebarTitle":"Add Vendor","icon":null,"iconType":"solid","href":"/payments/split/vendor/add"},{"title":"Edit Vendor Details","sidebarTitle":"Edit Vendor Details","icon":null,"iconType":"solid","href":"/payments/split/vendor/edit"},{"title":"Vendor KYC","sidebarTitle":"Vendor KYC","icon":null,"iconType":"solid","href":"/payments/split/vendor/kyc"},{"group":"Dashboard","pages":[{"title":"Vendor Dashboard","sidebarTitle":"Introduction","icon":null,"iconType":"solid","href":"/payments/split/vendor/dashboard/overview"},{"title":"Transactions","sidebarTitle":"Transactions","icon":null,"iconType":"solid","href":"/payments/split/vendor/dashboard/transactions"},{"title":"Reports","sidebarTitle":"Reports","icon":null,"iconType":"solid","href":"/payments/split/vendor/dashboard/reports"},{"title":"Settlements","sidebarTitle":"Settlements","icon":null,"iconType":"solid","href":"/payments/split/vendor/dashboard/settlements"}]},{"group":"Balance","pages":[{"title":"Adjust Vendor Balance","sidebarTitle":"Adjust Vendor Balance","icon":null,"iconType":"solid","href":"/payments/split/vendor/balance/adjust"},{"title":"Get On Demand Vendor Balance","sidebarTitle":"Get On Demand Vendor Balance","href":"/payments/split/vendor/balance/get"},{"title":"Settle On Demand Vendor Balance","sidebarTitle":"Settle On Demand Vendor Balance","href":"/payments/split/vendor/balance/settle"}]}]},{"group":"Vendor Settlements","pages":[{"title":"Split Scheme Configuration","sidebarTitle":"Split Scheme Configuration","icon":null,"iconType":"solid","href":"/payments/split/settlements/configuration"},{"title":"Vendor Instant Settlements","sidebarTitle":"Instant Settlements","icon":null,"iconType":"solid","href":"/payments/split/settlements/instant"},{"title":"Vendor On-Demand Settlements","sidebarTitle":"On-Demand Settlements","icon":null,"iconType":"solid","href":"/payments/split/settlements/on-demand"},{"title":"Vendor Standard Settlements","sidebarTitle":"Standard Settlements","icon":null,"iconType":"solid","href":"/payments/split/settlements/standard"},{"group":"Delayed Settlements","pages":[{"title":"Delay Settlements","sidebarTitle":"Introduction","icon":null,"iconType":"solid","href":"/payments/split/settlements/delay/overview"},{"title":"Order Split Delay Post Successful Payment","sidebarTitle":"Order Split Delay","icon":null,"iconType":"solid","href":"/payments/split/settlements/delay/order-level"},{"title":"Defer Settlement","sidebarTitle":"Defer Settlement","icon":null,"iconType":"solid","href":"/payments/split/settlements/delay/vendor-level"}]},{"title":"Failed Settlement Reasons","sidebarTitle":"Failed Settlement Reasons","icon":null,"iconType":"solid","href":"/payments/split/settlements/failure-reasons"}]},{"group":"Vendor Refunds","pages":[{"title":"Initiate Refunds","sidebarTitle":"Introduction","icon":null,"iconType":"solid","href":"/payments/split/refund/initiate"},{"title":"Refund Scenarios","sidebarTitle":"Refund Scenarios","icon":null,"iconType":"solid","href":"/payments/split/refund/scenarios"}]},{"group":"Billing","pages":[{"title":"Billing Configuration","sidebarTitle":"Billing Configuration","icon":null,"iconType":"solid","href":"/payments/split/billing/configuration"}]},{"group":"Vendor Reports","pages":[{"title":"Easy-Split Reports","sidebarTitle":"Overview","href":"/payments/split/reports/es-reports"},{"title":"Transactions","sidebarTitle":"Transactions","icon":null,"iconType":"solid","href":"/payments/split/reports/transaction"},{"title":"Reconciliation","sidebarTitle":"Reconciliation","icon":null,"iconType":"solid","href":"/payments/split/reports/recon"},{"title":"Settlements","sidebarTitle":"Settlements","icon":null,"iconType":"solid","href":"/payments/split/reports/settlement"},{"title":"Refunds","sidebarTitle":"Refunds","icon":null,"iconType":"solid","href":"/payments/split/reports/refunds"}]},{"title":"Settlement Webhook","sidebarTitle":"Settlement Webhook","icon":"webhook","iconType":"solid","href":"/payments/split/webhooks"},{"title":"Data to Test Integration","sidebarTitle":"Data to Test Integration","icon":null,"iconType":"solid","href":"/payments/split/data-to-test"},{"title":"Easy Split FAQs","sidebarTitle":"FAQs","icon":null,"iconType":"solid","href":"/payments/split/faq"}]},{"group":"Offline Payments","pages":[{"title":"Offline Payments","sidebarTitle":"Overview","href":"/payments/softpos/introduction"},{"title":"Get Started with Offline Payments","sidebarTitle":"Get Started","href":"/payments/softpos/how-softpos-works"},{"title":"Collection Point Setup","sidebarTitle":"Collection Point Setup","href":"/payments/softpos/collection-point-setup"},{"title":"Customer VPA","sidebarTitle":"Customer VPA","href":"/payments/softpos/customer-vpa"},{"group":"Payment Management","pages":[{"title":"Agent Collection Point","sidebarTitle":"Agent(softPOS)","href":"/payments/softpos/agent-collection-mode"},{"title":"Settlements and Reports","sidebarTitle":"Settlements and Reports","href":"/payments/softpos/settlements-reports"}]},{"title":"Offline Payments FAQs","sidebarTitle":"FAQs","href":"/payments/softpos/softpos-faq"}]},{"group":"BBPS Billers","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/bbps-billers/overview"},{"title":"Getting Onboarded and Listed on BBPS","sidebarTitle":"Getting Onboarded","icon":null,"iconType":"solid","href":"/payments/bbps-billers/onboarding"},{"group":"Dashboard Actions","pages":[{"title":"Summary Homepage","sidebarTitle":"Summary Homepage","iconType":"solid","href":"/payments/bbps-billers/dashboard-actions/summary"},{"title":"Bills","sidebarTitle":"Bills","icon":null,"iconType":"solid","href":"/payments/bbps-billers/dashboard-actions/bills"},{"title":"Transaction","sidebarTitle":"Transaction","iconType":"solid","href":"/payments/bbps-billers/dashboard-actions/transaction"},{"title":"Reports","sidebarTitle":"Reports","icon":null,"iconType":"solid","href":"/payments/bbps-billers/reports"}]},{"title":"BBPS Billers - FAQs","sidebarTitle":"FAQs","icon":null,"iconType":"solid","href":"/payments/bbps-billers/faqs"}]},{"group":"Virtual Bank Accounts (VBAs)","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/vba/overview"},{"title":"Managing Virtual Bank Accounts","sidebarTitle":"Managing Virtual Bank Accounts","href":"/payments/vba/managing-vba"},{"title":"Webhooks Configuration and Usage","sidebarTitle":"Webhooks","icon":"webhook","href":"/payments/vba/webhooks"}]},{"group":"UPI Reserve Pay","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":null,"href":"/payments/upi-reserve-pay/reserve-pay"},{"title":"Implementation Guide","sidebarTitle":"Implementation Guide","icon":null,"href":"/payments/upi-reserve-pay/upi-reserve-pay"}]}]},{"group":"Developer updates","pages":[{"group":"Changelog","pages":[{"title":"SDK Changelog Overview","sidebarTitle":"Overview","href":"/payments/developers/changelog/overview"},{"title":"Android Changelog","sidebarTitle":"Android","href":"/payments/developers/changelog/android"},{"title":"iOS Changelog","sidebarTitle":"iOS","href":"/payments/developers/changelog/ios"},{"title":"React Native Changelog","sidebarTitle":"React Native","href":"/payments/developers/changelog/react-native"},{"title":"Flutter Changelog","sidebarTitle":"Flutter","href":"/payments/developers/changelog/flutter"},{"title":"Cordova Changelog","sidebarTitle":"Cordova","href":"/payments/developers/changelog/cordova"},{"title":".NET SDK Changelog","sidebarTitle":".NET","href":"/payments/developers/changelog/dotnet"}]}]}]},{"tab":"Payouts","groups":[{"group":"Payouts","pages":[{"title":"Introduction","sidebarTitle":"Introduction","href":"/payouts/payouts/introduction"},{"group":"Dashboard","pages":[{"title":"Payouts Dashboard","sidebarTitle":"Overview","href":"/payouts/payouts/dashboard/introduction"},{"title":"Transfer Efficiency","sidebarTitle":"Transfer Efficiency","icon":null,"iconType":"solid","href":"/payouts/payouts/dashboard/transfer-efficiency"},{"title":"Email Notifications","sidebarTitle":"Email Notifications","icon":null,"iconType":"solid","href":"/payouts/payouts/dashboard/set-email-notifications"},{"title":"Payouts Reports","sidebarTitle":"Reports","icon":null,"iconType":"solid","href":"/payouts/payouts/dashboard/reports"}]},{"group":"Make Payouts","pages":[{"title":"Lifecycle","sidebarTitle":"Lifecycle","icon":null,"iconType":"solid","href":"/payouts/payouts/make-payouts/lifecycle"},{"title":"Make Payouts to Customers","sidebarTitle":"Make Payouts to Customers","href":"/payouts/payouts/make-payouts/customers"},{"title":"Assign Roles to Request and Approve Transfers","sidebarTitle":"Assign Roles to Request and Approve Transfers","href":"/payouts/payouts/make-payouts/initiator-approver"},{"title":"Transfer Reversals","sidebarTitle":"Transfer Reversals","icon":null,"iconType":"solid","href":"/payouts/payouts/make-payouts/transfer-reversals"},{"title":"Transfer Status","sidebarTitle":"Transfer Status","icon":null,"iconType":"solid","href":"/payouts/payouts/make-payouts/transfer-status"},{"title":"Recall Transfers Made","sidebarTitle":"Recall Transfers Made","icon":null,"iconType":"solid","href":"/payouts/payouts/make-payouts/recall-transfers-made"},{"title":"Payout Methods","sidebarTitle":"Payout Methods","icon":null,"iconType":"solid","href":"/payouts/payouts/make-payouts/payout-methods"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","iconType":"solid","href":"/payouts/payouts/make-payouts/webhooks"}]},{"group":"Pay2Phone","pages":[{"title":"Payouts Through Phone Number","sidebarTitle":"Through Phone Number","icon":null,"iconType":"solid","href":"/payouts/payouts/pay-2-phone/through-phone-number"},{"title":"Using Phone Number and Beneficiary Name","sidebarTitle":"And Beneficiary Name","icon":null,"iconType":"solid","href":"/payouts/payouts/pay-2-phone/and-beneficiary-name"},{"title":"Using Phone Number and Last 4 Digits of Credit Card","sidebarTitle":"And Last 4 Digits of Credit Card","icon":null,"iconType":"solid","href":"/payouts/payouts/pay-2-phone/and-credit-card"},{"title":"Using Phone Number and Beneficiary Bank","sidebarTitle":"And Beneficiary Bank","icon":null,"iconType":"solid","href":"/payouts/payouts/pay-2-phone/and-beneficiary-bank"}]},{"title":"Co-Lending","sidebarTitle":"Co-Lending","icon":null,"iconType":"solid","href":"/payouts/payouts/co-lending"},{"title":"Beneficiary Management","sidebarTitle":"Beneficiary Management","icon":null,"iconType":"solid","href":"/payouts/payouts/beneficiaries-management"},{"group":"Fund Sources","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payouts/payouts/fund-management/introduction"},{"title":"Cashfree Wallet","sidebarTitle":"Cashfree Wallet","href":"/payouts/payouts/fund-management/cashfree-wallet"},{"title":"Bank Account","sidebarTitle":"Bank Account","href":"/payouts/payouts/fund-management/bank-account"},{"title":"Manage Transfers Between Fund Sources","sidebarTitle":"Manage Transfers","icon":null,"iconType":"solid","href":"/payouts/payouts/fund-management/manage-transfers"},{"title":"Accounts","sidebarTitle":"Accounts","icon":null,"iconType":"solid","href":"/payouts/payouts/accounts"}]},{"title":"Downtimes","sidebarTitle":"Downtimes","icon":null,"iconType":"solid","href":"/payouts/payouts/downtimes"},{"group":"Low Balance","pages":[{"title":"Set Low Balance Threshold","sidebarTitle":"Set Low Balance Threshold","icon":null,"iconType":"solid","href":"/payouts/payouts/low-balance/set-threshold"},{"title":"Low Balance Transfer Queuing","sidebarTitle":"Low Balance Transfer Queuing","icon":null,"iconType":"solid","href":"/payouts/payouts/low-balance/low-balance-transfer-queuing"}]},{"group":"Integration","pages":[{"title":"Integrations","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/payouts/payouts/integrations/integrations"},{"title":"Batch Transfer","sidebarTitle":"Batch Transfer","icon":null,"iconType":"solid","href":"/payouts/payouts/integrations/batch-transfer"},{"title":"Data to Test Integration","sidebarTitle":"Data to Test Integration","icon":null,"iconType":"solid","href":"/payouts/payouts/integrations/data-to-test"},{"title":"2FA - IP Whitelisting and Public Keys","sidebarTitle":"2FA - IP Whitelisting and Public Keys","icon":null,"iconType":"solid","href":"/payouts/payouts/integrations/payouts-2fa"},{"title":"Sample Integration Kits","sidebarTitle":"Sample Integration Kits","icon":null,"iconType":"solid","href":"/payouts/payouts/integrations/samples"},{"title":"Error Handling","sidebarTitle":"Error Handling","icon":null,"iconType":"solid","href":"/payouts/payouts/integrations/error-handling"},{"title":"Go-Live Checklist","sidebarTitle":"Go-Live Checklist","icon":null,"iconType":"solid","href":"/payouts/payouts/integrations/payouts-go-live"}]},{"title":"Payouts: General FAQs","sidebarTitle":"General FAQs","href":"/payouts/payouts/general-faqs"}]},{"group":"One Escrow","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/payouts/oneescrow/overview"},{"title":"Create Virtual Account","sidebarTitle":"Create Virtual Account","icon":null,"iconType":"solid","href":"/payouts/oneescrow/create-virtual-account"},{"title":"Manage Virtual Account","sidebarTitle":"Manage Virtual Account","icon":null,"iconType":"solid","href":"/payouts/oneescrow/manage-virtual-account"},{"title":"Delete Virtual Account","sidebarTitle":"Delete Virtual Account","icon":null,"iconType":"solid","href":"/payouts/oneescrow/delete-virtual-account"},{"title":"Allocate Funds","sidebarTitle":"Allocate Funds","icon":null,"iconType":"solid","href":"/payouts/oneescrow/allocate-funds"},{"title":"Initiate Payout","sidebarTitle":"Initiate Payout","icon":null,"iconType":"solid","href":"/payouts/oneescrow/initiate-payout"},{"title":"Internal Fund Transfer","sidebarTitle":"Internal Fund Transfer","icon":null,"iconType":"solid","href":"/payouts/oneescrow/internal-fund-transfer"},{"title":"Whitelist Bank Account","sidebarTitle":"Whitelist Bank Account","icon":null,"iconType":"solid","href":"/payouts/oneescrow/whitelist-bank-account"}]},{"group":"Cashgram","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/payouts/cashgram/cashgram"},{"title":"Create Cashgram","sidebarTitle":"Create Cashgram","iconType":"solid","href":"/payouts/cashgram/create-new-cashgram"},{"title":"Approve Batch Cashgrams","sidebarTitle":"Approve Batch Cashgrams","icon":null,"iconType":"solid","href":"/payouts/cashgram/approve-cashgrams"},{"title":"Verify Beneficiary Name","sidebarTitle":"Verify Beneficiary Name","icon":null,"iconType":"solid","href":"/payouts/cashgram/verify-bene-name"},{"title":"Redeem a Cashgram","sidebarTitle":"Redeem a Cashgram","icon":null,"iconType":"solid","href":"/payouts/cashgram/redeem-a-cashgram"},{"title":"Lifecycle","sidebarTitle":"Lifecycle","icon":null,"iconType":"solid","href":"/payouts/cashgram/cashgram-lifecycle"},{"group":"Integration","pages":[{"title":"Integration","sidebarTitle":"Integration","icon":null,"iconType":"solid","href":"/payouts/cashgram/integration/integration"},{"title":"Cashgram Integration","sidebarTitle":"Cashgram Integration","icon":null,"iconType":"solid","href":"/payouts/cashgram/integration/cashgram-integration"},{"title":"Customise Cashgram","sidebarTitle":"Customise Cashgram","icon":null,"iconType":"solid","href":"/payouts/cashgram/integration/customise-cashgram"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","iconType":"solid","href":"/payouts/cashgram/integration/webhooks"},{"title":"Data to Test Integration","sidebarTitle":"Data to Test Integration","icon":null,"iconType":"solid","href":"/payouts/cashgram/integration/data-to-test-integration"},{"title":"Go-Live Checklist","sidebarTitle":"Go-Live Checklist","icon":null,"iconType":"solid","href":"/payouts/cashgram/integration/go-live-checklist"}]},{"group":"Cashgram Classic Dashboard","pages":[{"title":"Create Cashgram","sidebarTitle":"Create Cashgram","icon":null,"iconType":"solid","href":"/payouts/cashgram/cashgram-classic-dashboard/create-cashgram"},{"title":"Create Bulk Cashgram","sidebarTitle":"Create Bulk Cashgram","icon":null,"iconType":"solid","href":"/payouts/cashgram/cashgram-classic-dashboard/create-bulk-cashgram"},{"title":"Approve Bulk Cashgram","sidebarTitle":"Approve Bulk Cashgram","icon":null,"iconType":"solid","href":"/payouts/cashgram/cashgram-classic-dashboard/approve-bulk-cashgram"},{"title":"Verify Beneficiary Name","sidebarTitle":"Verify Beneficiary Name","icon":null,"iconType":"solid","href":"/payouts/cashgram/cashgram-classic-dashboard/verify-beneficiary-name"}]},{"title":"Payouts: Cashgram FAQs","sidebarTitle":"Cashgram FAQs","href":"/payouts/cashgram/cashgram-faq"}]},{"group":"Payout Protect","pages":[{"title":"Payout Protect","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/payouts/payout-protect/payout-protect"},{"title":"Getting Started","sidebarTitle":"Getting Started","icon":null,"iconType":"solid","href":"/payouts/payout-protect/overview"},{"group":"Risky Transfers","pages":[{"title":"Flagged Transfers","sidebarTitle":"Flagged Transfers","icon":null,"iconType":"solid","href":"/payouts/payout-protect/flagged-transfer"},{"title":"Blocked Transfers","sidebarTitle":"Blocked Transfers","icon":null,"iconType":"solid","href":"/payouts/payout-protect/blocked-transfers"}]},{"title":"My Blacklists","sidebarTitle":"My Blacklists","icon":null,"iconType":"solid","href":"/payouts/payout-protect/my-blacklists"},{"title":"Smart Rules","sidebarTitle":"Smart Rules","icon":null,"iconType":"solid","href":"/payouts/payout-protect/smartlimits"}]},{"group":"Change Log","pages":[{"title":"Payouts Change Log","sidebarTitle":"Payouts Change Log","icon":null,"iconType":"solid","href":"/payouts/payouts/change-log-payouts"}]}]},{"tab":"Secure ID","groups":[{"group":"Secure ID","pages":[{"title":"Introduction","sidebarTitle":"Introduction","icon":null,"iconType":"solid","href":"/secure-id/introduction"},{"title":"Dashboard","sidebarTitle":"Dashboard","href":"/secure-id/dashboard"},{"group":"Get Started","pages":[{"title":"Wallet Recharge and Bank Accounts Whitelisting","sidebarTitle":"Wallet Recharge and Bank Accounts Whitelisting","icon":null,"iconType":"solid","href":"/secure-id/get-started/wallet-recharge"},{"group":"Integration Guide","pages":[{"title":"IP Whitelisting","sidebarTitle":"IP Whitelisting","href":"/secure-id/get-started/integration/ip-whitelisting-verification"},{"title":"Sample Responses From Bank","sidebarTitle":"Sample Responses From Bank","icon":null,"iconType":"solid","href":"/secure-id/get-started/integration/sample-responses-from-bank"},{"title":"Go-Live Checklist","sidebarTitle":"Go-Live Checklist","icon":null,"iconType":"solid","href":"/secure-id/get-started/integration/go-live-checklist"}]}]},{"group":"KYC Stack","pages":[{"title":"KYC Stack","sidebarTitle":"Overview","iconType":"solid","href":"/secure-id/kyc-stack/overview"},{"title":"Bank Account Verification","sidebarTitle":"Bank Account Verification","icon":null,"iconType":"solid","href":"/secure-id/kyc-stack/verify-bank-account"},{"title":"Reverse Penny Drop","sidebarTitle":"Reverse Penny Drop","iconType":"solid","href":"/secure-id/kyc-stack/reverse-penny-drop"},{"title":"IFSC","sidebarTitle":"IFSC","icon":null,"iconType":"solid","href":"/secure-id/kyc-stack/verify-ifsc"},{"title":"Verify PAN (Standard and OCR)","sidebarTitle":"Verify PAN","icon":null,"iconType":"solid","href":"/secure-id/kyc-stack/verify-pan"},{"title":"Aadhaar Verification","sidebarTitle":"Aadhaar Verification","icon":null,"iconType":"solid","href":"/secure-id/kyc-stack/verify-aadhaar"},{"title":"KYC Links","sidebarTitle":"KYC Links","icon":null,"iconType":"solid","href":"/secure-id/kyc-stack/kyc-links"}]},{"group":"Know Your Business","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/secure-id/know-your-business/overview"},{"title":"Verify GSTIN","sidebarTitle":"Verify GSTIN","icon":null,"iconType":null,"href":"/secure-id/know-your-business/verify-gstin"}]},{"group":"Video KYC","pages":[{"title":"Video KYC Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/secure-id/video-kyc/overview"},{"group":"Merchant Journey","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/secure-id/video-kyc/merchant-journey"},{"title":"Add an Agent or Auditor","sidebarTitle":"Add an Agent or Auditor","icon":null,"iconType":"solid","href":"/secure-id/video-kyc/add-agent-auditor"},{"title":"Generate Reports","sidebarTitle":"Generate Reports","icon":null,"iconType":"solid","href":"/secure-id/video-kyc/generate-reports"},{"title":"Manage Agents and Auditors","sidebarTitle":"Manage Agents and Auditors","icon":null,"iconType":"solid","href":"/secure-id/video-kyc/manage-agents"}]},{"title":"Agent Journey","sidebarTitle":"Agent Journey","icon":null,"iconType":"solid","href":"/secure-id/video-kyc/agent-journey"},{"title":"Auditor Journey","sidebarTitle":"Auditor Journey","icon":null,"iconType":"solid","href":"/secure-id/video-kyc/auditor-journey"},{"title":"End User Journey","sidebarTitle":"End User Journey","icon":null,"iconType":"solid","href":"/secure-id/video-kyc/user-journey"},{"title":"Video KYC FAQs","sidebarTitle":"FAQs","href":"/secure-id/video-kyc/vkyc-faqs"}]},{"group":"DigiLocker/Aadhaar","pages":[{"title":"DigiLocker Overview","sidebarTitle":"DigiLocker","icon":null,"iconType":null,"href":"/secure-id/digilocker/digilocker"},{"title":"DigiLocker FAQs","sidebarTitle":"FAQs","href":"/secure-id/digilocker/digilocker-faqs"},{"title":"Aadhaar Masking","sidebarTitle":"Aadhaar Masking","icon":null,"iconType":"solid","href":"/secure-id/digilocker/aadhaar-masking"}]},{"group":"1-Click Onboarding","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/secure-id/1-click-onboarding/overview"},{"title":"Creating Template","sidebarTitle":"Creating Template","icon":null,"iconType":"solid","href":"/secure-id/1-click-onboarding/creating-template"},{"title":"Mobile 360","sidebarTitle":"Mobile 360","href":"/secure-id/1-click-onboarding/mobile360/mobile-360"},{"title":"Advanced Employment","sidebarTitle":"Advanced Employment","icon":null,"iconType":"solid","href":"/secure-id/1-click-onboarding/advance-employment"}]},{"group":"Smart OCR","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/secure-id/smart-ocr/overview"},{"title":"FAQs","sidebarTitle":"FAQs","href":"/secure-id/smart-ocr/faqs"}]},{"group":"Officially Valid Documents","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/secure-id/ovd/overview"},{"title":"Voter ID Verification","sidebarTitle":"Voter ID Verification","icon":null,"iconType":null,"href":"/secure-id/ovd/voter-id"},{"title":"Driving Licence Verification","sidebarTitle":"Driving Licence Verification","icon":null,"iconType":null,"href":"/secure-id/ovd/driving-licence"},{"title":"Passport Verification","sidebarTitle":"Passport Verification","icon":null,"iconType":null,"href":"/secure-id/ovd/passport"},{"title":"Vehicle RC Verification","sidebarTitle":"Vehicle RC Verification","icon":null,"iconType":null,"href":"/secure-id/ovd/vehicle-rc"}]},{"title":"E-Sign","sidebarTitle":"E-Sign","icon":null,"iconType":null,"href":"/secure-id/e-sign/e-sign"},{"group":"Biometric KYC","pages":[{"title":"Biometric KYC Overview","sidebarTitle":"Overview","iconType":"solid","href":"/secure-id/biometric-kyc/overview"},{"title":"Face Match","sidebarTitle":"Face Match","icon":null,"iconType":"solid","href":"/secure-id/biometric-kyc/face-match"},{"title":"Name Match","sidebarTitle":"Name Match","href":"/secure-id/biometric-kyc/name-match"},{"title":"Face Liveness","sidebarTitle":"Face Liveness","icon":null,"iconType":"solid","href":"/secure-id/biometric-kyc/face-liveness"}]},{"group":"Address Verification","pages":[{"title":"Address Verification","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/secure-id/address-verification/overview"},{"title":"Reverse Geocoding","sidebarTitle":"Reverse Geocoding","icon":null,"iconType":"solid","href":"/secure-id/address-verification/reverse-geocoding"},{"title":"Geocoding","sidebarTitle":"Geocoding","icon":null,"iconType":"solid","href":"/secure-id/address-verification/geocoding"}]},{"group":"Reports","pages":[{"title":"Bank Validation","sidebarTitle":"Bank Validation","icon":null,"iconType":"solid","href":"/secure-id/reports/bank-validation-report"},{"title":"PAN Verification","sidebarTitle":"PAN Verification","icon":null,"iconType":"solid","href":"/secure-id/reports/pan-verification-report"},{"title":"Aadhaar Verification","sidebarTitle":"Aadhaar Verification","icon":null,"iconType":"solid","href":"/secure-id/reports/aadhaar-verification-report"},{"title":"GSTIN Verification","sidebarTitle":"GSTIN Verification","icon":null,"iconType":"solid","href":"/secure-id/reports/gstin-verification-report"}]}]}]},{"tab":"Partners and Platforms","groups":[{"group":"Partners and Platforms","pages":[{"title":"Introduction","sidebarTitle":"Introduction","icon":null,"iconType":"solid","href":"/partners/introduction"}]},{"group":"Embedded Payments","pages":[{"title":"Embedded Payments Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/partners/embedded/overview"},{"title":"Get Started with Embedded Payments","sidebarTitle":"Get Started","icon":null,"iconType":"solid","href":"/partners/embedded/get-started"},{"title":"Adding Merchants with Embedded Payments","sidebarTitle":"Adding Merchants","href":"/partners/embedded/add-merchants"},{"group":"Integration","pages":[{"title":"Embedded Payment Gateway Integration","sidebarTitle":"Gateway Integration","href":"/partners/embedded/integration/gateway-integration"},{"title":"Sandbox Environment for Embedded Payments Partners","sidebarTitle":"Sandbox Environment","href":"/partners/embedded/integration/gateway-sandbox-environment"},{"title":"Partner Platform OAuth Integration","sidebarTitle":"OAuth Integration","href":"/partners/embedded/oauth-flow"},{"title":"Embedded Merchant Onboarding for Platforms","sidebarTitle":"Embedded Merchant Onboarding","href":"/partners/embedded/embedded-merchant-onboarding"}]},{"title":"Embedded Payments Dashboard","sidebarTitle":"Dashboard","icon":null,"iconType":"solid","href":"/partners/embedded/dashboard"},{"title":"Commissions and Invoices","sidebarTitle":"Commissions and Invoices","icon":null,"iconType":"solid","href":"/partners/embedded/commissions-and-invoices"},{"group":"Embedded Payments Reports","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/partners/embedded/reports/reports"},{"title":"Transactions Report","sidebarTitle":"Transactions Report","icon":null,"iconType":"solid","href":"/partners/embedded/reports/transaction-reports"},{"title":"Settlement Reports","sidebarTitle":"Settlement Reports","icon":null,"iconType":"solid","href":"/partners/embedded/reports/settlement-reports"},{"title":"Refunds Report","sidebarTitle":"Refunds Report","icon":null,"iconType":"solid","href":"/partners/embedded/reports/refunds-reports"},{"title":"Dispute Report","sidebarTitle":"Dispute Report","icon":null,"iconType":"solid","href":"/partners/embedded/reports/dispute-reports"},{"title":"Ledger Report","sidebarTitle":"Ledger Report","icon":null,"iconType":"solid","href":"/partners/embedded/reports/ledger-reports"},{"title":"Settlement Recon Report","sidebarTitle":"Settlement Recon Report","icon":null,"iconType":"solid","href":"/partners/embedded/reports/settlement-recon-reports"}]}]},{"group":"Affiliate Program","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":null,"iconType":"solid","href":"/partners/affiliates/overview"},{"title":"Get Started as Affiliate Partner","sidebarTitle":"Get Started","icon":null,"iconType":"solid","href":"/partners/affiliates/become-cashfree-affiliate"},{"group":"Refer and Assist Merchants","pages":[{"title":"Refer and Onboard Merchants","sidebarTitle":"Refer Merchants","href":"/partners/affiliates/refer-merchants"},{"title":"Merchants KYC","sidebarTitle":"Merchants KYC","href":"/partners/affiliates/assist-merchant/merchants-kyc"},{"title":"Merchants Integration","sidebarTitle":"Merchants Integration","href":"/partners/affiliates/assist-merchant/merchants-integration"}]},{"title":"Partner Earnings Guide","sidebarTitle":"Partner Earnings Guide","icon":null,"iconType":"solid","href":"/partners/affiliates/partner-commissions-and-invoices"},{"title":"Marketing Kit","sidebarTitle":"Marketing Kit","icon":null,"iconType":"solid","href":"/partners/affiliates/marketing-kit"},{"title":"Affiliate Partner Dashboard","sidebarTitle":"Affiliate Partner Dashboard","href":"/partners/affiliates/dashboard"},{"title":"FAQs","sidebarTitle":"FAQs","href":"/partners/affiliates/faqs"}]}]},{"tab":"Payments APIs","hidden":true,"groups":[{"group":"Payments API","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/overview"},{"title":"Payment SDK","sidebarTitle":"Payment SDK","href":"/api-reference/payments/sdk"},{"title":"Rate Limits","sidebarTitle":"Rate Limits","href":"/api-reference/payments/rate-limits"},{"group":"Webhooks","pages":[{"title":"Webhook Overview","sidebarTitle":"Overview","icon":"webhook","href":"/api-reference/payments/latest/webhooks/overview"},{"title":"Webhook Configuration","sidebarTitle":"Webhook Configuration","icon":"webhook","href":"/api-reference/payments/latest/webhooks/configure"},{"title":"Webhook Signature Verification","sidebarTitle":"Signature Verification","icon":"webhook","href":"/api-reference/payments/latest/webhooks/signature-verification"},{"title":"Webhook Security Checklist","sidebarTitle":"Security Checklist","icon":"webhook","href":"/api-reference/payments/latest/webhooks/security-checklist"},{"title":"Webhook Idempotency","sidebarTitle":"Webhook Idempotency","icon":"webhook","href":"/api-reference/payments/latest/webhooks/idempotency"},{"title":"Webhook Troubleshooting","sidebarTitle":"Webhook Troubleshooting","icon":"webhook","href":"/api-reference/payments/latest/webhooks/troubleshooting"}]},{"title":"Enums Reference","sidebarTitle":"Enums","href":"/api-reference/payments/enums"},{"title":"Errors","sidebarTitle":"Errors","href":"/api-reference/payments/errors"},{"title":"Data to Test Integration","sidebarTitle":"Data to Test Integration","href":"/api-reference/payments/data-to-test-integration"}]},{"group":"v2026-01-01","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/latest/overview"},{"group":"Orders","pages":[{"title":"Create Order","sidebarTitle":"Create Order","openapi":"openapi/payments/v2026-01-01.yaml post /orders","href":"/api-reference/payments/latest/orders/create-order"},{"title":"Get Order","sidebarTitle":"Get Order","openapi":"openapi/payments/v2026-01-01.yaml get /orders/{order_id}","href":"/api-reference/payments/latest/orders/get-order"},{"title":"Terminate Order","sidebarTitle":"Terminate Order","openapi":"openapi/payments/v2026-01-01.yaml patch /orders/{order_id}","href":"/api-reference/payments/latest/orders/terminate-order"},{"title":"Get Order Extended","sidebarTitle":"Get Order Extended","openapi":"openapi/payments/v2026-01-01.yaml get /orders/{order_id}/extended","href":"/api-reference/payments/latest/orders/get-order-extended"},{"title":"Update Order Extended","sidebarTitle":"Update Order Extended","openapi":"openapi/payments/v2026-01-01.yaml put /orders/{order_id}/extended","href":"/api-reference/payments/latest/orders/update-order-extended"}]},{"group":"Payments","pages":[{"title":"Order Pay","sidebarTitle":"Order Pay","openapi":"openapi/payments/v2026-01-01.yaml post /orders/sessions","href":"/api-reference/payments/latest/payments/order-pay"},{"title":"Submit or Resend OTP","sidebarTitle":"Submit or Resend OTP","openapi":"openapi/payments/v2026-01-01.yaml post /orders/pay/authenticate/{cf_payment_id}","href":"/api-reference/payments/latest/payments/submit-or-resend-otp"},{"title":"Preauthorisation","sidebarTitle":"Preauthorisation","openapi":"openapi/payments/v2026-01-01.yaml post /orders/{order_id}/authorization","href":"/api-reference/payments/latest/payments/preauthorisation"},{"title":"Get Payments for an Order","sidebarTitle":"Get Payments for an Order","openapi":"openapi/payments/v2026-01-01.yaml get /orders/{order_id}/payments","href":"/api-reference/payments/latest/payments/get-payments-for-an-order"},{"title":"Get Payment by ID","sidebarTitle":"Get Payment by ID","openapi":"openapi/payments/v2026-01-01.yaml get /orders/{order_id}/payments/{cf_payment_id}","href":"/api-reference/payments/latest/payments/get-payment-by-id"},{"title":"Order Pay Authorise Only","sidebarTitle":"Order Pay Authorise Only","openapi":"openapi/payments/v2026-01-01.yaml post /orders/sessions/authorize","href":"/api-reference/payments/latest/payments/order-pay-authorise-only"},{"title":"Payment Webhooks","sidebarTitle":"Payment Webhooks","icon":"webhook","href":"/api-reference/payments/latest/payments/webhooks"}]},{"group":"Payment Links","pages":[{"title":"Create Payment Link","sidebarTitle":"Create Payment Link","openapi":"openapi/payments/v2026-01-01.yaml post /links","href":"/api-reference/payments/latest/payment-links/create-payment-link"},{"title":"Fetch Payment Link Details","sidebarTitle":"Fetch Payment Link Details","openapi":"openapi/payments/v2026-01-01.yaml get /links/{link_id}","href":"/api-reference/payments/latest/payment-links/fetch-payment-link-details"},{"title":"Cancel Payment Link","sidebarTitle":"Cancel Payment Link","openapi":"openapi/payments/v2026-01-01.yaml post /links/{link_id}/cancel","href":"/api-reference/payments/latest/payment-links/cancel-payment-link"},{"title":"Get Orders for a Payment Link","sidebarTitle":"Get Orders for a Payment Link","openapi":"openapi/payments/v2026-01-01.yaml get /links/{link_id}/orders","href":"/api-reference/payments/latest/payment-links/get-orders-for-a-payment-link"},{"title":"Payment Link Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/latest/payment-links/webhooks"}]},{"group":"Refunds","pages":[{"title":"Create Refund","sidebarTitle":"Create Refund","openapi":"openapi/payments/v2026-01-01.yaml post /orders/{order_id}/refunds","href":"/api-reference/payments/latest/refunds/create-refund"},{"title":"Get Refund","sidebarTitle":"Get Refund","openapi":"openapi/payments/v2026-01-01.yaml get /orders/{order_id}/refunds/{refund_id}","href":"/api-reference/payments/latest/refunds/get-refund"},{"title":"Get All Refunds for an Order","sidebarTitle":"Get All Refunds for an Order","openapi":"openapi/payments/v2026-01-01.yaml get /orders/{order_id}/refunds","href":"/api-reference/payments/latest/refunds/get-all-refunds-for-an-order"},{"title":"Update Refund","sidebarTitle":"Update Refund","openapi":"openapi/payments/v2026-01-01.yaml put /orders/{order_id}/refunds/{refund_id}","href":"/api-reference/payments/latest/refunds/update-refund"},{"title":"Refund Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/latest/refunds/webhooks"}]},{"group":"Customers","pages":[{"title":"Create Customer at Cashfree","sidebarTitle":"Create Customer at Cashfree","openapi":"openapi/payments/v2026-01-01.yaml post /customers","href":"/api-reference/payments/latest/customers/create-customer-at-cashfree"}]},{"group":"Easy-Split","pages":[{"title":"Easy Split Overview","sidebarTitle":"Easy Split Overview","href":"/api-reference/payments/latest/split/easy-split-overview"},{"title":"Easy Split - Postman Collection","sidebarTitle":"Easy Split - Postman Collection","href":"/api-reference/payments/latest/split/easy-split-postman-collection"},{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/latest/split/end-points"},{"group":"Vendors","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/latest/split/vendors/overview"},{"title":"Create Vendor","sidebarTitle":"Create Vendor","openapi":"openapi/payments/v2026-01-01.yaml post /easy-split/vendors","href":"/api-reference/payments/latest/easy-split/create-vendor"},{"title":"Get Vendor All Details","sidebarTitle":"Get Vendor All Details","openapi":"openapi/payments/v2026-01-01.yaml get /easy-split/vendors/{vendor_id}","href":"/api-reference/payments/latest/easy-split/get-vendor-all-details"},{"title":"Update Vendor Details","sidebarTitle":"Update Vendor Details","openapi":"openapi/payments/v2026-01-01.yaml patch /easy-split/vendors/{vendor_id}","href":"/api-reference/payments/latest/easy-split/update-vendor-details"},{"title":"Get Vendor All Documents Status","sidebarTitle":"Get Vendor All Documents Status","openapi":"openapi/payments/v2026-01-01.yaml get /easy-split/vendor-docs/{vendor_id}","href":"/api-reference/payments/latest/easy-split/get-vendor-all-documents-status"},{"title":"Upload Vendor Docs","sidebarTitle":"Upload Vendor Docs","openapi":"openapi/payments/v2026-01-01.yaml post /easy-split/vendor-docs/{vendor_id}","href":"/api-reference/payments/latest/easy-split/upload-vendor-docs"},{"title":"Download Vendor Documents","sidebarTitle":"Download Vendor Documents","openapi":"openapi/payments/v2026-01-01.yaml get /easy-split/vendor-docs/{vendor_id}/download/{doc_type}","href":"/api-reference/payments/latest/easy-split/download-vendor-documents"},{"title":"Get On Demand Balance","sidebarTitle":"Get On Demand Balance","openapi":"openapi/payments/v2026-01-01.yaml get /easy-split/vendors/{vendor_id}/balances","href":"/api-reference/payments/latest/easy-split/get-on-demand-balance"}]},{"group":"Configuration","pages":[{"title":"Create Static Split Configuration","sidebarTitle":"Create Static Split","openapi":"openapi/payments/v2026-01-01.yaml post /easy-split/static-split","href":"/api-reference/payments/latest/easy-split/create-static-split-configuration"},{"title":"Split After Payment","sidebarTitle":"Split After Payment","openapi":"openapi/payments/v2026-01-01.yaml post /easy-split/orders/{order_id}/split","href":"/api-reference/payments/latest/easy-split/split-after-payment"},{"title":"Create Adjustment","sidebarTitle":"Create Adjustment","openapi":"openapi/payments/v2026-01-01.yaml post /easy-split/vendors/{vendor_id}/adjustment","href":"/api-reference/payments/latest/easy-split/create-adjustment"}]},{"group":"Settlements","pages":[{"title":"Create On Demand Transfer","sidebarTitle":"Create On Demand Transfer","openapi":"openapi/payments/v2026-01-01.yaml post /easy-split/vendors/{vendor_id}/transfer","href":"/api-reference/payments/latest/easy-split/create-on-demand-transfer"},{"title":"Get Split and Settlement Details by OrderID","sidebarTitle":"Get Split Details by Order","openapi":"openapi/payments/v2026-01-01.yaml get /easy-split/orders/{order_id}","href":"/api-reference/payments/latest/easy-split/get-split-and-settlement-details-by-orderid"},{"title":"Get Split and Settlement Details by OrderID v2.0","sidebarTitle":"Get Split Details v2.0","openapi":"openapi/payments/v2026-01-01.yaml post /split/order/vendor/recon","href":"/api-reference/payments/latest/easy-split/get-split-and-settlement-details-by-orderid-v20"}]},{"group":"Billing","pages":[{"title":"Get Vendor Balance Transfer Charges","sidebarTitle":"Get Balance Transfer Charges","openapi":"openapi/payments/v2026-01-01.yaml get /easy-split/amount/{amount}/charges","href":"/api-reference/payments/latest/easy-split/get-vendor-balance-transfer-charges"}]},{"group":"Webhooks","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/latest/split/webhooks/overview"},{"title":"Vendor Settlement Webhook","sidebarTitle":"Vendor Settlement Webhook","href":"/api-reference/payments/latest/split/webhooks/vendor-settlement-webhooks"},{"title":"Vendor Status Change Webhook","sidebarTitle":"Vendor Status Change Webhook","href":"/api-reference/payments/latest/split/webhooks/vendor-status-change-webhooks"}]},{"group":"Reconciliation","pages":[{"title":"Vendor Reconciliation API","sidebarTitle":"Vendor Reconciliation API","openapi":"openapi/payments/v2026-01-01.yaml post /recon/vendor","href":"/api-reference/payments/latest/reconciliation/vendor-reconciliation-api"}]}]},{"group":"Payment Methods","pages":[{"title":"Get Eligible Cardless EMI Payment Methods for a customer on an order","sidebarTitle":"Get Eligible Cardless EMI","openapi":"openapi/payments/v2026-01-01.yaml post /eligibility/cardlessemi","href":"/api-reference/payments/latest/eligibility/get-eligible-cardless-emi-payment-methods-for-a-customer-on-an-order"},{"title":"Get Eligible Paylater for a customer on an order","sidebarTitle":"Get Eligible Paylater","openapi":"openapi/payments/v2026-01-01.yaml post /eligibility/paylater","href":"/api-reference/payments/latest/eligibility/get-eligible-paylater-for-a-customer-on-an-order"},{"title":"Get Eligible Payment Methods for Orders","sidebarTitle":"Get Eligible Payment Methods","icon":"","openapi":"openapi/payments/v2026-01-01.yaml post /eligibility/payment_methods","href":"/api-reference/payments/latest/eligibility/get-eligible-payment-methods"}]},{"group":"Offers","pages":[{"title":"Create Offer","sidebarTitle":"Create Offer","openapi":"openapi/payments/v2026-01-01.yaml post /offers","href":"/api-reference/payments/latest/offers/create-offer"},{"title":"Get Offer by ID","sidebarTitle":"Get Offer by ID","openapi":"openapi/payments/v2026-01-01.yaml get /offers/{offer_id}","href":"/api-reference/payments/latest/offers/get-offer-by-id"},{"title":"Get Eligible Offers for an Order","sidebarTitle":"Get Eligible Offers for an Order","openapi":"openapi/payments/v2026-01-01.yaml post /eligibility/offers","href":"/api-reference/payments/latest/eligibility/get-eligible-offers-for-an-order"}]},{"group":"Token Vault","pages":[{"title":"Fetch Cryptogram for a Saved Card Instrument","sidebarTitle":"Fetch Cryptogram","openapi":"openapi/payments/v2026-01-01.yaml get /customers/{customer_id}/instruments/{instrument_id}/cryptogram","href":"/api-reference/payments/latest/token-vault/fetch-cryptogram-for-a-saved-card-instrument"},{"title":"Fetch All Saved Card Instrument","sidebarTitle":"Fetch All Saved Card Instrument","openapi":"openapi/payments/v2026-01-01.yaml get /customers/{customer_id}/instruments?instrument_type=card","href":"/api-reference/payments/latest/token-vault/fetch-all-saved-card-instrument"},{"title":"Fetch Specific Saved Card Instrument","sidebarTitle":"Fetch Specific Saved Card Instrument","openapi":"openapi/payments/v2026-01-01.yaml get /customers/{customer_id}/instruments/{instrument_id}","href":"/api-reference/payments/latest/token-vault/fetch-specific-saved-card-instrument"},{"title":"Delete Saved Card Instrument","sidebarTitle":"Delete Saved Card Instrument","openapi":"openapi/payments/v2026-01-01.yaml delete /customers/{customer_id}/instruments/{instrument_id}","href":"/api-reference/payments/latest/token-vault/delete-saved-card-instrument"},{"title":"Card Token Webhook","sidebarTitle":"Webhook","icon":"webhook","href":"/api-reference/payments/latest/token-vault/webhooks"}]},{"group":"Disputes","pages":[{"title":"Get Disputes by Order ID","sidebarTitle":"Get Disputes by Order ID","openapi":"openapi/payments/v2026-01-01.yaml get /orders/{order_id}/disputes","href":"/api-reference/payments/latest/disputes/get-disputes-by-order-id"},{"title":"Get Disputes by Payment ID","sidebarTitle":"Get Disputes by Payment ID","openapi":"openapi/payments/v2026-01-01.yaml get /payments/{cf_payment_id}/disputes","href":"/api-reference/payments/latest/disputes/get-disputes-by-payment-id"},{"title":"Get Disputes by Dispute ID","sidebarTitle":"Get Disputes by Dispute ID","openapi":"openapi/payments/v2026-01-01.yaml get /disputes/{dispute_id}","href":"/api-reference/payments/latest/disputes/get-disputes-by-dispute-id"},{"title":"Accept Dispute by Dispute ID","sidebarTitle":"Accept Dispute","openapi":"openapi/payments/v2026-01-01.yaml put /disputes/{dispute_id}/accept","href":"/api-reference/payments/latest/disputes/accept-dispute-by-dispute-id"},{"title":"Submit Evidence to contest the Dispute by Dispute ID","sidebarTitle":"Submit Dispute Evidence","openapi":"openapi/payments/v2026-01-01.yaml post /disputes/{dispute_id}/documents","href":"/api-reference/payments/latest/disputes/submit-evidence-to-contest-the-dispute-by-dispute-id"},{"title":"Contest Arbitration by Dispute ID","sidebarTitle":"Contest Arbitration","openapi":"openapi/payments/v2026-01-01.yaml put /disputes/{dispute_id}/contest-arbitration","href":"/api-reference/payments/latest/disputes/contest-arbitration-by-dispute-id"},{"title":"Dispute Webhooks","sidebarTitle":"Dispute Webhooks","icon":"webhook","href":"/api-reference/payments/latest/disputes/dispute-webhooks"}]},{"group":"Settlements","pages":[{"title":"Get Settlements by Order ID","sidebarTitle":"Get Settlements by Order ID","openapi":"openapi/payments/v2026-01-01.yaml get /orders/{order_id}/settlements","href":"/api-reference/payments/latest/settlements/get-settlements-by-order-id"},{"title":"Mark Order For Settlement","sidebarTitle":"Mark Order For Settlement","openapi":"openapi/payments/v2026-01-01.yaml post /orders/settlements","href":"/api-reference/payments/latest/settlements/mark-order-for-settlement"},{"title":"PG Reconciliation","sidebarTitle":"PG Reconciliation","openapi":"openapi/payments/v2026-01-01.yaml post /recon","href":"/api-reference/payments/latest/pg-reconciliation/pg-reconciliation"},{"title":"Settlement Reconciliation","sidebarTitle":"Settlement Reconciliation","openapi":"openapi/payments/v2026-01-01.yaml post /settlement/recon","href":"/api-reference/payments/latest/settlement-reconciliation/settlement-reconciliation"},{"title":"Get All Settlements","sidebarTitle":"Get All Settlements","openapi":"openapi/payments/v2026-01-01.yaml post /settlements","href":"/api-reference/payments/latest/settlement-reconciliation/get-all-settlements"},{"title":"Settlement Webhooks","sidebarTitle":"Settlement Webhooks","icon":"webhook","href":"/api-reference/payments/latest/settlements/settlement-webhooks"}]},{"group":"Offline Payments","pages":[{"title":"Create Terminal","sidebarTitle":"Create Terminal","openapi":"openapi/payments/v2026-01-01.yaml post /terminal","href":"/api-reference/payments/latest/offline-payments/create-terminal"},{"title":"Fetch Terminal QR Codes","sidebarTitle":"Fetch Terminal QR Codes","openapi":"openapi/payments/v2026-01-01.yaml get /terminal/qrcodes","href":"/api-reference/payments/latest/offline-payments/fetch-terminal-qr-codes"},{"title":"Create Terminal Transaction","sidebarTitle":"Create Terminal Transaction","openapi":"openapi/payments/v2026-01-01.yaml post /terminal/transactions","href":"/api-reference/payments/latest/offline-payments/create-terminal-transaction"},{"title":"Onboard Soundbox VPA","sidebarTitle":"Onboard Soundbox VPA","openapi":"openapi/payments/v2026-01-01.yaml post /terminal/soundbox","href":"/api-reference/payments/latest/offline-payments/onboard-soundbox-vpa"},{"title":"Update Soundbox VPA","sidebarTitle":"Update Soundbox VPA","openapi":"openapi/payments/v2026-01-01.yaml patch /terminal/{cf_terminal_id}/soundbox","href":"/api-reference/payments/latest/offline-payments/update-soundbox-vpa"},{"title":"Demap Soundbox VPA","sidebarTitle":"Demap Soundbox VPA","openapi":"openapi/payments/v2026-01-01.yaml post /terminal/demap/soundbox","href":"/api-reference/payments/latest/offline-payments/demap-soundbox-vpa"},{"title":"Fetch Terminal Soundbox VPA","sidebarTitle":"Fetch Soundbox VPA","openapi":"openapi/payments/v2026-01-01.yaml get /terminal/soundbox/qrcodes","href":"/api-reference/payments/latest/offline-payments/fetch-terminal-soundbox-vpa"},{"title":"Get Terminal Transaction","sidebarTitle":"Get Terminal Transaction","openapi":"openapi/payments/v2026-01-01.yaml get /terminal/{cf_terminal_id}/payments","href":"/api-reference/payments/latest/offline-payments/get-terminal-transaction"},{"title":"Get list of terminal transactions","sidebarTitle":"Get list of terminal transactions","openapi":"openapi/payments/v2026-01-01.yaml post /terminal/payments","href":"/api-reference/payments/latest/offline-payments/get-list-of-terminal-transactions"},{"title":"Update Terminal","sidebarTitle":"Update Terminal","openapi":"openapi/payments/v2026-01-01.yaml patch /terminal/{cf_terminal_id}","href":"/api-reference/payments/latest/offline-payments/update-terminal"},{"title":"Update Terminal Status","sidebarTitle":"Update Terminal Status","openapi":"openapi/payments/v2026-01-01.yaml patch /terminal/{cf_terminal_id}/status","href":"/api-reference/payments/latest/offline-payments/update-terminal-status"},{"title":"Get Terminal Status using Phone Number","sidebarTitle":"Get Terminal Status using Phone Number","openapi":"openapi/payments/v2026-01-01.yaml get /terminal/{terminal_phone_no}","href":"/api-reference/payments/latest/offline-payments/get-terminal-status-using-phone-number"},{"title":"Upload Terminal Docs","sidebarTitle":"Upload Terminal Docs","openapi":"openapi/payments/v2026-01-01.yaml post /terminal/{cf_terminal_id}/docs","href":"/api-reference/payments/latest/offline-payments/upload-terminal-docs"},{"title":"Offline Payments Webhooks","sidebarTitle":"Offline Payments Webhooks","icon":"webhook","href":"/api-reference/payments/latest/offline-payments/softpos-webhooks"}]},{"title":"Preauthorisation","sidebarTitle":"Preauthorisation","href":"/api-reference/payments/preauth-journey"},{"group":"Simulation","pages":[{"title":"Simulate Payment","sidebarTitle":"Simulate Payment","openapi":"openapi/payments/v2026-01-01.yaml post /simulate","href":"/api-reference/payments/latest/simulation/simulate-payment"},{"title":"Fetch Simulation","sidebarTitle":"Fetch Simulation","openapi":"openapi/payments/v2026-01-01.yaml get /simulate/{simulation_id}","href":"/api-reference/payments/latest/simulation/fetch-simulation"},{"title":"Simulate Settlement Payment","sidebarTitle":"Simulate Settlement Payment","openapi":"openapi/payments/v2026-01-01.yaml post /simulate/settlement","href":"/api-reference/payments/latest/simulation/simulate-settlement-payment"},{"title":"Fetch Settlement Simulation","sidebarTitle":"Fetch Settlement Simulation","openapi":"openapi/payments/v2026-01-01.yaml get /simulate/settlement/{simulation_id}","href":"/api-reference/payments/latest/simulation/fetch-settlement-simulation"},{"title":"Simulate Vendor Settlement","sidebarTitle":"Vendor Settlement","openapi":"openapi/payments/v2026-01-01.yaml post /simulate/settlement/vendor","href":"/api-reference/payments/latest/simulation/simulate-vendor-settlement"},{"title":"Enable Easy Split","sidebarTitle":"Enable Easy Split","openapi":"openapi/payments/v2026-01-01.yaml post /simulate/easy-split/enable","href":"/api-reference/payments/latest/simulation/enable-easy-split-sandbox"},{"title":"Fetch Easy Split Status","sidebarTitle":"Easy Split Status","openapi":"openapi/payments/v2026-01-01.yaml get /simulate/easy-split/status","href":"/api-reference/payments/latest/simulation/fetch-easy-split-sandbox-status"}]},{"group":"Subscription","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/latest/subscription/overview"},{"title":"Postman Collection","sidebarTitle":"Postman Collection","href":"/api-reference/payments/latest/subscription/subscription-postman-collection"},{"title":"Error Codes and Reasons","sidebarTitle":"Error Codes and Reasons","href":"/api-reference/payments/latest/subscription/error-codes"},{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/latest/subscription/endpoints"},{"title":"Physical Mandates","sidebarTitle":"Physical Mandates","href":"/api-reference/payments/latest/subscription/physical-mandates"},{"group":"Plan","pages":[{"title":"Create a Plan","sidebarTitle":"Create a Plan","openapi":"openapi/payments/v2026-01-01.yaml post /plans","href":"/api-reference/payments/latest/subscription/create-a-plan"},{"title":"Fetch Plan","sidebarTitle":"Fetch Plan","openapi":"openapi/payments/v2026-01-01.yaml get /plans/{plan_id}","href":"/api-reference/payments/latest/subscription/fetch-plan"}]},{"group":"Mandate","pages":[{"title":"Create Subscription","sidebarTitle":"Create Subscription","openapi":"openapi/payments/v2026-01-01.yaml post /subscriptions","href":"/api-reference/payments/latest/subscription/create-subscription"},{"title":"Fetch Subscription","sidebarTitle":"Fetch Subscription","openapi":"openapi/payments/v2026-01-01.yaml get /subscriptions/{subscription_id}","href":"/api-reference/payments/latest/subscription/fetch-subscription"},{"title":"Manage Subscription","sidebarTitle":"Manage Subscription","openapi":"openapi/payments/v2026-01-01.yaml post /subscriptions/{subscription_id}/manage","href":"/api-reference/payments/latest/subscription/manage-subscription"},{"title":"Upload file for Physical Nach Authorisation","sidebarTitle":"Upload NACH File","openapi":"openapi/payments/v2026-01-01.yaml post /subscriptions/pay/documents/{payment_id}","href":"/api-reference/payments/latest/subscription/upload-file-for-physical-nach-authorisation"},{"title":"Get All the Payment Method Details Available for Subscription Payments","sidebarTitle":"Get Subscription Payment Methods","openapi":"openapi/payments/v2026-01-01.yaml post /subscriptions/eligibility/payment_methods","href":"/api-reference/payments/latest/subscription/get-all-the-payment-method-details-available-for-subscription-payments"},{"title":"Generate Transaction Return Summary","sidebarTitle":"Generate Return Summary","openapi":"openapi/payments/v2026-01-01.yaml post /subscriptions/charge/{payment_id}/transaction-return-summary/generate","href":"/api-reference/payments/latest/subscription/generate-transaction-return-summary"}]},{"group":"Payment","pages":[{"title":"Raise a Charge or Create an Auth","sidebarTitle":"Raise a Charge or Create an Auth","openapi":"openapi/payments/v2026-01-01.yaml post /subscriptions/pay","href":"/api-reference/payments/latest/subscription/raise-a-charge-or-create-an-auth"},{"title":"Fetch Details of All Payments of a Subscription","sidebarTitle":"Fetch Details of All Payments of a Subscription","openapi":"openapi/payments/v2026-01-01.yaml get /subscriptions/{subscription_id}/payments","href":"/api-reference/payments/latest/subscription/fetch-details-of-all-payments-of-a-subscription"},{"title":"Fetch Details of a Single Payment","sidebarTitle":"Fetch Details of a Single Payment","openapi":"openapi/payments/v2026-01-01.yaml get /subscriptions/{subscription_id}/payments/{payment_id}","href":"/api-reference/payments/latest/subscription/fetch-details-of-a-single-payment"},{"title":"Manage a Single Payment","sidebarTitle":"Manage a Single Payment","openapi":"openapi/payments/v2026-01-01.yaml post /subscriptions/{subscription_id}/payments/{payment_id}/manage","href":"/api-reference/payments/latest/subscription/manage-a-single-payment"},{"group":"Controlled Charging","pages":[{"title":"Controlled Subscription Payments","sidebarTitle":"Overview","href":"/api-reference/payments/latest/subscription/payment/controlled/overview"},{"openapi":"openapi/payments/v2026-01-01.yaml post /subscriptions/pay/controlled/notify-mandate","title":"Create Controlled Notification","href":"/api-reference/payments/latest/subscription/payment/controlled/create-controlled-notification"},{"openapi":"openapi/payments/v2026-01-01.yaml get /subscriptions/payments/{payment_id}/controlled/notifications/{notification_id}","title":"Fetch Controlled Notification","href":"/api-reference/payments/latest/subscription/payment/controlled/fetch-controlled-notification"},{"title":"Fetch All Controlled Notifications","sidebarTitle":"Fetch All Controlled Notifications","openapi":"openapi/payments/v2026-01-01.yaml get /subscriptions/payments/{payment_id}/controlled/notifications","href":"/api-reference/payments/latest/subscription/payment/controlled/fetch-controlled-notifications"},{"openapi":"openapi/payments/v2026-01-01.yaml post /subscriptions/pay/controlled/execute-mandate","title":"Create Controlled Execution","href":"/api-reference/payments/latest/subscription/payment/controlled/create-controlled-execution"},{"openapi":"openapi/payments/v2026-01-01.yaml get /subscriptions/payments/{payment_id}/controlled/executions/{execution_id}","title":"Fetch Controlled Execution","href":"/api-reference/payments/latest/subscription/payment/controlled/fetch-controlled-execution"},{"title":"Fetch All Controlled Executions","sidebarTitle":"Fetch All Controlled Executions","openapi":"openapi/payments/v2026-01-01.yaml get /subscriptions/payments/{payment_id}/controlled/executions","href":"/api-reference/payments/latest/subscription/payment/controlled/fetch-controlled-executions"}]}]},{"group":"Refund","pages":[{"title":"Refund APIs Overview","sidebarTitle":"Subscription Refund APIs","href":"/api-reference/payments/latest/subscription/refund/refund-apis-overview"},{"title":"Create a Refund","sidebarTitle":"Create a Refund","openapi":"openapi/payments/v2026-01-01.yaml post /subscriptions/{subscription_id}/refunds","href":"/api-reference/payments/latest/subscription/create-a-refund"},{"title":"Fetch Details of a Refund","sidebarTitle":"Fetch Details of a Refund","openapi":"openapi/payments/v2026-01-01.yaml get /subscriptions/{subscription_id}/refunds/{refund_id}","href":"/api-reference/payments/latest/subscription/fetch-details-of-a-refund"}]},{"title":"Redirection Payload After Authorisation","sidebarTitle":"Redirection Payload After Authorisation","href":"/api-reference/payments/latest/subscription/redirection-payload-after-authorization"},{"title":"Rate Limits","sidebarTitle":"Rate Limits","href":"/api-reference/payments/latest/subscription/rate-limits"},{"group":"Webhooks","pages":[{"title":"Events","sidebarTitle":"Events","icon":"webhook","href":"/api-reference/payments/latest/subscription/webhooks"},{"title":"Signature Verification","sidebarTitle":"Signature Verification","icon":"shield-check","href":"/api-reference/payments/latest/subscription/webhook-signature"}]}]},{"group":"VBA","pages":[{"group":"Manage VBA","pages":[{"title":"Create VBA","openapi":"openapi/pgvba/pgvba.yaml post /pg/vba","href":"/api-reference/payments/latest/pgvba/create-vba"},{"title":"Edit VBA","openapi":"openapi/pgvba/pgvba.yaml put /pg/vba/{virtual_account_id}","href":"/api-reference/payments/latest/pgvba/edit-vba"},{"title":"Manage VBA","openapi":"openapi/pgvba/pgvba.yaml patch /pg/vba/{virtual_account_id}","href":"/api-reference/payments/latest/pgvba/manage-vba"},{"title":"Get VBA","openapi":"openapi/pgvba/pgvba.yaml get /pg/vba/{virtual_account_id}","href":"/api-reference/payments/latest/pgvba/get-vba"}]},{"group":"Payments","pages":[{"title":"Get VBA Payments","openapi":"openapi/pgvba/pgvba.yaml post /pg/vba/payments","href":"/api-reference/payments/latest/pgvba/get-vba-payments"},{"title":"Get VBA Payments By UTR","openapi":"openapi/pgvba/pgvba.yaml get /pg/vba/payments/{utr}","href":"/api-reference/payments/latest/pgvba/get-vba-payments-by-utr"}]},{"group":"Notification Group","pages":[{"title":"Create VBA Notification Group","openapi":"openapi/pgvba/pgvba.yaml post /pg/vba/notificationgroup","href":"/api-reference/payments/latest/pgvba/create-vba-notification-group"},{"title":"Edit VBA Notification Group","openapi":"openapi/pgvba/pgvba.yaml put /pg/vba/notificationgroup/{notification_group_name}","href":"/api-reference/payments/latest/pgvba/edit-vba-notification-group"},{"title":"Manage VBA Notification Group Status","openapi":"openapi/pgvba/pgvba.yaml patch /pg/vba/notificationgroup/{notification_group_name}","href":"/api-reference/payments/latest/pgvba/manage-vba-notification-group-status"},{"title":"Get VBA Notification Group","openapi":"openapi/pgvba/pgvba.yaml get /pg/vba/notificationgroup/{notification_group_name}","href":"/api-reference/payments/latest/pgvba/get-vba-notification-group"}]}]},{"group":"International Payments","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/latest/international-payments/overview"},{"group":"Collect from India","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/latest/international-payments/collect-from-india/overview"},{"openapi":"openapi/cb-imports/v2025-01-01.yaml post /import/transactions/{cf_payment_id}","title":"Upload Payment Verification Details","sidebarTitle":"Upload Payment Verification Details","href":"/api-reference/payments/latest/international-payments/collect-from-india/upload-payment-verification-details"},{"openapi":"get /import/transactions/{cf_payment_id}","title":"Get Payment Verification Details","sidebarTitle":"Get Payment Verification Details","href":"/api-reference/payments/latest/international-payments/collect-from-india/get-payment-verification-details"},{"openapi":"openapi/cb-imports/v2026-01-01.yaml get /import/orders/{order_id}/settlements","title":"Get Import Settlement Details for an Order","href":"/api-reference/payments/latest/international-payments/collect-from-india/get-import-settlement-details"},{"openapi":"openapi/cb-imports/v2026-01-01.yaml post /import/settlements/recon","title":"Get Import Settlement Recon Details","href":"/api-reference/payments/latest/international-payments/collect-from-india/get-import-settlement-recon-details"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/latest/international-payments/collect-from-india/import-webhooks"},{"group":"Sandbox Simulation","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/latest/international-payments/collect-from-india/sandbox-simulation"},{"openapi":"post /import/settlements/emulate","title":"Trigger Sandbox Settlement","href":"/api-reference/payments/latest/international-payments/collect-from-india/trigger-sandbox-settlement"},{"openapi":"put /import/settlements/emulate","title":"Mark Sandbox Settlement Processed","href":"/api-reference/payments/latest/international-payments/collect-from-india/mark-sandbox-settlement-processed"}]}]},{"group":"Collect from the World","pages":[{"group":"Global Collections","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/latest/international-payments/global-collections/overview"},{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/latest/international-payments/global-collections/endpoints"},{"title":"Purpose Codes","sidebarTitle":"Purpose Codes","href":"/api-reference/payments/latest/international-payments/global-collections/purpose-codes"},{"group":"Authorization","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/latest/international-payments/global-collections/partner/auth-overview"},{"title":"Get Auth Token","openapi":"post /gc/authorize","href":"/api-reference/payments/latest/international-payments/global-collections/partner/auth-get-token"},{"title":"Verify Auth Token","openapi":"get /gc/token/verify","href":"/api-reference/payments/latest/international-payments/global-collections/partner/auth-verify-token"}]},{"title":"Get Collection Accounts","openapi":"get /gc/virtual-accounts","href":"/api-reference/payments/latest/international-payments/global-collections/partner/get-collection-accounts"},{"title":"Get Transactions","openapi":"get /gc/transactions","href":"/api-reference/payments/latest/international-payments/global-collections/partner/get-transactions"},{"title":"Add Transaction Details","openapi":"post /gc/transactions/{referenceId}/invoice-details","href":"/api-reference/payments/latest/international-payments/global-collections/partner/add-transaction-details"},{"title":"Simulate Transaction","openapi":"post /gc/transactions/emulate","href":"/api-reference/payments/latest/international-payments/global-collections/partner/simulate-transaction"},{"title":"Webhook - Partner","sidebarTitle":"Webhook - Partner","icon":"webhook","href":"/api-reference/payments/latest/international-payments/global-collections/partner/webhooks"}]}]}]},{"group":"Utilities","pages":[{"title":"Get PAR","sidebarTitle":"Get PAR","openapi":"openapi/payments/v2026-01-01.yaml post /utilities/pars","href":"/api-reference/payments/latest/utilities/get-par"},{"title":"Get Card BIN Details","sidebarTitle":"Get Card BIN Details","openapi":"openapi/payments/v2026-01-01.yaml post /utilities/cardbin","href":"/api-reference/payments/latest/utilities/get-card-bin-details"},{"group":"Downtimes","pages":[{"title":"Fetch All Downtimes","sidebarTitle":"Fetch All Downtimes","openapi":"openapi/payments/v2026-01-01.yaml get /incident","href":"/api-reference/payments/latest/downtime/fetch-all-downtimes"},{"title":"Fetch Downtime by ID","sidebarTitle":"Fetch Downtime by ID","openapi":"openapi/payments/v2026-01-01.yaml get /incident/{id}","href":"/api-reference/payments/latest/intellisense/fetch-downtime-by-id"},{"title":"Incident Service Webhook","icon":"webhook","sidebarTitle":"Incident Webhooks","href":"/api-reference/payments/latest/utilities/incidents/incident-webhook"}]}]}]},{"group":"Other Versions","pages":[{"group":"v2025-01-01","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2025-01-01/overview"},{"group":"Orders","pages":[{"title":"Create Order","openapi":"openapi/payments/v2025-01-01.yaml post /orders","href":"/api-reference/payments/previous/v2025-01-01/orders/create"},{"title":"Get Order","openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}","href":"/api-reference/payments/previous/v2025-01-01/orders/get"},{"title":"Terminate Order","openapi":"openapi/payments/v2025-01-01.yaml patch /orders/{order_id}","href":"/api-reference/payments/previous/v2025-01-01/orders/terminate"},{"title":"Get Order Extended","openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}/extended","href":"/api-reference/payments/previous/v2025-01-01/orders/get-order-extended"},{"title":"Update Order Extended","openapi":"openapi/payments/v2025-01-01.yaml put /orders/{order_id}/extended","href":"/api-reference/payments/previous/v2025-01-01/orders/update-order-extended"}]},{"group":"Payments","pages":[{"title":"Order Pay","sidebarTitle":"Order Pay","icon":"","openapi":"openapi/payments/v2025-01-01.yaml post /orders/sessions","href":"/api-reference/payments/previous/v2025-01-01/payments/pay"},{"title":"Submit or Resend OTP","openapi":"openapi/payments/v2025-01-01.yaml post /orders/pay/authenticate/{cf_payment_id}","href":"/api-reference/payments/previous/v2025-01-01/payments/authenticate"},{"title":"Preauthorisation","openapi":"openapi/payments/v2025-01-01.yaml post /orders/{order_id}/authorization","href":"/api-reference/payments/previous/v2025-01-01/payments/authorize"},{"title":"Get Payment by ID","openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}/payments/{cf_payment_id}","href":"/api-reference/payments/previous/v2025-01-01/payments/get"},{"title":"Get Payments for an Order","openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}/payments","href":"/api-reference/payments/previous/v2025-01-01/payments/get-payments-for-order"},{"title":"Payment Webhooks","sidebarTitle":"Payment Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2025-01-01/payments/webhooks"}]},{"group":"Payment Links","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /links","title":"Create Payment Link","href":"/api-reference/payments/previous/v2025-01-01/payment-links/create"},{"openapi":"openapi/payments/v2025-01-01.yaml get /links/{link_id}","title":"Fetch Payment Link Details","href":"/api-reference/payments/previous/v2025-01-01/payment-links/get"},{"openapi":"openapi/payments/v2025-01-01.yaml post /links/{link_id}/cancel","title":"Cancel Payment Link","href":"/api-reference/payments/previous/v2025-01-01/payment-links/cancel"},{"openapi":"openapi/payments/v2025-01-01.yaml get /links/{link_id}/orders","title":"Get Orders for a Payment Link","href":"/api-reference/payments/previous/v2025-01-01/payment-links/get-orders-for-link"},{"title":"Payment Link Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2025-01-01/payment-links/webhooks"}]},{"group":"Refunds","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /orders/{order_id}/refunds","title":"Create Refund","href":"/api-reference/payments/previous/v2025-01-01/refunds/create"},{"openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}/refunds/{refund_id}","title":"Get Refund","href":"/api-reference/payments/previous/v2025-01-01/refunds/get"},{"openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}/refunds","title":"Get All Refunds for an Order","href":"/api-reference/payments/previous/v2025-01-01/refunds/get-refunds-for-order"},{"openapi":"openapi/payments/v2025-01-01.yaml put /orders/{order_id}/refunds/{refund_id}","title":"Update Refund","href":"/api-reference/payments/previous/v2025-01-01/refunds/update-refund"},{"title":"Refund Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2025-01-01/refunds/webhooks"}]},{"group":"Customers","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /customers","title":"Create Customer at Cashfree","href":"/api-reference/payments/previous/v2025-01-01/customers/create"}]},{"group":"Easy-Split","pages":[{"title":"Easy Split Overview","sidebarTitle":"Easy Split Overview","href":"/api-reference/payments/previous/v2025-01-01/split/easy-split-overview"},{"title":"Easy Split - Postman Collection","sidebarTitle":"Easy Split - Postman Collection","href":"/api-reference/payments/previous/v2025-01-01/split/easy-split-postman-collection"},{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/previous/v2025-01-01/split/end-points"},{"group":"Vendors","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2023-08-01/split/vendors/overview"},{"openapi":"openapi/payments/v2025-01-01.yaml post /easy-split/vendors","title":"Create vendor","href":"/api-reference/payments/previous/v2025-01-01/split/vendors/create"},{"openapi":"openapi/payments/v2025-01-01.yaml get /easy-split/vendors/{vendor_id}","title":"Get Vendor All Details","href":"/api-reference/payments/previous/v2025-01-01/split/vendors/get"},{"openapi":"openapi/payments/v2025-01-01.yaml patch /easy-split/vendors/{vendor_id}","title":"Update vendor Details","href":"/api-reference/payments/previous/v2025-01-01/split/vendors/update"},{"openapi":"openapi/payments/v2025-01-01.yaml post /easy-split/vendor-docs/{vendor_id}","title":"Upload Vendor Docs","href":"/api-reference/payments/previous/v2025-01-01/split/vendors/add-document"},{"openapi":"openapi/payments/v2025-01-01.yaml get /easy-split/vendor-docs/{vendor_id}","title":"Get Vendor All Documents Status","href":"/api-reference/payments/previous/v2025-01-01/split/vendors/get-document"},{"openapi":"openapi/payments/v2025-01-01.yaml get /easy-split/vendor-docs/{vendor_id}/download/{doc_type}","title":"Download Vendor Documents","href":"/api-reference/payments/previous/v2025-01-01/split/vendors/download-documents"},{"openapi":"openapi/payments/v2025-01-01.yaml get /easy-split/vendors/{vendor_id}/balances","title":"Get On Demand Balance","href":"/api-reference/payments/previous/v2025-01-01/split/vendors/get-on-demand-balance"}]},{"group":"Configuration","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /easy-split/static-split","title":"Create Static Split Configuration","href":"/api-reference/payments/previous/v2025-01-01/split/configuration/static-split"},{"openapi":"openapi/payments/v2025-01-01.yaml post /easy-split/orders/{order_id}/split","title":"Split After Payment","href":"/api-reference/payments/previous/v2025-01-01/split/configuration/split-after-payment"}]},{"group":"Settlements","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /easy-split/vendors/{vendor_id}/transfer","title":"Create On Demand Transfer","href":"/api-reference/payments/previous/v2025-01-01/split/settlements/on-demand-transfer"},{"openapi":"openapi/payments/v2025-01-01.yaml post /split/order/vendor/recon","title":"Get Split and Settlement Details by OrderID v2.0","href":"/api-reference/payments/previous/v2025-01-01/split/settlements/split-details"}]},{"group":"Billing","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml get /easy-split/amount/{amount}/charges","title":"Get Vendor Balance Transfer Charges","href":"/api-reference/payments/previous/v2025-01-01/split/billing/balance-transfer-charges"}]},{"group":"Webhooks","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2025-01-01/split/webhooks/overview"},{"title":"Vendor Settlement Webhook","sidebarTitle":"Vendor Settlement Webhook","href":"/api-reference/payments/previous/v2025-01-01/split/webhooks/vendor-settlement-webhooks"},{"title":"Vendor Status Change Webhook","sidebarTitle":"Vendor Status Change Webhook","href":"/api-reference/payments/previous/v2025-01-01/split/webhooks/vendor-status-change-webhooks"}]},{"group":"Reconciliation","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /recon/vendor","title":"Vendor Reconciliation API","href":"/api-reference/payments/previous/v2025-01-01/reconciliation/vendor-recon"}]}]},{"group":"Payment Methods","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /eligibility/cardlessemi","title":"Get Eligible Cardless EMI Payment Methods for a customer on an order","href":"/api-reference/payments/previous/v2025-01-01/eligibility/get-eligible-cardless-emi-payment-methods-for-a-customer-on-an-order"},{"openapi":"openapi/payments/v2025-01-01.yaml post /eligibility/offers","title":"Get Eligible Offers for an Order","href":"/api-reference/payments/previous/v2025-01-01/eligibility/get-eligible-offers-for-an-order"},{"openapi":"openapi/payments/v2025-01-01.yaml post /eligibility/paylater","title":"Get Eligible Paylater for a customer on an order","href":"/api-reference/payments/previous/v2025-01-01/eligibility/get-eligible-paylater-for-a-customer-on-an-order"},{"openapi":"openapi/payments/v2025-01-01.yaml post /eligibility/payment_methods","title":"Get eligible Payment Methods","href":"/api-reference/payments/previous/v2025-01-01/eligibility/get-eligible-payment-methods"}]},{"group":"Offers","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /offers","title":"Create Offer","href":"/api-reference/payments/previous/v2025-01-01/offers/create"},{"openapi":"openapi/payments/v2025-01-01.yaml get /offers/{offer_id}","title":"Get Offer by ID","href":"/api-reference/payments/previous/v2025-01-01/offers/get"}]},{"group":"Token Vault","pages":[{"title":"Get Cryptogram for a Saved Card Instrument","openapi":"openapi/payments/v2025-01-01.yaml get /customers/{customer_id}/instruments/{instrument_id}/cryptogram","href":"/api-reference/payments/previous/v2025-01-01/token-vault/generate-cryptogram"},{"title":"Get All Saved Card Instrument","openapi":"openapi/payments/v2025-01-01.yaml get /customers/{customer_id}/instruments?instrument_type=card","href":"/api-reference/payments/previous/v2025-01-01/token-vault/get-all"},{"title":"Get Specific Saved Card Instrument","openapi":"openapi/payments/v2025-01-01.yaml get /customers/{customer_id}/instruments/{instrument_id}","href":"/api-reference/payments/previous/v2025-01-01/token-vault/get"},{"title":"Delete Saved Card Instrument","openapi":"openapi/payments/v2025-01-01.yaml delete /customers/{customer_id}/instruments/{instrument_id}","href":"/api-reference/payments/previous/v2025-01-01/token-vault/delete"},{"title":"Card Token Webhook","sidebarTitle":"Webhook","icon":"webhook","href":"/api-reference/payments/previous/v2025-01-01/token-vault/webhooks"}]},{"group":"Disputes","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}/disputes","title":"Get Disputes by Order ID","href":"/api-reference/payments/previous/v2025-01-01/disputes/get-disputes-by-order-id"},{"openapi":"openapi/payments/v2025-01-01.yaml get /payments/{cf_payment_id}/disputes","title":"Get Disputes by Payment ID","href":"/api-reference/payments/previous/v2025-01-01/disputes/get-disputes-by-payment-id"},{"openapi":"openapi/payments/v2025-01-01.yaml get /disputes/{dispute_id}","title":"Get Disputes by Dispute ID","href":"/api-reference/payments/previous/v2025-01-01/disputes/get-disputes-by-dispute-id"},{"openapi":"openapi/payments/v2025-01-01.yaml put /disputes/{dispute_id}/accept","title":"Accept Dispute by Dispute ID","href":"/api-reference/payments/previous/v2025-01-01/disputes/accept-dispute-by-dispute-id"},{"openapi":"openapi/payments/v2025-01-01.yaml post /disputes/{dispute_id}/documents","title":"Submit Evidence to contest the Dispute by Dispute ID","href":"/api-reference/payments/previous/v2025-01-01/disputes/submit-evidence-to-contest-the-dispute-by-dispute-id"},{"openapi":"openapi/payments/v2025-01-01.yaml put /disputes/{dispute_id}/contest-arbitration","title":"Contest Arbitration by Dispute ID","href":"/api-reference/payments/previous/v2025-01-01/disputes/contest-arbitration-by-dispute-id"},{"title":"Dispute Webhooks","sidebarTitle":"Dispute Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2025-01-01/disputes/dispute-webhooks"}]},{"group":"Settlements","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /settlements","title":"Get All Settlements","href":"/api-reference/payments/previous/v2025-01-01/settlements/get-settlements"},{"openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}/settlements","title":"Get Settlements by Order ID","href":"/api-reference/payments/previous/v2025-01-01/settlements/get-settlements-for-order"},{"openapi":"openapi/payments/v2025-01-01.yaml post /orders/settlements","title":"Mark Order For Settlement","href":"/api-reference/payments/previous/v2025-01-01/settlements/mark-order-for-settlement"},{"openapi":"openapi/payments/v2025-01-01.yaml post /recon","title":"PG Reconciliation","href":"/api-reference/payments/previous/v2025-01-01/settlements/reconcile"},{"title":"Settlement Reconciliation","openapi":"openapi/payments/v2025-01-01.yaml post /settlement/recon","href":"/api-reference/payments/previous/v2025-01-01/settlements/settlement-reconciliation"},{"title":"Settlement Webhooks","sidebarTitle":"Settlement Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2025-01-01/settlements/settlement-webhooks"}]},{"group":"Offline Payments","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /terminal","title":"Create Terminal","href":"/api-reference/payments/previous/v2025-01-01/softpos/create-terminal"},{"openapi":"openapi/payments/v2025-01-01.yaml get /terminal/qrcodes","title":"Fetch Terminal QR Codes","href":"/api-reference/payments/previous/v2025-01-01/softpos/fetch-terminal-qr-codes"},{"openapi":"openapi/payments/v2025-01-01.yaml post /terminal/transactions","title":"Create Terminal Transaction","href":"/api-reference/payments/previous/v2025-01-01/softpos/create-terminal-transaction"},{"openapi":"openapi/payments/v2025-01-01.yaml post /terminal/soundbox","title":"Onboard Soundbox Vpa","href":"/api-reference/payments/previous/v2025-01-01/softpos/onboard-soundbox-vpa"},{"openapi":"openapi/payments/v2025-01-01.yaml patch /terminal/{cf_terminal_id}/soundbox","title":"Update Soundbox Vpa","href":"/api-reference/payments/previous/v2025-01-01/softpos/update-soundbox-vpa"},{"openapi":"openapi/payments/v2025-01-01.yaml post /terminal/demap/soundbox","title":"Demap Soundbox Vpa","href":"/api-reference/payments/previous/v2025-01-01/softpos/demap-soundbox-vpa"},{"openapi":"openapi/payments/v2025-01-01.yaml get /terminal/soundbox/qrcodes","title":"Fetch Terminal Soundbox vpa","href":"/api-reference/payments/previous/v2025-01-01/softpos/fetch-terminal-soundbox-vpa"},{"openapi":"openapi/payments/v2025-01-01.yaml get /terminal/{cf_terminal_id}/payments","title":"Get Terminal Transaction","href":"/api-reference/payments/previous/v2025-01-01/softpos/get-terminal-transaction"},{"title":"Get Terminal Payments","sidebarTitle":"Get Terminal Payments","openapi":"openapi/payments/v2025-01-01.yaml post /terminal/payments","href":"/api-reference/payments/previous/v2025-01-01/softpos/get-terminal-payments"},{"openapi":"openapi/payments/v2025-01-01.yaml patch /terminal/{cf_terminal_id}","title":"Update Terminal","href":"/api-reference/payments/previous/v2025-01-01/softpos/update-terminal"},{"openapi":"openapi/payments/v2025-01-01.yaml patch /terminal/{cf_terminal_id}/status","title":"Update Terminal Status","href":"/api-reference/payments/previous/v2025-01-01/softpos/update-terminal-status"},{"openapi":"openapi/payments/v2025-01-01.yaml get /terminal/{terminal_phone_no}","title":"Get Terminal Status using Phone Number","href":"/api-reference/payments/previous/v2025-01-01/softpos/get-terminal-status-using-phone-number"},{"openapi":"openapi/payments/v2025-01-01.yaml post /terminal/{cf_terminal_id}/docs","title":"Upload Terminal Docs","href":"/api-reference/payments/previous/v2025-01-01/softpos/upload-terminal-docs"},{"title":"SoftPOS Webhooks","sidebarTitle":"SoftPOS Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2025-01-01/softpos/softpos-webhooks"}]},{"group":"Simulation","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /simulate","title":"Simulate Payment","href":"/api-reference/payments/previous/v2025-01-01/simulation/simulate-payment"},{"openapi":"openapi/payments/v2025-01-01.yaml get /simulate/{simulation_id}","title":"Fetch Simulation","href":"/api-reference/payments/previous/v2025-01-01/simulation/fetch-simulation"},{"openapi":"openapi/payments/v2025-01-01.yaml post /simulate/settlement","title":"Simulate Settlement Payment","href":"/api-reference/payments/previous/v2025-01-01/simulation/simulate-settlement"},{"openapi":"openapi/payments/v2025-01-01.yaml get /simulate/settlement/{simulation_id}","title":"Fetch Settlement Simulation","href":"/api-reference/payments/previous/v2025-01-01/simulation/fetch-settlement-simulation"}]},{"group":"Subscription","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2025-01-01/subscription/overview"},{"title":"Postman Collection","sidebarTitle":"Postman Collection","href":"/api-reference/payments/previous/v2025-01-01/subscription/subscription-postman-collection"},{"title":"Error Codes and Reasons","sidebarTitle":"Error Codes and Reasons","href":"/api-reference/payments/previous/v2025-01-01/subscription/error-codes"},{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/previous/v2025-01-01/subscription/endpoints"},{"title":"Physical Mandates","sidebarTitle":"Physical Mandates","href":"/api-reference/payments/previous/v2025-01-01/subscription/physical-mandates"},{"group":"Plan","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /plans","title":"Create a Plan","href":"/api-reference/payments/previous/v2025-01-01/subscription/plans/create"},{"openapi":"openapi/payments/v2025-01-01.yaml get /plans/{plan_id}","title":"Fetch Plan","href":"/api-reference/payments/previous/v2025-01-01/subscription/plans/fetch"}]},{"group":"Mandate","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /subscriptions","title":"Create Subscription","href":"/api-reference/payments/previous/v2025-01-01/subscription/mandate/create"},{"openapi":"openapi/payments/v2025-01-01.yaml get /subscriptions/{subscription_id}","title":"Fetch Subscription","href":"/api-reference/payments/previous/v2025-01-01/subscription/mandate/fetch"},{"openapi":"openapi/payments/v2025-01-01.yaml post /subscriptions/{subscription_id}/manage","title":"Manage Subscription","href":"/api-reference/payments/previous/v2025-01-01/subscription/mandate/manage"},{"openapi":"openapi/payments/v2025-01-01.yaml post /subscriptions/pay/documents/{payment_id}","title":"Upload file for Physical Nach Authorisation","href":"/api-reference/payments/previous/v2025-01-01/subscription/mandate/physical-nach-mandate"},{"openapi":"openapi/payments/v2025-01-01.yaml post /subscriptions/eligibility/payment_methods","title":"Get All the Payment Method Details Available for Subscription Payments","href":"/api-reference/payments/previous/v2025-01-01/subscription/mandate/payment-methods"},{"openapi":"openapi/payments/v2025-01-01.yaml post /subscriptions/charge/{payment_id}/transaction-return-summary/generate","title":"Generate Transaction Return Summary","href":"/api-reference/payments/previous/v2025-01-01/subscription/mandate/generate-transaction-summary"}]},{"group":"Payment","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /subscriptions/pay","title":"Raise a Charge or Create an Auth","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/raise"},{"openapi":"openapi/payments/v2025-01-01.yaml get /subscriptions/{subscription_id}/payments/{payment_id}","title":"Fetch Details of a Single Payment","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/fetch"},{"openapi":"openapi/payments/v2025-01-01.yaml post /subscriptions/{subscription_id}/payments/{payment_id}/manage","title":"Manage a Single Payment","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/manage"},{"openapi":"openapi/payments/v2025-01-01.yaml get /subscriptions/{subscription_id}/payments","title":"Fetch Details of All Payments of a Subscription","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/fetch-payments-for-mandate"},{"group":"Controlled Charging","pages":[{"title":"Controlled Subscription Payments","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/controlled/overview"},{"openapi":"openapi/payments/v2025-01-01.yaml post /subscriptions/pay/controlled/notify-mandate","title":"Create Controlled Notification","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/controlled/create-controlled-notification"},{"openapi":"openapi/payments/v2025-01-01.yaml get /subscriptions/payments/{payment_id}/controlled/notifications/{notification_id}","title":"Fetch Controlled Notification","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/controlled/fetch-controlled-notification"},{"title":"Fetch All Controlled Notifications","sidebarTitle":"Fetch All Controlled Notifications","openapi":"openapi/payments/v2025-01-01.yaml get /subscriptions/payments/{payment_id}/controlled/notifications","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/controlled/fetch-controlled-notifications"},{"openapi":"openapi/payments/v2025-01-01.yaml post /subscriptions/pay/controlled/execute-mandate","title":"Create Controlled Execution","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/controlled/create-controlled-execution"},{"openapi":"openapi/payments/v2025-01-01.yaml get /subscriptions/payments/{payment_id}/controlled/executions/{execution_id}","title":"Fetch Controlled Execution","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/controlled/fetch-controlled-execution"},{"title":"Fetch All Controlled Executions","sidebarTitle":"Fetch All Controlled Executions","openapi":"openapi/payments/v2025-01-01.yaml get /subscriptions/payments/{payment_id}/controlled/executions","href":"/api-reference/payments/previous/v2025-01-01/subscription/payment/controlled/fetch-controlled-executions"}]}]},{"group":"Refund","pages":[{"title":"Refund APIs Overview","sidebarTitle":"Subscription Refund APIs","href":"/api-reference/payments/previous/v2025-01-01/subscription/refund/refund-apis-overview"},{"openapi":"openapi/payments/v2025-01-01.yaml post /subscriptions/{subscription_id}/refunds","title":"Create a Refund","href":"/api-reference/payments/previous/v2025-01-01/subscription/refund/create"},{"openapi":"openapi/payments/v2025-01-01.yaml get /subscriptions/{subscription_id}/refunds/{refund_id}","title":"Fetch Details of a Refund","href":"/api-reference/payments/previous/v2025-01-01/subscription/refund/fetch"}]},{"title":"Redirection Payload After Authorisation","sidebarTitle":"Redirection Payload After Authorisation","href":"/api-reference/payments/previous/v2025-01-01/subscription/redirection-payload-after-authorization"},{"title":"Rate Limits","sidebarTitle":"Rate Limits","href":"/api-reference/payments/previous/v2025-01-01/subscription/rate-limits"},{"title":"Subscription Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2025-01-01/subscription/webhooks"}]},{"group":"VBA","pages":[{"group":"Manage VBA","pages":[{"title":"Create VBA","openapi":"openapi/pgvba/pgvba.yaml post /pg/vba","href":"/api-reference/payments/previous/v2025-01-01/pgvba/create-vba"},{"title":"Edit VBA","openapi":"openapi/pgvba/pgvba.yaml put /pg/vba/{virtual_account_id}","href":"/api-reference/payments/previous/v2025-01-01/pgvba/edit-vba"},{"title":"Manage VBA","openapi":"openapi/pgvba/pgvba.yaml patch /pg/vba/{virtual_account_id}","href":"/api-reference/payments/previous/v2025-01-01/pgvba/manage-vba"},{"title":"Get VBA","openapi":"openapi/pgvba/pgvba.yaml get /pg/vba/{virtual_account_id}","href":"/api-reference/payments/previous/v2025-01-01/pgvba/get-vba"}]},{"group":"Payments","pages":[{"title":"Get VBA Payments","openapi":"openapi/pgvba/pgvba.yaml post /pg/vba/payments","href":"/api-reference/payments/previous/v2025-01-01/pgvba/get-vba-payments"},{"title":"Get VBA Payments By UTR","openapi":"openapi/pgvba/pgvba.yaml get /pg/vba/payments/{utr}","href":"/api-reference/payments/previous/v2025-01-01/pgvba/get-vba-payments-by-utr"}]},{"group":"Notification Group","pages":[{"title":"Create VBA Notification Group","openapi":"openapi/pgvba/pgvba.yaml post /pg/vba/notificationgroup","href":"/api-reference/payments/previous/v2025-01-01/pgvba/create-vba-notification-group"},{"title":"Edit VBA Notification Group","openapi":"openapi/pgvba/pgvba.yaml put /pg/vba/notificationgroup/{notification_group_name}","href":"/api-reference/payments/previous/v2025-01-01/pgvba/edit-vba-notification-group"},{"title":"Manage VBA Notification Group Status","openapi":"openapi/pgvba/pgvba.yaml patch /pg/vba/notificationgroup/{notification_group_name}","href":"/api-reference/payments/previous/v2025-01-01/pgvba/manage-vba-notification-group-status"},{"title":"Get VBA Notification Group","openapi":"openapi/pgvba/pgvba.yaml get /pg/vba/notificationgroup/{notification_group_name}","href":"/api-reference/payments/previous/v2025-01-01/pgvba/get-vba-notification-group"}]}]},{"group":"International Payments","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2025-01-01/international-payments/overview"},{"group":"Collect from India","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/overview"},{"openapi":"openapi/cb-imports/v2025-01-01.yaml post /import/transactions/{cf_payment_id}","title":"Upload Payment Verification Details","href":"/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/upload-payment-verification-details"},{"openapi":"get /import/transactions/{cf_payment_id}","title":"Get Payment Verification Details","href":"/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/get-payment-verification-details"},{"openapi":"openapi/cb-imports/merchant-spec.json get /import/orders/{order_id}/settlements","title":"Get Import Settlement Details for an Order","href":"/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/get-import-settlement-details"},{"openapi":"openapi/cb-imports/merchant-spec.json post /import/settlements/recon","title":"Get Import Settlement Recon Details","href":"/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/get-import-settlement-recon-details"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/import-webhooks"},{"group":"Sandbox Simulation","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/sandbox-simulation"},{"openapi":"post /import/settlements/emulate","title":"Trigger Sandbox Settlement","href":"/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/trigger-sandbox-settlement"},{"openapi":"put /import/settlements/emulate","title":"Mark Sandbox Settlement Processed","href":"/api-reference/payments/previous/v2025-01-01/international-payments/collect-from-india/mark-sandbox-settlement-processed"}]}]},{"group":"Collect from the World","pages":[{"group":"Global Collections","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/overview"},{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/endpoints"},{"title":"Purpose Codes","sidebarTitle":"Purpose Codes","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/purpose-codes"},{"group":"Authorization","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/partner/auth-overview"},{"title":"Get Auth Token","openapi":"post /gc/authorize","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/partner/auth-get-token"},{"title":"Verify Auth Token","openapi":"get /gc/token/verify","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/partner/auth-verify-token"}]},{"title":"Get Collection Accounts","openapi":"get /gc/virtual-accounts","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/partner/get-collection-accounts"},{"title":"Get Transactions","openapi":"get /gc/transactions","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/partner/get-transactions"},{"title":"Add Transaction Details","openapi":"post /gc/transactions/{referenceId}/invoice-details","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/partner/add-transaction-details"},{"title":"Simulate Transaction","openapi":"post /gc/transactions/emulate","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/partner/simulate-transaction"},{"title":"Webhook - Partner","sidebarTitle":"Webhook - Partner","icon":"webhook","href":"/api-reference/payments/previous/v2025-01-01/international-payments/global-collections/partner/webhooks"}]}]}]},{"group":"Utilities","pages":[{"title":"Get PAR","openapi":"post /utilities/pars","href":"/api-reference/payments/previous/v2025-01-01/utilities/get-par"},{"openapi":"post /utilities/cardbin","title":"Get Card BIN Details","href":"/api-reference/payments/previous/v2025-01-01/utilities/get-card-bin"},{"group":"Downtimes","pages":[{"openapi":"get /incident","title":"Fetch All Downtimes","href":"/api-reference/payments/previous/v2025-01-01/utilities/incidents/fetch-all-downtimes"},{"openapi":"get /incident/{id}","title":"Fetch Downtime by ID","href":"/api-reference/payments/previous/v2025-01-01/utilities/incidents/fetch-downtime-by-id"},{"title":"Incident Service Webhook","icon":"webhook","sidebarTitle":"Incident Webhooks","href":"/api-reference/payments/previous/v2025-01-01/utilities/incidents/incident-webhook"}]}]}]},{"group":"v2023-08-01","pages":[{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/previous/v2023-08-01/overview"},{"title":"Release Notes for v2023-08-01","sidebarTitle":"Release Notes","href":"/api-reference/payments/previous/v2023-08-01/release-notes"},{"group":"Orders","pages":[{"title":"Create Order","openapi":"openapi/payments/v2023-08-01.yaml post /orders","href":"/api-reference/payments/previous/v2023-08-01/orders/create"},{"title":"Get Order","openapi":"openapi/payments/v2023-08-01.yaml get /orders/{order_id}","href":"/api-reference/payments/previous/v2023-08-01/orders/get"},{"title":"Terminate Order","openapi":"openapi/payments/v2023-08-01.yaml patch /orders/{order_id}","href":"/api-reference/payments/previous/v2023-08-01/orders/terminate"},{"title":"Get Order Extended","openapi":"openapi/payments/v2023-08-01.yaml get /orders/{order_id}/extended","href":"/api-reference/payments/previous/v2023-08-01/orders/get-order-extended"},{"title":"Update Order Extended","openapi":"openapi/payments/v2023-08-01.yaml put /orders/{order_id}/extended","href":"/api-reference/payments/previous/v2023-08-01/orders/update-order-extended"}]},{"group":"Payments","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /orders/pay/authenticate/{cf_payment_id}","title":"Submit or Resend OTP","href":"/api-reference/payments/previous/v2023-08-01/payments/authenticate"},{"openapi":"openapi/payments/v2023-08-01.yaml post /orders/sessions","title":"Order Pay","href":"/api-reference/payments/previous/v2023-08-01/payments/pay"},{"openapi":"openapi/payments/v2023-08-01.yaml post /orders/{order_id}/authorization","title":"Preauthorization","href":"/api-reference/payments/previous/v2023-08-01/payments/authorize"},{"openapi":"openapi/payments/v2023-08-01.yaml get /orders/{order_id}/payments","title":"Get Payments for an Order","href":"/api-reference/payments/previous/v2023-08-01/payments/get-payments-for-order"},{"openapi":"openapi/payments/v2023-08-01.yaml get /orders/{order_id}/payments/{cf_payment_id}","title":"Get Payment by ID","href":"/api-reference/payments/previous/v2023-08-01/payments/get"},{"title":"Payment Webhooks","sidebarTitle":"Payment Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2023-08-01/payments/webhooks"}]},{"group":"Payment Links","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /links","title":"Create Payment Link","href":"/api-reference/payments/previous/v2023-08-01/payment-links/create"},{"openapi":"openapi/payments/v2023-08-01.yaml get /links/{link_id}/orders","title":"Get Orders for a Payment Link","href":"/api-reference/payments/previous/v2023-08-01/payment-links/get"},{"openapi":"openapi/payments/v2023-08-01.yaml post /links/{link_id}/cancel","title":"Cancel Payment Link","href":"/api-reference/payments/previous/v2023-08-01/payment-links/cancel"},{"openapi":"openapi/payments/v2023-08-01.yaml get /links/{link_id}","title":"Fetch Payment Link Details","href":"/api-reference/payments/previous/v2023-08-01/payment-links/get-orders-for-link"},{"title":"Payment Link Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2023-08-01/payment-links/webhooks"}]},{"group":"Refunds","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml get /orders/{order_id}/refunds/{refund_id}","title":"Get Refund","href":"/api-reference/payments/previous/v2023-08-01/refunds/get"},{"openapi":"openapi/payments/v2023-08-01.yaml get /orders/{order_id}/refunds","title":"Get All Refunds for an Order","href":"/api-reference/payments/previous/v2023-08-01/refunds/get-refunds-for-order"},{"openapi":"openapi/payments/v2023-08-01.yaml post /orders/{order_id}/refunds","title":"Create Refund","href":"/api-reference/payments/previous/v2023-08-01/refunds/create"},{"title":"Refund Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2023-08-01/refunds/webhooks"}]},{"group":"Customers","pages":[{"title":"Create Customer","openapi":"openapi/payments/v2023-08-01.yaml post /customers","href":"/api-reference/payments/previous/v2023-08-01/customers/create"}]},{"group":"Easy-Split","pages":[{"title":"Easy Split Overview","sidebarTitle":"Easy Split Overview","href":"/api-reference/payments/previous/v2023-08-01/split/easy-split-overview"},{"title":"Easy Split - Postman Collection","sidebarTitle":"Easy Split - Postman Collection","href":"/api-reference/payments/previous/v2023-08-01/split/easy-split-postman-collection"},{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/previous/v2023-08-01/split/end-points"},{"group":"Vendors","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2023-08-01/split/vendors/overview"},{"openapi":"openapi/payments/v2023-08-01.yaml post /easy-split/vendors","title":"Create vendor","href":"/api-reference/payments/previous/v2023-08-01/split/vendors/create"},{"openapi":"openapi/payments/v2023-08-01.yaml get /easy-split/vendors/{vendor_id}","title":"Get Vendor All Details","href":"/api-reference/payments/previous/v2023-08-01/split/vendors/get"},{"openapi":"openapi/payments/v2023-08-01.yaml patch /easy-split/vendors/{vendor_id}","title":"Update vendor Details","href":"/api-reference/payments/previous/v2023-08-01/split/vendors/update"},{"openapi":"openapi/payments/v2023-08-01.yaml post /easy-split/vendor-docs/{vendor_id}","title":"Upload Vendor Docs","href":"/api-reference/payments/previous/v2023-08-01/split/vendors/add-document"},{"openapi":"openapi/payments/v2023-08-01.yaml get /easy-split/vendor-docs/{vendor_id}","title":"Get Vendor All Documents Status","href":"/api-reference/payments/previous/v2023-08-01/split/vendors/get-document"},{"openapi":"openapi/payments/v2023-08-01.yaml get /easy-split/vendor-docs/{vendor_id}/download/{doc_type}","title":"Download Vendor Documents","href":"/api-reference/payments/previous/v2023-08-01/split/vendors/download-documents"},{"openapi":"openapi/payments/v2023-08-01.yaml get /easy-split/vendors/{vendor_id}/balances","title":"Get On Demand Balance","href":"/api-reference/payments/previous/v2023-08-01/split/vendors/get-on-demand-balance"}]},{"group":"Configuration","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /easy-split/static-split","title":"Create Static Split Configuration","href":"/api-reference/payments/previous/v2023-08-01/split/configuration/static-split"},{"openapi":"openapi/payments/v2023-08-01.yaml post /easy-split/orders/{order_id}/split","title":"Split After Payment","href":"/api-reference/payments/previous/v2023-08-01/split/configuration/split-after-payment"},{"openapi":"openapi/payments/v2023-08-01.yaml post /easy-split/vendors/{vendor_id}/adjustment","title":"Create Adjustment","href":"/api-reference/payments/previous/v2023-08-01/split/configuration/create-adjustment"}]},{"group":"Settlements","pages":[{"title":"Settlements Overview","sidebarTitle":"Settlements Overview","href":"/api-reference/payments/previous/v2023-08-01/split/settlements/overview"},{"openapi":"openapi/payments/v2023-08-01.yaml post /easy-split/vendors/{vendor_id}/transfer","title":"Create On Demand Balance Transfer","href":"/api-reference/payments/previous/v2023-08-01/split/settlements/on-demand-transfer"},{"openapi":"openapi/payments/v2023-08-01.yaml get /easy-split/orders/{order_id}","title":"Get Split and Settlement Details by OrderID","href":"/api-reference/payments/previous/v2023-08-01/split/settlements/split-details"},{"openapi":"openapi/payments/v2023-08-01.yaml post /split/order/vendor/recon","title":"Get Split and Settlement Details by OrderID v2.0","href":"/api-reference/payments/previous/v2023-08-01/split/settlements/get-split-and-settlement-details"}]},{"group":"Billing","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml get /easy-split/amount/{amount}/charges","title":"Get Vendor Balance Transfer Charges","href":"/api-reference/payments/previous/v2023-08-01/split/billing/balance-transfer-charges"}]},{"group":"Webhooks","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2023-08-01/split/webhooks/overview"},{"title":"Vendor Settlement Webhook","sidebarTitle":"Vendor Settlement Webhook","href":"/api-reference/payments/previous/v2023-08-01/split/webhooks/vendor-settlement-webhooks"},{"title":"Vendor Status Change Webhook","sidebarTitle":"Vendor Status Change Webhook","href":"/api-reference/payments/previous/v2023-08-01/split/webhooks/vendor-status-change-webhooks"}]},{"group":"Reconciliation","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /recon/vendor","title":"Vendor Reconciliation API","href":"/api-reference/payments/previous/v2023-08-01/split/reconciliation/vendor-recon"}]}]},{"group":"Eligibility","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /eligibility/cardlessemi","title":"Get Eligible Cardless EMI Payment Methods for a customer on an order","href":"/api-reference/payments/previous/v2023-08-01/payment-methods/get-emi-for-customer-order"},{"openapi":"openapi/payments/v2023-08-01.yaml post /eligibility/offers","title":"Get Eligible Offers for an Order","href":"/api-reference/payments/previous/v2023-08-01/payment-methods/get-offers-for-order"},{"openapi":"openapi/payments/v2023-08-01.yaml post /eligibility/paylater","title":"Get Eligible Paylater for a customer on an order","href":"/api-reference/payments/previous/v2023-08-01/payment-methods/get-paylater-for-customer-order"},{"openapi":"openapi/payments/v2023-08-01.yaml post /eligibility/payment_methods","title":"Get eligible Payment Methods","href":"/api-reference/payments/previous/v2023-08-01/payment-methods/get-payment-methods"}]},{"group":"Offers","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /offers","title":"Create Offer","href":"/api-reference/payments/previous/v2023-08-01/offers/create"},{"openapi":"openapi/payments/v2023-08-01.yaml get /offers/{offer_id}","title":"Get Offer by ID","href":"/api-reference/payments/previous/v2023-08-01/offers/get"}]},{"group":"Dispute","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml get /disputes/{dispute_id}","title":"Get Disputes by Dispute ID","href":"/api-reference/payments/previous/v2023-08-01/dispute/disputes"},{"openapi":"openapi/payments/v2023-08-01.yaml get /orders/{order_id}/disputes","title":"Get Disputes by Order ID","href":"/api-reference/payments/previous/v2023-08-01/dispute/disputes-for-order"},{"openapi":"openapi/payments/v2023-08-01.yaml get /payments/{cf_payment_id}/disputes","title":"Get Disputes by Payment ID","href":"/api-reference/payments/previous/v2023-08-01/dispute/disputes-for-payment"},{"openapi":"openapi/payments/v2023-08-01.yaml post /disputes/{dispute_id}/documents","title":"Submit Evidence to contest the Dispute by Dispute ID","href":"/api-reference/payments/previous/v2023-08-01/dispute/dispute-submission"},{"openapi":"openapi/payments/v2023-08-01.yaml put /disputes/{dispute_id}/accept","title":"Accept Dispute by Dispute ID","href":"/api-reference/payments/previous/v2023-08-01/dispute/dispute-accept"},{"title":"Dispute Webhooks","sidebarTitle":"Dispute Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2023-08-01/dispute/dispute-webhooks"}]},{"group":"Settlements","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /settlements","title":"Get All Settlements","href":"/api-reference/payments/previous/v2023-08-01/settlements/settlements"},{"openapi":"openapi/payments/v2023-08-01.yaml get /orders/{order_id}/settlements","title":"Get Settlements by Order ID","href":"/api-reference/payments/previous/v2023-08-01/settlements/settlements-for-order"},{"openapi":"openapi/payments/v2023-08-01.yaml post /orders/settlements","title":"Mark Order For Settlement","href":"/api-reference/payments/previous/v2023-08-01/settlements/mark-order-for-settlement"},{"openapi":"openapi/payments/v2023-08-01.yaml post /recon","title":"PG Reconciliation","href":"/api-reference/payments/previous/v2023-08-01/settlements/reconcile"},{"openapi":"openapi/payments/v2023-08-01.yaml post /settlement/recon","title":"Settlement Reconciliation","href":"/api-reference/payments/previous/v2023-08-01/settlements/settlement-reconciliation"},{"title":"Settlement Webhooks","sidebarTitle":"Settlement Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2023-08-01/settlements/settlement-webhooks"}]},{"group":"Partners","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /partners/merchant/qrcodes","title":"Create Pre-Activated Vpas for partner","href":"/api-reference/payments/previous/v2023-08-01/partners/create-pre-activated-vpas-for-partner"},{"openapi":"openapi/payments/v2023-08-01.yaml get /partners/merchant/qrcodes","title":"Get Pre-Activated Vpas for partner","href":"/api-reference/payments/previous/v2023-08-01/partners/get-pre-activated-vpas-for-partner"}]},{"group":"Token Vault","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml get /customers/{customer_id}/instruments","title":"Fetch All Saved Card Instrument","href":"/api-reference/payments/previous/v2023-08-01/token-vault/get-all"},{"openapi":"openapi/payments/v2023-08-01.yaml get /customers/{customer_id}/instruments/{instrument_id}","title":"Fetch Specific Saved Card Instrument","href":"/api-reference/payments/previous/v2023-08-01/token-vault/fetch-specific-saved-card-instrument"},{"openapi":"openapi/payments/v2023-08-01.yaml delete /customers/{customer_id}/instruments/{instrument_id}","title":"Delete Saved Card Instrument","href":"/api-reference/payments/previous/v2023-08-01/token-vault/delete"},{"openapi":"openapi/payments/v2023-08-01.yaml get /customers/{customer_id}/instruments/{instrument_id}/cryptogram","title":"Fetch cryptogram for a saved card instrument","href":"/api-reference/payments/previous/v2023-08-01/token-vault/generate-cryptogram"},{"title":"Card Token Webhook","sidebarTitle":"Webhook","icon":"webhook","href":"/api-reference/payments/previous/v2023-08-01/token-vault/webhooks"}]},{"group":"Offline Payments","pages":[{"title":"Offline Payments Webhooks","sidebarTitle":"Offline Payments Webhooks","href":"/api-reference/payments/previous/v2023-08-01/softpos/softpos-webhooks"},{"openapi":"openapi/payments/v2023-08-01.yaml post /terminal","title":"Create Terminal","href":"/api-reference/payments/previous/v2023-08-01/softpos/create-terminal"},{"openapi":"openapi/payments/v2023-08-01.yaml get /terminal/qrcodes","title":"Fetch Terminal QR Codes","href":"/api-reference/payments/previous/v2023-08-01/softpos/fetch-terminal-qr-codes"},{"openapi":"openapi/payments/v2023-08-01.yaml post /terminal/transactions","title":"Create Terminal Transaction","href":"/api-reference/payments/previous/v2023-08-01/softpos/create-terminal-transaction"},{"openapi":"openapi/payments/v2023-08-01.yaml post /terminal/soundbox","title":"Onboard Soundbox Vpa","href":"/api-reference/payments/previous/v2023-08-01/softpos/onboard-soundbox-vpa"},{"openapi":"openapi/payments/v2023-08-01.yaml patch /terminal/{cf_terminal_id}/soundbox","title":"Update Soundbox Vpa","href":"/api-reference/payments/previous/v2023-08-01/softpos/update-soundbox-vpa"},{"openapi":"openapi/payments/v2023-08-01.yaml post /terminal/demap/soundbox","title":"Demap Soundbox Vpa","href":"/api-reference/payments/previous/v2023-08-01/softpos/demap-soundbox-vpa"},{"openapi":"openapi/payments/v2023-08-01.yaml get /terminal/soundbox/qrcodes","title":"Fetch Terminal Soundbox vpa","href":"/api-reference/payments/previous/v2023-08-01/softpos/fetch-terminal-soundbox-vpa"},{"openapi":"openapi/payments/v2023-08-01.yaml get /terminal/{cf_terminal_id}/payments","title":"Get Terminal Transaction","href":"/api-reference/payments/previous/v2023-08-01/softpos/get-terminal-transaction"},{"openapi":"openapi/payments/v2023-08-01.yaml patch /terminal/{cf_terminal_id}","title":"Update Terminal","href":"/api-reference/payments/previous/v2023-08-01/softpos/update-terminal"},{"openapi":"openapi/payments/v2023-08-01.yaml patch /terminal/{cf_terminal_id}/status","title":"Update Terminal Status","href":"/api-reference/payments/previous/v2023-08-01/softpos/update-terminal-status"},{"openapi":"openapi/payments/v2023-08-01.yaml get /terminal/{terminal_phone_no}","title":"Get Terminal Status using Phone Number","href":"/api-reference/payments/previous/v2023-08-01/softpos/get-terminal-status-using-phone-number"},{"openapi":"openapi/payments/v2023-08-01.yaml post /terminal/{cf_terminal_id}/docs","title":"Upload Terminal Docs","href":"/api-reference/payments/previous/v2023-08-01/softpos/upload-terminal-docs"}]},{"group":"Simulation","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /simulate","title":"Simulate Payment","href":"/api-reference/payments/previous/v2023-08-01/simulation/simulate-payment"},{"openapi":"openapi/payments/v2023-08-01.yaml get /simulate/{simulation_id}","title":"Fetch Simulation","href":"/api-reference/payments/previous/v2023-08-01/simulation/fetch-simulation"}]},{"group":"Subscription","pages":[{"title":"Postman Collection","sidebarTitle":"Postman Collection","href":"/api-reference/payments/previous/v2023-08-01/subscription/subscription-postman-collection"},{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/previous/v2023-08-01/subscription/endpoints"},{"title":"Physical Mandates","sidebarTitle":"Physical Mandates","href":"/api-reference/payments/previous/v2023-08-01/subscription/physical-mandates"},{"group":"Plan","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /plans","title":"Create a plan.","href":"/api-reference/payments/previous/v2023-08-01/subscription/plans/create"},{"openapi":"openapi/payments/v2023-08-01.yaml get /plans/{plan_id}","title":"Fetch Plan","href":"/api-reference/payments/previous/v2023-08-01/subscription/plans/fetch"}]},{"group":"Mandate","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /subscriptions","title":"Create Subscription","href":"/api-reference/payments/previous/v2023-08-01/subscription/mandate/create"},{"openapi":"openapi/payments/v2023-08-01.yaml get /subscriptions/{subscription_id}","title":"Fetch Subscription","href":"/api-reference/payments/previous/v2023-08-01/subscription/mandate/fetch"},{"openapi":"openapi/payments/v2023-08-01.yaml post /subscriptions/{subscription_id}/manage","title":"Manage a subscription.","href":"/api-reference/payments/previous/v2023-08-01/subscription/mandate/manage"},{"openapi":"openapi/payments/v2023-08-01.yaml post /subscriptions/pay/documents/{payment_id}","title":"API to upload file for Physical Nach Authorization.","href":"/api-reference/payments/previous/v2023-08-01/subscription/mandate/physical-nach-mandate"},{"openapi":"openapi/payments/v2023-08-01.yaml post /subscriptions/eligibility/payment_methods","title":"API to get all the payment method details available for subscription payments.","href":"/api-reference/payments/previous/v2023-08-01/subscription/mandate/payment-methods"},{"openapi":"openapi/payments/v2023-08-01.yaml post /subscriptions/charge/{payment_id}/transaction-return-summary/generate","title":"Generate Transaction Return Summary","href":"/api-reference/payments/previous/v2023-08-01/subscription/mandate/generate-transaction-summary"}]},{"group":"Payment","pages":[{"openapi":"openapi/payments/v2023-08-01.yaml post /subscriptions/pay","title":"Raise a charge or create an auth.","href":"/api-reference/payments/previous/v2023-08-01/subscription/payment/raise"},{"openapi":"openapi/payments/v2023-08-01.yaml get /subscriptions/{subscription_id}/payments/{payment_id}","title":"Fetch details of a single payment.","href":"/api-reference/payments/previous/v2023-08-01/subscription/payment/fetch"},{"openapi":"openapi/payments/v2023-08-01.yaml post /subscriptions/{subscription_id}/payments/{payment_id}/manage","title":"Manage a single payment.","href":"/api-reference/payments/previous/v2023-08-01/subscription/payment/manage"},{"openapi":"openapi/payments/v2023-08-01.yaml get /subscriptions/{subscription_id}/payments","title":"Fetch details of all payments of a subscription.","href":"/api-reference/payments/previous/v2023-08-01/subscription/payment/fetch-payments-for-mandate"}]},{"group":"Refund","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2023-08-01/subscription/refund/refund-apis-overview"},{"openapi":"openapi/payments/v2023-08-01.yaml post /subscriptions/{subscription_id}/refunds","title":"Create a refund.","href":"/api-reference/payments/previous/v2023-08-01/subscription/refund/create"},{"openapi":"openapi/payments/v2023-08-01.yaml get /subscriptions/{subscription_id}/refunds/{refund_id}","title":"Fetch details of a refund.","href":"/api-reference/payments/previous/v2023-08-01/subscription/refund/fetch"}]},{"title":"Redirection Payload After Authorisation","sidebarTitle":"Redirection Payload After Authorisation","href":"/api-reference/payments/previous/v2023-08-01/subscription/redirection-payload-after-authorization"},{"title":"Rate Limits","sidebarTitle":"Rate Limits","href":"/api-reference/payments/previous/v2023-08-01/subscription/rate-limits"},{"title":"Subscription Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/previous/v2023-08-01/subscription/webhooks"}]},{"group":"VBA","pages":[{"group":"Manage VBA","pages":[{"title":"Create VBA","openapi":"openapi/pgvba/pgvba.yaml post /pg/vba","href":"/api-reference/payments/previous/v2023-08-01/pgvba/create-vba"},{"title":"Edit VBA","openapi":"openapi/pgvba/pgvba.yaml put /pg/vba/{virtual_account_id}","href":"/api-reference/payments/previous/v2023-08-01/pgvba/edit-vba"},{"title":"Manage VBA","openapi":"openapi/pgvba/pgvba.yaml patch /pg/vba/{virtual_account_id}","href":"/api-reference/payments/previous/v2023-08-01/pgvba/manage-vba"},{"title":"Get VBA","openapi":"openapi/pgvba/pgvba.yaml get /pg/vba/{virtual_account_id}","href":"/api-reference/payments/previous/v2023-08-01/pgvba/get-vba"}]},{"group":"Payments","pages":[{"title":"Get VBA Payments","openapi":"openapi/pgvba/pgvba.yaml get /pg/vba/{virtual_account_id}","href":"/api-reference/payments/previous/v2023-08-01/pgvba/get-vba-payments"},{"title":"Get VBA Payments By UTR","openapi":"openapi/pgvba/pgvba.yaml get /pg/vba/payments/{utr}","href":"/api-reference/payments/previous/v2023-08-01/pgvba/get-vba-payments-by-utr"}]},{"group":"Notification Group","pages":[{"title":"Create VBA Notification Group","openapi":"openapi/pgvba/pgvba.yaml post /pg/vba/notificationgroup","href":"/api-reference/payments/previous/v2023-08-01/pgvba/create-vba-notification-group"},{"title":"Edit VBA Notification Group","openapi":"openapi/pgvba/pgvba.yaml put /pg/vba/notificationgroup/{notification_group_name}","href":"/api-reference/payments/previous/v2023-08-01/pgvba/edit-vba-notification-group"},{"title":"Manage VBA Notification Group Status","openapi":"openapi/pgvba/pgvba.yaml patch /pg/vba/notificationgroup/{notification_group_name}","href":"/api-reference/payments/previous/v2023-08-01/pgvba/manage-vba-notification-group-status"},{"title":"Get VBA Notification Group","openapi":"openapi/pgvba/pgvba.yaml get /pg/vba/notificationgroup/{notification_group_name}","href":"/api-reference/payments/previous/v2023-08-01/pgvba/get-vba-notification-group"}]}]},{"group":"International Payments","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2023-08-01/international-payments/overview"},{"group":"Collect from India","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/overview"},{"openapi":"openapi/cb-imports/merchant-spec.json post /import/transactions/{cf_payment_id}","title":"Upload Payment Verification Details","href":"/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/upload-payment-verification-details"},{"openapi":"get /import/transactions/{cf_payment_id}","title":"Get Payment Verification Details","href":"/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/get-payment-verification-details"},{"openapi":"openapi/cb-imports/merchant-spec.json get /import/orders/{order_id}/settlements","title":"Get Import Settlement Details for an Order","href":"/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/get-import-settlement-details"},{"openapi":"openapi/cb-imports/merchant-spec.json post /import/settlements/recon","title":"Get Import Settlement Recon Details","href":"/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/get-import-settlement-recon-details"},{"title":"Webhooks","sidebarTitle":"Webhooks","href":"/api-reference/payments/previous/v2023-08-01/international-payments/collect-from-india/import-webhooks"}]},{"group":"Collect from the World","pages":[{"group":"Global Collections","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/overview"},{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/endpoints"},{"title":"Purpose Codes","sidebarTitle":"Purpose Codes","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/purpose-codes"},{"group":"Authorization","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/partner/auth-overview"},{"title":"Get Auth Token","openapi":"post /gc/authorize","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/partner/auth-get-token"},{"title":"Verify Auth Token","openapi":"get /gc/token/verify","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/partner/auth-verify-token"}]},{"title":"Get Collection Accounts","openapi":"get /gc/virtual-accounts","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/partner/get-collection-accounts"},{"title":"Get Transactions","openapi":"get /gc/transactions","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/partner/get-transactions"},{"title":"Add Transaction Details","openapi":"post /gc/transactions/{referenceId}/invoice-details","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/partner/add-transaction-details"},{"title":"Simulate Transaction","openapi":"post /gc/transactions/emulate","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/partner/simulate-transaction"},{"title":"Webhook - Partner","sidebarTitle":"Webhook - Partner","href":"/api-reference/payments/previous/v2023-08-01/international-payments/global-collections/partner/webhooks"}]}]}]}]},{"group":"v2022-01-01","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/v2022-09-01/overview"},{"group":"Orders","pages":[{"openapi":"openapi/payments/v2022-09-01.yaml post /orders","title":"Create Order","href":"/api-reference/payments/previous/v2022-09-01/orders/create-order"},{"openapi":"openapi/payments/v2022-09-01.yaml get /orders/{order_id}","title":"Get Order","href":"/api-reference/payments/previous/v2022-09-01/orders/get-order"}]},{"group":"Payments","pages":[{"openapi":"openapi/payments/v2022-09-01.yaml post /orders/pay/authenticate/{cf_payment_id}","title":"Submit or Resend OTP","href":"/api-reference/payments/previous/v2022-09-01/payments/submit-or-resend-otp"},{"openapi":"openapi/payments/v2022-09-01.yaml post /orders/sessions","title":"Order Pay","href":"/api-reference/payments/previous/v2022-09-01/payments/order-pay"},{"openapi":"openapi/payments/v2022-09-01.yaml post /orders/{order_id}/authorization","title":"Preauthorization","href":"/api-reference/payments/previous/v2022-09-01/payments/preauthorization"},{"openapi":"openapi/payments/v2022-09-01.yaml get /orders/{order_id}/payments","title":"Get Payments for an Order","href":"/api-reference/payments/previous/v2022-09-01/payments/get-payments-for-an-order"},{"openapi":"openapi/payments/v2022-09-01.yaml get /orders/{order_id}/payments/{cf_payment_id}","title":"Get Payment by ID","href":"/api-reference/payments/previous/v2022-09-01/payments/get-payment-by-id"}]},{"group":"Payment Links","pages":[{"openapi":"openapi/payments/v2022-09-01.yaml post /links","title":"Create Payment Link","href":"/api-reference/payments/previous/v2022-09-01/payment-links/create-payment-link"},{"openapi":"openapi/payments/v2022-09-01.yaml get /links/{link_id}","title":"Fetch Payment Link Details","href":"/api-reference/payments/previous/v2022-09-01/payment-links/fetch-payment-link-details"},{"openapi":"openapi/payments/v2022-09-01.yaml post /links/{link_id}/cancel","title":"Cancel Payment Link","href":"/api-reference/payments/previous/v2022-09-01/payment-links/cancel-payment-link"},{"openapi":"openapi/payments/v2022-09-01.yaml get /links/{link_id}/orders","title":"Get Orders for a Payment Link","href":"/api-reference/payments/previous/v2022-09-01/payment-links/get-orders-for-a-payment-link"}]},{"group":"Refunds","pages":[{"openapi":"openapi/payments/v2022-09-01.yaml get /orders/{order_id}/refunds","title":"Get All Refunds for an Order","href":"/api-reference/payments/previous/v2022-09-01/refunds/get-all-refunds-for-an-order"},{"openapi":"openapi/payments/v2022-09-01.yaml post /orders/{order_id}/refunds","title":"Create Refund","href":"/api-reference/payments/previous/v2022-09-01/refunds/create-refund"},{"openapi":"openapi/payments/v2022-09-01.yaml get /orders/{order_id}/refunds/{refund_id}","title":"Get Refund","href":"/api-reference/payments/previous/v2022-09-01/refunds/get-refund"}]},{"group":"Token Vault","pages":[{"openapi":"openapi/payments/v2022-09-01.yaml get /customers/{customer_id}/instruments","title":"Fetch All Saved Card Instrument","href":"/api-reference/payments/previous/v2022-09-01/token-vault/fetch-all-saved-card-instrument"},{"openapi":"openapi/payments/v2022-09-01.yaml get /customers/{customer_id}/instruments/{instrument_id}","title":"Fetch Specific Saved Card Instrument","href":"/api-reference/payments/previous/v2022-09-01/token-vault/fetch-specific-saved-card-instrument"},{"openapi":"openapi/payments/v2022-09-01.yaml delete /customers/{customer_id}/instruments/{instrument_id}","title":"Delete Saved Card Instrument","href":"/api-reference/payments/previous/v2022-09-01/token-vault/delete-saved-card-instrument"},{"openapi":"openapi/payments/v2022-09-01.yaml get /customers/{customer_id}/instruments/{instrument_id}/cryptogram","title":"Fetch cryptogram for a saved card instrument","href":"/api-reference/payments/previous/v2022-09-01/token-vault/fetch-cryptogram-for-a-saved-card-instrument"}]},{"group":"Eligibility","pages":[{"openapi":"openapi/payments/v2022-09-01.yaml post /eligibility/cardlessemi","title":"Get Eligible Cardless EMI","href":"/api-reference/payments/previous/v2022-09-01/eligibility/get-eligible-cardless-emi"},{"openapi":"openapi/payments/v2022-09-01.yaml post /eligibility/offers","title":"Get Eligible Offers","href":"/api-reference/payments/previous/v2022-09-01/eligibility/get-eligible-offers"},{"openapi":"openapi/payments/v2022-09-01.yaml post /eligibility/paylater","title":"Get Eligible Paylater","href":"/api-reference/payments/previous/v2022-09-01/eligibility/get-eligible-paylater"},{"openapi":"openapi/payments/v2022-09-01.yaml post /eligibility/payment_methods","title":"Get Eligible Payment Methods","href":"/api-reference/payments/previous/v2022-09-01/eligibility/get-eligible-payment-methods"}]},{"group":"Offers","pages":[{"openapi":"openapi/payments/v2022-09-01.yaml post /offers","title":"Create Offer","href":"/api-reference/payments/previous/v2022-09-01/offers/create-offer"},{"openapi":"openapi/payments/v2022-09-01.yaml get /offers/{offer_id}","title":"Get Offer by ID","href":"/api-reference/payments/previous/v2022-09-01/offers/get-offer-by-id"}]},{"group":"Settlements","pages":[{"openapi":"openapi/payments/v2022-09-01.yaml get /orders/{order_id}/settlements","title":"Get Settlements by Order ID","href":"/api-reference/payments/previous/v2022-09-01/settlements/get-settlements-by-order-id"}]},{"group":"PG Reconciliation","pages":[{"openapi":"openapi/payments/v2022-09-01.yaml post /recon","title":"PG Reconciliation","href":"/api-reference/payments/previous/v2022-09-01/pg-reconciliation/pg-reconciliation"}]},{"group":"Settlement Reconciliation","pages":[{"title":"Settlement Reconciliation","openapi":"openapi/payments/v2022-09-01.yaml post /settlement/recon","href":"/api-reference/payments/previous/v2022-09-01/settlement-reconciliation/settlement-reconciliation"},{"openapi":"openapi/payments/v2022-09-01.yaml post /settlements","title":"Get All Settlements","href":"/api-reference/payments/previous/v2022-09-01/settlement-reconciliation/get-all-settlements"}]},{"group":"Offline Payments","pages":[{"title":"Offline Payments Webhooks","sidebarTitle":"Offline Payments Webhooks","href":"/api-reference/payments/previous/v2022-09-01/softpos/softpos-webhooks"},{"openapi":"openapi/payments/v2022-09-01.yaml post /terminal","title":"Create Terminal","href":"/api-reference/payments/previous/v2022-09-01/softpos/create-terminal"},{"openapi":"openapi/payments/v2022-09-01.yaml get /terminal/qrcodes","title":"Fetch Terminal QR Codes","href":"/api-reference/payments/previous/v2022-09-01/softpos/fetch-terminal-qr-codes"},{"openapi":"openapi/payments/v2022-09-01.yaml post /terminal/transactions","title":"Create Terminal","href":"/api-reference/payments/previous/v2022-09-01/softpos/create-terminal-1"},{"openapi":"openapi/payments/v2022-09-01.yaml get /terminal/{terminal_phone_no}","title":"Get terminal status using phone number","href":"/api-reference/payments/previous/v2022-09-01/softpos/get-terminal-status-using-phone-number"}]},{"group":"Subscription","pages":[{"title":"Postman Collection","sidebarTitle":"Postman Collection","href":"/api-reference/payments/previous/subscriptionsv1/subscription-postman-collection"},{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payments/previous/subscriptionsv1/endpoints"},{"title":"Physical Mandates","sidebarTitle":"Physical Mandates","href":"/api-reference/payments/previous/subscriptionsv1/physical-mandates"},{"group":"Seamless APIs","pages":[{"openapi":"post /api/v2/subscriptions/seamless/subscription","title":"Create Seamless Subscription with Plan ID","href":"/api-reference/payments/previous/subscriptionsv1/seamless-apis/create-seamless-subscription-with-plan-id"},{"openapi":"post /api/v2/subscriptions/seamless/authorization","title":"Create Authorization Request","href":"/api-reference/payments/previous/subscriptionsv1/seamless-apis/create-authorization-request"},{"openapi":"get /api/v2/subscriptions/seamless/authorization/{authId}/poll","title":"Get Authorization Status","href":"/api-reference/payments/previous/subscriptionsv1/seamless-apis/get-authorization-status"},{"openapi":"post /api/v2/subscriptions/seamless/authorization/simulate","title":"Update Authorization Status","href":"/api-reference/payments/previous/subscriptionsv1/seamless-apis/update-authorization-status"}]},{"group":"Subscription Refund","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/previous/subscriptionsv1/subscription-refund/refund-apis-overview"},{"openapi":"post /api/v2/subscriptions/create-refund","title":"Create Subscription Refund","href":"/api-reference/payments/previous/subscriptionsv1/subscription-refund/create-subscription-refund"},{"openapi":"get /api/v2/subscriptions/refund-details","title":"Get Subscription Refund Details","href":"/api-reference/payments/previous/subscriptionsv1/subscription-refund/get-subscription-refund-details"}]},{"group":"Subscription","pages":[{"openapi":"get /api/v2/subscriptions/{subReferenceId}","title":"Get Subscription Details","href":"/api-reference/payments/previous/subscriptionsv1/subscription/get-subscription-details"},{"openapi":"put /api/v2/subscriptions/{subReferenceId}/recurring-amount","title":"Update Recurring Amount","href":"/api-reference/payments/previous/subscriptionsv1/subscription/update-recurring-amount"},{"openapi":"get /api/v2/subscriptions/{subReferenceId}/payments","title":"Fetch Subscription Payments","href":"/api-reference/payments/previous/subscriptionsv1/subscription/fetch-subscription-payments"},{"openapi":"get /api/v2/subscriptions/{subReferenceId}/payments/{paymentId}","title":"Fetch Single Subscription Payment","href":"/api-reference/payments/previous/subscriptionsv1/subscription/fetch-single-subscription-payment"},{"openapi":"get /api/v2/subscriptions/payments/merchantTxnId/{merchantTxnId}","title":"Fetch Payment by Merchant Transaction ID","href":"/api-reference/payments/previous/subscriptionsv1/subscription/fetch-payment-by-merchant-transaction-id"},{"openapi":"post /api/v2/subscriptions/{subReferenceId}/cancel","title":"Cancel Subscription","href":"/api-reference/payments/previous/subscriptionsv1/subscription/cancel-subscription"},{"openapi":"put /api/v2/subscriptions/{subReferenceId}/pause-subscription","title":"Pause Subscription","href":"/api-reference/payments/previous/subscriptionsv1/subscription/pause-subscription"},{"openapi":"post /api/v2/subscriptions/{subReferenceId}/charge","title":"Charge Subscription","href":"/api-reference/payments/previous/subscriptionsv1/subscription/charge-subscription"},{"openapi":"post /api/v2/subscriptions/{subReferenceId}/charge-retry","title":"Retry Subscription Charge","href":"/api-reference/payments/previous/subscriptionsv1/subscription/retry-subscription-charge"},{"openapi":"post /api/v2/subscriptions/physical-mandate-file/upload","title":"Upload Physical Mandate File","href":"/api-reference/payments/previous/subscriptionsv1/subscription/upload-physical-mandate-file"},{"openapi":"post /api/v2/subscriptions/{subReferenceId}/activate","title":"Activate Subscription","href":"/api-reference/payments/previous/subscriptionsv1/subscription/activate-subscription"},{"openapi":"post /api/v2/subscription/{subReferenceId}/charge/{chargeId}/cancel","title":"Cancel Subscription Charge","href":"/api-reference/payments/previous/subscriptionsv1/subscription/cancel-subscription-charge"},{"openapi":"put /api/v2/subscriptions/charge/{paymentId}/simulate","title":"Update Charge Status","href":"/api-reference/payments/previous/subscriptionsv1/subscription/update-charge-status"},{"openapi":"post /api/v2/subscriptions/charge/{paymentId}/transaction-return-summary/generate","title":"Generate Transaction Return Summary","href":"/api-reference/payments/previous/subscriptionsv1/subscription/generate-transaction-return-summary"},{"openapi":"post /api/v2/subscription-plans","title":"Create a Subscription Plan","href":"/api-reference/payments/previous/subscriptionsv1/subscription/create-a-subscription-plan"},{"openapi":"post /api/v2/subscriptions/nonSeamless/subscription","title":"Create a Subscription","href":"/api-reference/payments/previous/subscriptionsv1/subscription/create-a-subscription"},{"openapi":"post /api/v2/subscriptions/mandate/port","title":"Port Mandate","href":"/api-reference/payments/previous/subscriptionsv1/subscription/port-mandate"}]},{"title":"Redirection Payload After Authorisation","sidebarTitle":"Redirection Payload After Authorisation","href":"/api-reference/payments/previous/subscriptionsv1/redirection-payload-after-authorization"},{"title":"Rate Limits","sidebarTitle":"Rate Limits","href":"/api-reference/payments/previous/subscriptionsv1/rate-limits"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/previous/subscriptionsv1/webhooks"}]}]}]}]},{"tab":"Payouts APIs","hidden":true,"groups":[{"group":"Payout APIs","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payouts/overview"},{"title":"Getting Started","sidebarTitle":"Getting Started","href":"/api-reference/payouts/getting-started-with-payouts-apis"},{"title":"Payouts Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payouts/webhooks-overview"},{"group":"Account","pages":[{"openapi":"get /payout/v1/getBalance","title":"Get Balance","href":"/api-reference/payouts/v1/get-balance"},{"openapi":"post /payout/v1/internalTransfer","title":"Internal Transfer","href":"/api-reference/payouts/v1/internal-transfer"},{"openapi":"post /payout/v1/selfWithdrawal","title":"Self Withdrawal","href":"/api-reference/payouts/v1/self-withdrawal"},{"openapi":"get /payout/v1.2/getBalance","title":"Get Balance V1.2","href":"/api-reference/payouts/v1/get-balance-v12"},{"openapi":"post /payout/v1.2/internalTransfer","title":"Internal Transfer V1.2","href":"/api-reference/payouts/v1/internal-transfer-v12"}]},{"group":"Authentication","pages":[{"openapi":"post /payout/v1/authorize","title":"Authorize","href":"/api-reference/payouts/v1/authorize"},{"openapi":"post /payout/v1/verifyToken","title":"Verify","href":"/api-reference/payouts/v1/verify-1"}]}]},{"group":"V2","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payouts/v2/payouts-api-v2-new"},{"group":"Transfers V2","pages":[{"openapi":"get /transfers","title":"Get Transfer Status V2","href":"/api-reference/payouts/v2/transfers-v2/get-transfer-status-v2"},{"openapi":"post /transfers","title":"Standard Transfer V2","href":"/api-reference/payouts/v2/transfers-v2/standard-transfer-v2"},{"openapi":"get /transfers/batch","title":"Get Batch Transfer Status V2","href":"/api-reference/payouts/v2/transfers-v2/get-batch-transfer-status-v2"},{"openapi":"post /transfers/batch","title":"Batch Transfer V2","href":"/api-reference/payouts/v2/transfers-v2/batch-transfer-v2"}]},{"group":"Beneficiary V2","pages":[{"openapi":"get /beneficiary","title":"Get Beneficiary V2","href":"/api-reference/payouts/v2/beneficiary-v2/get-beneficiary-v2"},{"openapi":"post /beneficiary","title":"Create Beneficiary V2","href":"/api-reference/payouts/v2/beneficiary-v2/create-beneficiary-v2"},{"openapi":"delete /beneficiary","title":"Remove Beneficiary V2","href":"/api-reference/payouts/v2/beneficiary-v2/remove-beneficiary-v2"}]},{"group":"Verify and Pay","pages":[{"openapi":"post /payout/validatePayout","title":"Validate Payout","href":"/api-reference/payouts/v2/validate-payout-v2"},{"openapi":"post /payout/transfers","title":"Process Validated Payout","href":"/api-reference/payouts/v2/verify-and-pay-transfers-v2"}]},{"title":"Webhooks Version V2","sidebarTitle":"Webhooks V2","icon":"webhook","href":"/api-reference/payouts/v2/webhooks/webhooks-v2"},{"title":"Response Codes","sidebarTitle":"Response Codes","href":"/api-reference/payouts/v2/response-codes"}]},{"group":"V1","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payouts/v1/payouts-api-overview"},{"group":"Batch Transfer V1.3","pages":[{"openapi":"get /payout/v1.3/getBatchTransferStatus","title":"Get Batch Transfer Status","href":"/api-reference/payouts/v1/get-batch-transfer-status-1"}]},{"group":"Beneficiary","pages":[{"openapi":"post /payout/v1/addBeneficiary","title":"Add Beneficiary","href":"/api-reference/payouts/v1/add-beneficiary"},{"openapi":"get /payout/v1/getBeneId","title":"Get Beneficiary ID","href":"/api-reference/payouts/v1/get-beneficiary-id"},{"openapi":"post /payout/v1/removeBeneficiary","title":"Remove Beneficiary","href":"/api-reference/payouts/v1/remove-beneficiary"},{"openapi":"get /payout/v1/getBeneficiary/{beneId}","title":"Get Beneficiary Details","href":"/api-reference/payouts/v1/get-beneficiary-details"},{"openapi":"get /payout/v1/beneHistory","title":"Get Beneficiary History","href":"/api-reference/payouts/v1/get-beneficiary-history"}]},{"group":"Incidents","pages":[{"openapi":"get /payout/v1/incidents","title":"Get Incidents","href":"/api-reference/payouts/v1/get-incidents"}]},{"group":"Transfers","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payouts/v1/transfer"},{"openapi":"get /payout/v1/getBatchTransferStatus","title":"Get Batch Transfer Status","href":"/api-reference/payouts/v1/get-batch-transfer-status"},{"openapi":"post /payout/v1/requestAsyncTransfer","title":"Standard Transfer Async","href":"/api-reference/payouts/v1/standard-transfer-async"},{"openapi":"get /payout/v1.1/getTransferStatus","title":"Get Transfer Status","href":"/api-reference/payouts/v1/get-transfer-status"},{"openapi":"post /payout/v1/requestTransfer","title":"Standard Transfer Sync","href":"/api-reference/payouts/v1/standard-transfer-sync"},{"openapi":"post /payout/v1/requestBatchTransfer","title":"Batch Transfer","href":"/api-reference/payouts/v1/batch-transfer"},{"openapi":"post /payout/v1/directTransfer","title":"Direct Transfer","href":"/api-reference/payouts/v1/direct-transfer"},{"openapi":"post /payout/v1/cardpay","title":"CardPay","href":"/api-reference/payouts/v1/cardpay"},{"openapi":"post /payout/v1/lend","title":"Lend","href":"/api-reference/payouts/v1/lend"}]},{"group":"Transfers V1.2","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payouts/v1/transfer-v12"},{"openapi":"post /payout/v1.2/requestTransfer","title":"Standard Transfer Sync v1.2","href":"/api-reference/payouts/v1/standard-transfer-sync-v12"},{"openapi":"get /payout/v1.2/getBatchTransferStatus","title":"Get Batch Transfer Status V1.2","href":"/api-reference/payouts/v1/get-batch-transfer-status-v12"},{"openapi":"post /payout/v1.2/requestAsyncTransfer","title":"Standard Transfer Async v1.2","href":"/api-reference/payouts/v1/standard-transfer-async-v12"},{"openapi":"post /payout/v1.2/requestBatchTransfer","title":"Batch Transfer V1.2","href":"/api-reference/payouts/v1/batch-transfer-v12"},{"openapi":"get /payout/v1.2/getTransferStatus","title":"Get Transfer Status V1.2","href":"/api-reference/payouts/v1/get-transfer-status-v12"},{"openapi":"post /payout/v1.2/directTransfer","title":"Direct Transfer V1.2","href":"/api-reference/payouts/v1/direct-transfer-v12"}]},{"group":"Verify and Pay","pages":[{"openapi":"post /payout/v1/validatePayout","title":"Validate Payout V1","href":"/api-reference/payouts/v1/validate-payout-v1"},{"openapi":"post /payout/v1/directTransfer","sidebarTitle":"Direct Transfer V1","title":"Direct Transfer","href":"/api-reference/payouts/v1/verify-and-pay-direct-transfer-v1"},{"openapi":"post /payout/v1.2/validatePayout","title":"Validate Payout V1.2","href":"/api-reference/payouts/v1/validate-payout-v1-2"},{"openapi":"post /payout/v1.2/directTransfer","sidebarTitle":"Direct Transfer V1.2","title":"Direct Transfer V1.2","href":"/api-reference/payouts/v1/verify-and-pay-direct-transfer-v1-2"}]},{"title":"Webhook Version V1","sidebarTitle":"Webhook Version V1","icon":"webhook","href":"/api-reference/payouts/v2/webhooks/webhooks-v1"}]},{"group":"One Escrow","pages":[{"openapi":"post /fundsources/connected/virtual-account","title":"Create Virtual Account","href":"/api-reference/payouts/v1/oneescrow/create-virtual-account"},{"openapi":"post /v1.2/internalTransfer","title":"Transfer Funds Between VAs","href":"/api-reference/payouts/v1/oneescrow/transfer-funds-between-vas"},{"openapi":"get /v1/accountStatement","title":"Get Account Statement","href":"/api-reference/payouts/v1/oneescrow/get-account-statement"},{"openapi":"post /v1/connected-wallet/recharge","title":"Allocate Funds to Virtual Account","href":"/api-reference/payouts/v1/oneescrow/recharge-oneescrow-account"},{"openapi":"get /v1/fundsources/{paymentInstrumentId}","title":"Get Fund Source Details","href":"/api-reference/payouts/v1/oneescrow/get-fund-source-details"},{"openapi":"post /v1/whitelisted-bank-accounts","title":"Add Registered Recharge Account(Whitelist Bank Account)","href":"/api-reference/payouts/v1/oneescrow/add-registered-recharge-accountwhitelist-bank-account"},{"openapi":"post /payout/v1/connected-wallet/debit","title":"Debit Connected Wallet","href":"/api-reference/payouts/v1/oneescrow/debit-connected-wallet"}]},{"group":"Cashgram","pages":[{"title":"End Points","sidebarTitle":"End Points","href":"/api-reference/payouts/v1/end-points"},{"title":"Postman Collection","sidebarTitle":"Postman Collection","href":"/api-reference/payouts/v1/cashgram-postman-collection"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payouts/v1/webhooks"},{"openapi":"post /payout/v1/createCashgram","title":"Create Cashgram","href":"/api-reference/payouts/v1/create-cashgram"},{"openapi":"post /payout/v1/deactivateCashgram","title":"Deactivate Cashgram","href":"/api-reference/payouts/v1/deactivate-cashgram"},{"openapi":"get /payout/v1/getCashgramStatus","title":"Get Cashgram Status","href":"/api-reference/payouts/v1/get-cashgram-status"},{"title":"Response Codes","sidebarTitle":"Response Codes","href":"/api-reference/payouts/v1/response-codes"}]}]},{"tab":"Secure ID APIs","hidden":true,"groups":[{"group":"Secure ID APIs","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/vrs/overview"},{"title":"Getting Started","sidebarTitle":"Getting Started","href":"/api-reference/vrs/getting-started"},{"title":"Server Side SDKs","sidebarTitle":"Server Side SDKs","href":"/api-reference/vrs/v2/sdk/verification-suite-server-sdks"},{"title":"API Rate Limits","sidebarTitle":"Rate Limits","icon":null,"iconType":"solid","href":"/api-reference/vrs/v2/verification-rate-limits"},{"group":"Webhooks","pages":[{"title":"Secure ID Webhooks","sidebarTitle":"Overview","icon":"webhook","href":"/api-reference/vrs/webhooks-overview"},{"title":"Webhook Signature Verification","sidebarTitle":"Signature Verification","icon":"webhook","iconType":"solid","href":"/api-reference/vrs/webhook-signature-verification"}]},{"title":"Data to Test Integration","sidebarTitle":"Data to Test Integration","icon":null,"iconType":"solid","href":"/api-reference/vrs/data-to-test-integration"}]},{"group":"V2","pages":[{"group":"Bank Account Verification","pages":[{"group":"BAV V2","pages":[{"group":"Sync","pages":[{"openapi":"post /bank-account/sync","title":"Bank Account Verification Sync V2","href":"/api-reference/vrs/v2/bav-v2/bank-account-verification-sync-v2"}]},{"group":"Async","pages":[{"openapi":"post /bank-account/async","title":"Bank Account Verification Async V2","href":"/api-reference/vrs/v2/bav-v2/bank-account-verification-async-v2"},{"openapi":"get /bank-account","title":"Get BAV Status V2","href":"/api-reference/vrs/v2/bav-v2/get-bav-status-v2"}]},{"group":"Bulk","pages":[{"openapi":"post /bank-account/bulk","title":"Bulk Bank Account Verification V2","href":"/api-reference/vrs/v2/bav-v2/bulk-bank-account-verification-v2"},{"openapi":"get /bank-account/bulk","title":"Get Bulk BAV Status V2","href":"/api-reference/vrs/v2/bav-v2/get-bulk-bav-status-v2"}]},{"title":"BAV Response Description","sidebarTitle":"BAV Response Description","icon":null,"iconType":"solid","href":"/api-reference/vrs/v2/bav-v2/bav-response-description"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/vrs/v2/bav-v2/webhooks-bank-account-verification"}]},{"group":"Reverse Penny Drop","pages":[{"openapi":"post /reverse-penny-drop","title":"Create Reverse Penny Drop Request","href":"/api-reference/vrs/v2/reverse-penny-drop/create-reverse-penny-drop-request"},{"openapi":"get /remitter/status","title":"Get Reverse Penny Drop Request Details","href":"/api-reference/vrs/v2/reverse-penny-drop/get-reverse-penny-drop-request-details"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/vrs/v2/reverse-penny-drop/webhooks-reverse-penny"}]},{"group":"UPI Penny Drop","pages":[{"openapi":"post /upi/penny-drop","title":"UPI Penny Drop Request","href":"/api-reference/vrs/v2/upi-penny-drop/create-upi-penny-drop-request"}]},{"group":"IFSC","pages":[{"openapi":"post /ifsc","title":"IFSC Verification V2","href":"/api-reference/vrs/v2/ifsc/ifsc-verification-v2"}]}]},{"group":"Video KYC","pages":[{"title":"Video KYC Integration","sidebarTitle":"Video KYC Integration","href":"/api-reference/vrs/v2/video-kyc/vkyc-integration"},{"openapi":"post /user","title":"Create User for Secure ID","href":"/api-reference/vrs/v2/video-kyc/add-user"},{"openapi":"post /vkyc","title":"Initiate Video KYC Request","href":"/api-reference/vrs/v2/video-kyc/initiate-vkyc"},{"openapi":"get /vkyc","title":"Get status of Video KYC","href":"/api-reference/vrs/v2/video-kyc/get-vkyc-status"},{"openapi":"post /oauth/token","title":"Create Auth Token to Initialise the SDK","href":"/api-reference/vrs/v2/video-kyc/oauth-token"},{"title":"Status Codes and Templates","sidebarTitle":"Status Codes and Templates","href":"/api-reference/vrs/v2/video-kyc/vkyc-descriptions"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/vrs/v2/video-kyc/webhook"},{"group":"IP","pages":[{"openapi":"post /ip","title":"Verify IP","href":"/api-reference/vrs/v2/ip/verify-ip"}]}]},{"group":"DigiLocker/Aadhaar","pages":[{"group":"DigiLocker","pages":[{"title":"DigiLocker Integration","sidebarTitle":"DigiLocker Integration","href":"/api-reference/vrs/v2/digilocker/digilocker-integration"},{"title":"React Native Integration","sidebarTitle":"React Native Integration","href":"/api-reference/vrs/v2/digilocker/digilocker-sdk"},{"openapi":"post /digilocker/verify-account","title":"Verify Account","href":"/api-reference/vrs/v2/digilocker/verify-digilocker-account"},{"openapi":"post /digilocker","title":"Create URL","href":"/api-reference/vrs/v2/digilocker/create-digilocker-url"},{"openapi":"get /digilocker","title":"Get Verification Status","href":"/api-reference/vrs/v2/digilocker/get-digilocker-verification-status"},{"openapi":"get /digilocker/document/{document_type}","title":"Get Document","href":"/api-reference/vrs/v2/digilocker/get-document-from-digilocker"},{"title":"DigiLocker Webhooks","sidebarTitle":"DigiLocker Webhooks","icon":"webhook","href":"/api-reference/vrs/v2/digilocker/webhooks-digilocker"}]},{"group":"Aadhaar","pages":[{"openapi":"post /aadhaar-masking","title":"Aadhaar Masking","href":"/api-reference/vrs/v2/aadhaar/aadhaar-masking"}]}]},{"group":"PAN","pages":[{"group":"PAN Sync","pages":[{"openapi":"post /pan","title":"Verify","href":"/api-reference/vrs/v2/pan/verify-pan-sync"},{"openapi":"get /pan/{reference_id}","title":"Get Status","href":"/api-reference/vrs/v2/pan/get-status-of-verify-pan-sync"}]},{"group":"PAN Bulk","pages":[{"openapi":"post /pan/bulk","title":"Verify","href":"/api-reference/vrs/v2/pan/verify-pan-in-bulk"},{"openapi":"get /pan/bulk","title":"Get Status","href":"/api-reference/vrs/v2/pan/get-status-for-verify-pan-in-bulk"}]},{"openapi":"post /pan-lite","title":"PAN Lite","href":"/api-reference/vrs/v2/pan/pan-lite"},{"openapi":"post /pan/advance","title":"PAN 360","href":"/api-reference/vrs/v2/pan/pan-360"},{"title":"PAN Status Codes","sidebarTitle":"PAN Status Codes","icon":null,"href":"/api-reference/vrs/v2/pan/pan-status-descriptions"}]},{"group":"1-Click Onboarding","pages":[{"group":"1-Click Onboarding(SDK)","pages":[{"title":"Integration Overview","sidebarTitle":"Integration Overview","href":"/api-reference/vrs/v2/1-click-onboarding/1-click-onboarding-sdk"},{"openapi":"post /user/data-availability","title":"Data Availability","href":"/api-reference/vrs/v2/1-click-onboarding/data-availability"},{"openapi":"post /oauth2/session","title":"Initiate OAuth","href":"/api-reference/vrs/v2/1-click-onboarding/initiate-oauth"},{"openapi":"post /oauth2/generate-token","title":"OAuth Access Token Generation","href":"/api-reference/vrs/v2/1-click-onboarding/oauth-access-token-generation"},{"openapi":"get /oauth2/user-details","title":"Fetch User Details From Access Token","href":"/api-reference/vrs/v2/1-click-onboarding/fetch-user-details-from-access-token"}]},{"group":"Mobile 360","pages":[{"openapi":"post /mobile360/otp/send","title":"Mobile 360 Send OTP Request","href":"/api-reference/vrs/v2/mobile-360-otp-flow/mobile-360-send-otp-request"},{"openapi":"post /mobile360/otp/verify","title":"Mobile 360 Verify OTP","href":"/api-reference/vrs/v2/mobile-360-otp-flow/mobile-360-verify-otp"}]},{"group":"Advanced Employment","pages":[{"openapi":"post /advance-employment","title":"Get Employment Details","href":"/api-reference/vrs/v2/advanced-employment/get-employment-details"}]}]},{"group":"Address Verification","pages":[{"group":"Reverse Geocoding","pages":[{"openapi":"post /reverse-geocoding","title":"Reverse Geocoding","href":"/api-reference/vrs/v2/reverse-geocoding/reverse-geocoding"}]},{"group":"Geocoding","pages":[{"openapi":"post /geocoding","title":"Geocoding","href":"/api-reference/vrs/v2/geocoding/geocoding"}]}]},{"group":"Biometric KYC","pages":[{"group":"Face Match","pages":[{"openapi":"post /face-match","title":"Face Match","href":"/api-reference/vrs/v2/face-match/face-match"}]},{"group":"Name Match","pages":[{"openapi":"post /name-match","title":"Verify Name Match","href":"/api-reference/vrs/v2/name-match/name-match"}]},{"group":"Face Liveness","pages":[{"openapi":"post /face-liveness","title":"Face Liveness Check","href":"/api-reference/vrs/v2/face-liveness/face-liveness"}]}]},{"group":"Smart OCR","pages":[{"openapi":"post /bharat-ocr","title":"Smart OCR","href":"/api-reference/vrs/v2/smart-ocr/smart-ocr"},{"group":"Success Responses","pages":[{"title":"Aadhaar","sidebarTitle":"Aadhaar","href":"/api-reference/vrs/v2/smart-ocr/success-responses/aadhaar"},{"title":"PAN","sidebarTitle":"PAN","href":"/api-reference/vrs/v2/smart-ocr/success-responses/pan"},{"title":"Driving Licence","sidebarTitle":"Driving Licence","href":"/api-reference/vrs/v2/smart-ocr/success-responses/DL"},{"title":"Voter ID","sidebarTitle":"Voter ID","href":"/api-reference/vrs/v2/smart-ocr/success-responses/voterId"},{"title":"Passport","sidebarTitle":"Passport","href":"/api-reference/vrs/v2/smart-ocr/success-responses/passport"},{"title":"Vehicle RC","sidebarTitle":"Vehicle RC","href":"/api-reference/vrs/v2/smart-ocr/success-responses/vehicle-rc"},{"title":"Cancelled Cheque","sidebarTitle":"Cancelled Cheque","href":"/api-reference/vrs/v2/smart-ocr/success-responses/cancelled-cheque"},{"title":"INVOICE","sidebarTitle":"Invoice","href":"/api-reference/vrs/v2/smart-ocr/success-responses/invoice"}]}]},{"group":"Officially Valid Documents(OVDs)","pages":[{"group":"Vehicle RC","pages":[{"openapi":"get /vehicle-rc","title":"Get Vehicle RC Status","href":"/api-reference/vrs/v2/vehicle-rc/get-vehicle-rc-details"},{"openapi":"post /vehicle-rc","title":"Verify Vehicle RC Details","href":"/api-reference/vrs/v2/vehicle-rc/get-vehicle-rc-details-1"}]},{"group":"Voter ID","pages":[{"openapi":"post /voter-id","title":"Verify Voter ID","href":"/api-reference/vrs/v2/voter-id/verify-voter-id"}]},{"group":"Driving License","pages":[{"openapi":"post /driving-license","title":"Verify Driving Licence Details","href":"/api-reference/vrs/v2/driving-license/verify-driving-licence-details"}]},{"group":"Passport","pages":[{"openapi":"post /passport","title":"Verify Passport","href":"/api-reference/vrs/v2/passport/verify-passport"}]}]},{"group":"E-sign","pages":[{"openapi":"post /esignature/document","title":"Upload Document For E-Sign","href":"/api-reference/vrs/v2/e-sign/upload-document-for-e-sign"},{"openapi":"post /esignature","title":"Create E-Sign Request","href":"/api-reference/vrs/v2/e-sign/create-e-sign-request"},{"openapi":"get /esignature","title":"Get E-Sign Status","href":"/api-reference/vrs/v2/e-sign/get-e-sign-status"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/vrs/v2/e-sign/webhooks-esign"}]},{"group":"KYC Links","pages":[{"openapi":"post /form","title":"Generate KYC Link","href":"/api-reference/vrs/v2/kyc-links/generate-form-link"},{"openapi":"get /form","title":"Get KYC Link Status","href":"/api-reference/vrs/v2/kyc-links/get-form-status"},{"openapi":"post /form/static-link","title":"Generate Static KYC Link","href":"/api-reference/vrs/v2/kyc-links/generate-static-link"},{"openapi":"delete /form/static-link","title":"Deactivate Static KYC Link","href":"/api-reference/vrs/v2/kyc-links/deactivate-static-link"},{"title":"Get Status","sidebarTitle":"Get Status","href":"/api-reference/vrs/v2/kyc-links/get-status"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/vrs/v2/kyc-links/webhooks"}]},{"group":"Know Your Business(KYBs)","pages":[{"group":"GSTIN","pages":[{"openapi":"post /gstin","title":"Verify GSTIN","href":"/api-reference/vrs/v2/gstin/verify-gstin"}]},{"group":"PAN to GSTIN","pages":[{"openapi":"post /pan-gstin","title":"Fetch GSTIN with PAN","href":"/api-reference/vrs/v2/pan-to-gstin/fetch-gstin-with-pan"}]},{"group":"CIN","pages":[{"openapi":"post /cin","title":"Verify CIN","href":"/api-reference/vrs/v2/cin/verify-cin"}]},{"group":"Udyam","pages":[{"openapi":"post /udyam","title":"Verify Udyam","href":"/api-reference/vrs/v2/udyam/verify-udyam"}]},{"group":"PAN to Udyam","pages":[{"openapi":"post /pan-udyam","title":"Fetch Udyam with PAN","href":"/api-reference/vrs/v2/pan-to-udyam/fetch-udyam-with-pan"}]}]}]},{"group":"V1 (Depricated API's)","pages":[{"group":"Bank Account Verification","pages":[{"openapi":"get /payout/v1.2/validation/bankDetails","title":"Bank Verification Sync V1.2","href":"/api-reference/vrs/v1/bank-account-verification/bank-verification-sync-v12"},{"openapi":"get /payout/v1/asyncValidation/bankDetails","title":"Bank Verification Async","href":"/api-reference/vrs/v1/bank-account-verification/bank-verification-async"},{"openapi":"get /payout/v1/getValidationStatus/bank","title":"Get Verification Status","href":"/api-reference/vrs/v1/bank-account-verification/get-verification-status"},{"openapi":"get /payout/v1/ifsc/{ifsc}","title":"IFSC Verification","href":"/api-reference/vrs/v1/bank-account-verification/ifsc-verification"},{"openapi":"post /payout/v1/bulkValidation/bankDetails","title":"Bulk Bank Verification","href":"/api-reference/vrs/v1/bank-account-verification/bulk-bank-verification"},{"openapi":"get /payout/v1/getBulkValidationStatus","title":"Get Bulk Verification Status","href":"/api-reference/vrs/v1/bank-account-verification/get-bulk-verification-status"}]}]}]},{"tab":"Additional APIs","hidden":true,"groups":[{"group":"Prepaid Payment Instrument APIs","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/prepaid-payment-instruments/overview"},{"title":"Getting Started","sidebarTitle":"Getting Started","href":"/api-reference/prepaid-payment-instruments/getting-started"},{"title":"PPI Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/prepaid-payment-instruments/webhooks-overview"},{"title":"Webhook Signature Verification","sidebarTitle":"Webhook Signature Verification","icon":"webhook","iconType":"solid","href":"/api-reference/prepaid-payment-instruments/webhook-signature-verification"},{"group":"Users","pages":[{"openapi":"openapi/ppi/ppi.yaml post /ppi/user","title":"Create User","href":"/api-reference/prepaid-payment-instruments/user-management/create-ppi-user"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/user/details","title":"Get User Details","href":"/api-reference/prepaid-payment-instruments/user-management/get-ppi-user-details"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/user/update","title":"Update User","href":"/api-reference/prepaid-payment-instruments/user-management/update-ppi-user"}]},{"group":"User KYC","pages":[{"openapi":"openapi/ppi/ppi.yaml post /ppi/kyc/vkyc","title":"Initiate Video KYC","href":"/api-reference/prepaid-payment-instruments/kyc-verification/video-kyc-verification"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/kyc/vkyc/details","title":"Get Video KYC Details","href":"/api-reference/prepaid-payment-instruments/kyc-verification/get-video-kyc-status"},{"title":"Video KYC Webhooks","sidebarTitle":"Video KYC Webhooks","icon":"webhook","href":"/api-reference/prepaid-payment-instruments/kyc-verification/webhook-vkyc"},{"title":"VKYC Status and Status-Code Mapping","sidebarTitle":"VKYC Status Mapping","icon":"list","href":"/api-reference/prepaid-payment-instruments/kyc-verification/vkyc-status-descriptions"}]},{"group":"Wallets","pages":[{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet","title":"Create Wallet","href":"/api-reference/prepaid-payment-instruments/wallet-management/create-wallet"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/credit","title":"Credit Wallet","href":"/api-reference/prepaid-payment-instruments/wallet-management/credit-wallet"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/debit","title":"Debit Wallet","href":"/api-reference/prepaid-payment-instruments/wallet-management/debit-wallet"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/debit/verify","title":"Verify Debit Wallet","href":"/api-reference/prepaid-payment-instruments/wallet-management/verify-debit-wallet"},{"title":"Debit Status and Status-Code Mapping","sidebarTitle":"Debit Status Mapping","icon":"list","href":"/api-reference/prepaid-payment-instruments/wallet-management/debit-status-descriptions"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/refund","title":"Refund Debit Wallet","href":"/api-reference/prepaid-payment-instruments/wallet-management/refund-wallet"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/closure","title":"Close Wallet","href":"/api-reference/prepaid-payment-instruments/wallet-management/close-wallet"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/eligibility","title":"Check Transaction Eligibility","href":"/api-reference/prepaid-payment-instruments/wallet-management/check-wallet-eligibility"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/details","title":"Get Wallet Details","href":"/api-reference/prepaid-payment-instruments/wallet-management/get-wallet-details"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/statement","title":"Get Wallet Statement","href":"/api-reference/prepaid-payment-instruments/wallet-management/get-wallet-statement"},{"title":"Wallet Webhooks","sidebarTitle":"Wallet Webhooks","icon":"webhook","href":"/api-reference/prepaid-payment-instruments/wallet-management/webhook-wallet"},{"title":"Card Webhooks","sidebarTitle":"Card Webhooks","icon":"webhook","href":"/api-reference/prepaid-payment-instruments/wallet-management/webhook-card"}]},{"group":"Beneficiaries","pages":[{"openapi":"openapi/ppi/ppi.yaml post /ppi/user/bene","title":"Create Beneficiary","href":"/api-reference/prepaid-payment-instruments/user-beneficiary/create-user-bene"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/user/bene/details","title":"Get Beneficiary Details","href":"/api-reference/prepaid-payment-instruments/user-beneficiary/get-user-bene"},{"openapi":"openapi/ppi/ppi.yaml delete /ppi/user/bene/remove","title":"Remove Beneficiary","href":"/api-reference/prepaid-payment-instruments/user-beneficiary/remove-user-bene"}]},{"group":"Transfers","pages":[{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/transfer","title":"Initiate Transfer","href":"/api-reference/prepaid-payment-instruments/transfers/initiate-transfer"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/transfer/verify","title":"Verify Transfer","href":"/api-reference/prepaid-payment-instruments/transfers/verify-transfer"},{"openapi":"openapi/ppi/ppi.yaml post /ppi/wallet/transfer/details","title":"Get Transfer Details","href":"/api-reference/prepaid-payment-instruments/transfers/get-transfer-details"},{"title":"Transfer Webhook Events","sidebarTitle":"Transfer Webhooks","icon":"webhook","href":"/api-reference/prepaid-payment-instruments/transfers/webhook-transfer"}]}]}]},{"tab":"Partners APIs","hidden":true,"groups":[{"group":"Platform APIs","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/platforms/overview"},{"title":"Partner Platform Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/platforms/latest/webhooks-overview"},{"title":"Getting Started","sidebarTitle":"Getting Started","href":"/api-reference/platforms/latest/merchant-onboarding/getting-started"}]},{"group":"v2023-08-01","pages":[{"group":"Merchant Onboarding APIs","pages":[{"openapi":"post /merchants","title":"Create Merchant","href":"/api-reference/platforms/latest/merchant-onboarding/create-merchant"},{"openapi":"get /merchants/{merchant_id}","title":"Get Merchant Status","href":"/api-reference/platforms/latest/merchant-onboarding/get-merchant-status"},{"openapi":"patch /merchants/{merchant_id}","title":"Update Merchant","href":"/api-reference/platforms/latest/merchant-onboarding/update-merchant"},{"openapi":"post /merchants/{merchant_id}/documents","title":"Upload Documents","href":"/api-reference/platforms/latest/merchant-onboarding/upload-documents"},{"openapi":"post /merchants/{merchant_id}/onboarding_link","title":"Create Embeddable Onboarding Link (does not require login)","href":"/api-reference/platforms/latest/merchant-onboarding/create-embeddable-onboarding-link-does-not-require-login"},{"openapi":"post /merchants/{merchant_id}/onboarding_link/standard","title":"Create Standard Onboarding Link (with login required by merchant)","href":"/api-reference/platforms/latest/merchant-onboarding/create-standard-onboarding-link-with-login-required-by-merchant"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/platforms/latest/merchant-onboarding/webhooks"}]}]}]},{"tab":"Additional APIs","hidden":true,"groups":[{"group":"BBPS for Business","pages":[{"title":"BBPS for Business","sidebarTitle":"Overview","href":"/api-reference/other-apis/bbps/overview"},{"title":"APIs to Implement","sidebarTitle":"APIs to Implement","href":"/api-reference/other-apis/bbps/apis-to-implement"},{"title":"Next Steps for Biller","sidebarTitle":"Next Steps for Biller","href":"/api-reference/other-apis/bbps/next-steps-for-biller"},{"openapi":"get /bbps/biller/bill/status/{bbps_transaction_id}","title":"Check Transaction Status","href":"/api-reference/other-apis/bbps/check-transaction-status"},{"title":"NPCI Onboarding Configurations","sidebarTitle":"NPCI Onboarding Configurations","href":"/api-reference/other-apis/bbps/npci-onboarding-configurations"}]},{"group":"BBPS for Customers","pages":[{"title":"BBPS for Customers","sidebarTitle":"Overview","href":"/api-reference/other-apis/bbps-cou/overview"},{"title":"Data to Test Integration","sidebarTitle":"Data to Test Integration","href":"/api-reference/other-apis/bbps-cou/data-to-test-integration"},{"title":"Synchronous Responses","sidebarTitle":"Synchronous responses","href":"/api-reference/other-apis/bbps-cou/synchronous-responses"},{"title":"Payment Scenarios","sidebarTitle":"Payment scenarios","href":"/api-reference/other-apis/bbps-cou/payment-scenarios"},{"group":"Billers","pages":[{"title":"Fetch Biller Categories","sidebarTitle":"Biller Categories","openapi":"openapi/bbps/bbps-cou.yaml get /bbps/cou/v1/billers/categories","href":"/api-reference/other-apis/bbps-cou/billers/categories"},{"title":"Fetch Biller MDM Details","sidebarTitle":"Biller MDM Details","openapi":"openapi/bbps/bbps-cou.yaml post /bbps/cou/v1/billers/info","href":"/api-reference/other-apis/bbps-cou/billers/info"}]},{"group":"Bill Fetch","pages":[{"title":"Bill Fetch Request","sidebarTitle":"Bill Fetch Request","openapi":"openapi/bbps/bbps-cou.yaml post /bbps/cou/v1/billers/request/bill-fetch","href":"/api-reference/other-apis/bbps-cou/bill-fetch/request"},{"title":"Bill Fetch Response","sidebarTitle":"Bill Fetch Response","openapi":"openapi/bbps/bbps-cou.yaml post /bbps/cou/v1/billers/response/bill-fetch","href":"/api-reference/other-apis/bbps-cou/bill-fetch/response"}]},{"group":"Bill Payment","pages":[{"title":"Bill Payment Request","sidebarTitle":"Bill Payment Request","openapi":"openapi/bbps/bbps-cou.yaml post /bbps/cou/v1/billers/request/bill-payment","href":"/api-reference/other-apis/bbps-cou/bill-payment/request"},{"title":"Bill Payment Response","sidebarTitle":"Bill Payment Response","openapi":"openapi/bbps/bbps-cou.yaml post /bbps/cou/v1/billers/response/bill-payment","href":"/api-reference/other-apis/bbps-cou/bill-payment/response"}]},{"group":"Ticket","pages":[{"title":"Raise a Ticket Request","sidebarTitle":"Ticket Request","openapi":"openapi/bbps/bbps-cou.yaml post /bbps/cou/v1/billers/request/ticket","href":"/api-reference/other-apis/bbps-cou/ticket/request"},{"title":"Poll Ticket Status Response","sidebarTitle":"Ticket Status Response","openapi":"openapi/bbps/bbps-cou.yaml post /bbps/cou/v1/billers/response/ticket-status","href":"/api-reference/other-apis/bbps-cou/ticket/response"}]},{"group":"Wallet","pages":[{"title":"Fetch Agent Institution Wallet Balance","sidebarTitle":"Wallet Balance","openapi":"openapi/bbps/bbps-cou.yaml get /bbps/cou/agent/{agentId}/wallet/balance","href":"/api-reference/other-apis/bbps-cou/wallet/balance"},{"title":"Fetch Agent Institution Wallet Ledger","sidebarTitle":"Wallet Ledger","openapi":"openapi/bbps/bbps-cou.yaml post /bbps/cou/agent/{agentId}/wallet/ledger","href":"/api-reference/other-apis/bbps-cou/wallet/ledger"}]},{"title":"Bill Fetch and Payment Error Codes","sidebarTitle":"Error Codes","href":"/api-reference/other-apis/bbps-cou/error-codes"},{"title":"COU Webhooks","sidebarTitle":"COU Webhooks","icon":"webhook","href":"/api-reference/other-apis/bbps-cou/webhooks"}]}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/overview"},{"title":"Rate Limits","sidebarTitle":"Rate Limits","href":"/api-reference/rate-limits"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"group":"Webhooks","pages":[{"title":"Cashfree Webhooks","sidebarTitle":"Overview","icon":"webhook","href":"/api-reference/webhooks/overview"},{"title":"Configure Endpoints","sidebarTitle":"Configure Endpoints","icon":"webhook","href":"/api-reference/webhooks/configure-endpoints"},{"title":"Events by Product","sidebarTitle":"Events by Product","icon":"webhook","href":"/api-reference/webhooks/events-by-product"},{"title":"Payloads and Signatures","sidebarTitle":"Payloads and Signatures","icon":"webhook","href":"/api-reference/webhooks/payloads-and-signatures"},{"title":"Reliability and Operations","sidebarTitle":"Reliability and Operations","icon":"webhook","href":"/api-reference/webhooks/reliability-and-operations"}]},{"title":"Postman Collections","sidebarTitle":"Postman Collections","icon":null,"href":"/api-reference/postman-collections"},{"title":"API Best Practices","sidebarTitle":"API Best Practices","href":"/api-reference/api-best-practices"},{"title":"Troubleshooting","sidebarTitle":"Troubleshooting","href":"/api-reference/integration-troubleshooting/overview-ts"}]}]},{"tab":"AI Stack","groups":[{"group":"Cashfree AI Stack","pages":[{"title":"Cashfree AI Stack","sidebarTitle":"Overview","href":"/tools-ai/overview"},{"title":"Cashfree Spark","sidebarTitle":"Spark","href":"/tools-ai/spark-ai"},{"group":"Relay","pages":[{"title":"Cashfree Relay","sidebarTitle":"Overview","href":"/tools-ai/relay/overview"},{"title":"Create Relay Agent","sidebarTitle":"Create Agent","href":"/tools-ai/relay/create-agent"},{"title":"Set Up Connections","sidebarTitle":"Set Up Connections","href":"/tools-ai/relay/add-connections"},{"title":"Manage Agents","sidebarTitle":"Manage Agents","href":"/tools-ai/relay/manage-agents"},{"title":"Relay FAQs","sidebarTitle":"FAQs","href":"/tools-ai/relay/faq"},{"group":"Archived","hidden":true,"pages":[{"title":"Relay MCP Server","sidebarTitle":"Relay MCP Server","href":"/tools-ai/relay/relay-mcp-server"},{"title":"Relay Skills","sidebarTitle":"Relay Skills","href":"/tools-ai/relay/skills"}]}]},{"title":"MCP Server","sidebarTitle":"MCP Server","href":"/tools-ai/mcp-server"},{"title":"Cashfree Agent Skills","sidebarTitle":"Agent Skills","href":"/tools-ai/cashfree-agent-skills"},{"title":"Cashfree Agent Toolkit","sidebarTitle":"Agent Toolkit","href":"/tools-ai/cashfree-agent-toolkit"},{"title":"Lovable Integration","sidebarTitle":"Lovable Integration","icon":null,"href":"/tools-ai/lovable-integration"},{"title":"Replit Integration","sidebarTitle":"Replit Integration","icon":null,"href":"/tools-ai/replit-integration"},{"title":"WhatsApp Assistant","sidebarTitle":"WhatsApp Assistant","href":"/tools-ai/whatsapp-assistant"},{"title":"Cashfree SDKs","sidebarTitle":"Software Development Kits","href":"/tools-ai/sdk"},{"title":"Cashfree HERE","sidebarTitle":"Cashfree HERE","href":"/tools-ai/cashfree-here"}]},{"group":"Cashfree Trust and Safety","pages":[{"title":"Security Features","sidebarTitle":"Security Features","href":"/security"}]}]},{"tab":"Help Center","groups":[{"group":"Help Center","pages":[{"title":"Cashfree FAQs","sidebarTitle":"Overview","href":"/help/overview"},{"group":"Create Account","pages":[{"title":"Account Overview","sidebarTitle":"Overview","href":"/help/account/overview"},{"title":"Account Activation","sidebarTitle":"Account Activation","href":"/help/account/account-activation"},{"title":"Account Management","sidebarTitle":"Account Management","href":"/help/account/account-management"},{"title":"Access Management","sidebarTitle":"Access Management","href":"/help/account/access-management"}]}]},{"group":"Account and Onboarding","pages":[{"title":"Account","sidebarTitle":"Account","href":"/help/account/faq"},{"title":"Account Onboarding","sidebarTitle":"Account Onboarding","href":"/help/onboarding-related/onboarding-faqs"},{"title":"Account Management","sidebarTitle":"Account Management","href":"/help/account/account-management-faqs"},{"title":"Access Management","sidebarTitle":"Access Management","href":"/help/account/access-management-faqs"},{"title":"Pricing","sidebarTitle":"Pricing","href":"/help/account/pricing"},{"title":"Terms and Conditions","sidebarTitle":"Terms and Conditions","href":"/help/account/termsandcondition"}]},{"group":"Payment Gateway","pages":[{"title":"General","sidebarTitle":"General","href":"/help/payments/transactions/generalfaqs"},{"title":"Transactions","sidebarTitle":"Transactions","href":"/help/payments/transactions/transactions"},{"title":"Settlements","sidebarTitle":"Settlements","href":"/help/payments/settlements/settlements"},{"title":"Integrations","sidebarTitle":"Integrations","href":"/help/payments/integrations/integrations"},{"title":"Orders and Payments","sidebarTitle":"Orders and Payments","href":"/help/payments/orders-and-payments/orders-and-payments"},{"title":"Transaction Reports","sidebarTitle":"Transaction Reports","href":"/help/payments/transaction-reports/transaction-reports"},{"title":"Offers","sidebarTitle":"Offers","href":"/help/payments/offers/offers"},{"title":"External Analytics","sidebarTitle":"External Analytics","href":"/help/payments/external-analytics/external-analytics"},{"title":"Product Walkthrough","sidebarTitle":"Product Walkthrough","href":"/help/payments/product-walkthrough/product-walkthrough"},{"title":"Payment Links","sidebarTitle":"Payment Links","href":"/help/payment-links/faqs/faqs"},{"title":"Payment Forms","sidebarTitle":"Payment Forms","href":"/help/payment-forms/faqs/faqs"},{"title":"Easy Split","sidebarTitle":"Easy Split","href":"/help/easy-split/faqs/faqs"},{"title":"Subscriptions","sidebarTitle":"Subscriptions","href":"/help/subscriptions/faqs/faqs"},{"title":"One Click Checkout","sidebarTitle":"One Click Checkout","href":"/help/one-click-checkout"},{"title":"FlowWise","sidebarTitle":"FlowWise","href":"/help/flowwise/general-faqs"},{"title":"SoftPOS","sidebarTitle":"SoftPOS","href":"/help/softpos/softpos"}]},{"group":"Payouts","pages":[{"title":"Payouts","sidebarTitle":"General","href":"/help/payouts/general-faqs"},{"title":"Cashgram","sidebarTitle":"Cashgram","href":"/help/payouts/Cashgram"},{"title":"IP Whitelist and Public Key","sidebarTitle":"IP Whitelist and Public Key","href":"/help/payouts/ip-whitelist"}]},{"group":"Secure ID","pages":[{"title":"Aadhaar Verification","sidebarTitle":"Aadhaar Verification","href":"/help/secure-id/aadhaar-verification"},{"title":"PAN Verification","sidebarTitle":"PAN Verification","href":"/help/secure-id/pan-verification"},{"title":"Bank Account Verification","sidebarTitle":"Bank Account Verification","href":"/help/secure-id/bav"},{"title":"Reverse Penny Drop","sidebarTitle":"Reverse Penny Drop","href":"/help/secure-id/reverse-penny-drop"},{"title":"GSTIN Verification","sidebarTitle":"GSTIN Verification","href":"/help/secure-id/gstin-verification"},{"title":"Secure ID","sidebarTitle":"General","href":"/help/secure-id/general-faqs"}]},{"group":"End Customer","pages":[{"title":"Disputes and Chargebacks","sidebarTitle":"Disputes and Chargebacks","href":"/help/end-customer/disputes-and-chargeback"},{"title":"Order and Delivery","sidebarTitle":"Order and Delivery","href":"/help/end-customer/order-and-delivery"},{"title":"Payment","sidebarTitle":"Payment","href":"/help/end-customer/payment-related"},{"title":"Refunds","sidebarTitle":"Refunds","href":"/help/end-customer/refunds"},{"title":"Fraud Prevention","sidebarTitle":"Fraud Prevention","href":"/help/end-customer/fraud-prevention"},{"title":"Report a Fraud","sidebarTitle":"Report a Fraud","href":"/help/end-customer/report-fraud"},{"title":"Subscriptions","sidebarTitle":"Subscriptions","href":"/help/end-customer/subscriptions"}]}]}]},"basePath":"","title":"AA Consent Status | Cashfree","buildId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","deploymentId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D_4Sesi0.js","utils-DRHeK26p.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6d-DUc2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dex7slho.js","snippetPresets-BcCEBp0Z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CufowNTX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-A4lJSCIe.js","shallow-DqoHP7zn.js","getApiPlaygroundDisplay-Cku8AmtL.js","CodeSnippet-CtHQbNqc.js","CodeSnippets-CGo5Cslf.js","Page-BoJxk0m8.js","getPastedJson-M-bKdue4.js","icon-DEqCU4st.js","MethodPill-DnfSSXiJ.js","DuplicateIcon-BHu2PE8M.js","createIcon-BPsE5X7c.js","DynamicMarkdown-Dnt6YhtR.js","SectionHeading-6CtFWqMQ.js","axios-vUo_bRtp.js","Markdown-BoKe_1fI.js","clsx-DM5-sUNJ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CkIdkovK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-B3e6Nh_r.js"]}