{
"status": "ERROR",
"subCode": "403",
"message": "APIs not enabled. Please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1)"
}
{
"status": "ERROR",
"subCode": "422",
"message": "Please provide a valid beneId"
}
Beneficiary
Get Beneficiary History
Use this API to fetch the transaction history for a particular beneficiary and for a desired period of time.
{
"status": "ERROR",
"subCode": "403",
"message": "APIs not enabled. Please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1)"
}
{
"status": "ERROR",
"subCode": "422",
"message": "Please provide a valid beneId"
}
This API will be retired soon. Please plan to migrate to the latest version, Beneficiary V2.
Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)
Click to view the response codes.
Sub code
Status
Message
Solution
200
SUCCESS
Data retrieved successfully.
-
403
ERROR
Token is invalid.
Validate the generated token.
405
ERROR
Invalid request URL or HTTP method.
422
ERROR
Requested date range is invalid.
Enter a valid date rage.
422
ERROR
Page value should be minimum 1.
Enter the page value as 1.
422
ERROR
Please provide a valid Beneficiary Id.
Enter a valid beneficiary ID.
422
ERROR
startDate should be of format yyyy-mm-dd
Enter the date range in the format: yyyy-mm-dd.
422
ERROR
endDate should be of format yyyy-mm-dd
Enter the date range in the format: yyyy-mm-dd.
422
ERROR
startDate should be less than or equal to EndDate
Enter a startDate value lesser than or equal to endDate.
422
ERROR
perPage should be at max 25
Enter the perPage value lesser than or equal to 25.
End date for the desired period. Format - yyyy-mm-dd. If start date is provided, end date is a mandatory. End date has to be a day less than current date.
{"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":"6ae3289d9195f5361a7eb44e","collectionId":"0b8859c3-9280-41c9-9a34-d222b127ff2d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3289d9195f5361a7eb44e"},"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":"6ae335c47704dba3b3b0e09e","clientVersion":"0.0.4006","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":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-enabled","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/payouts/v1/get-beneficiary-history","slug":"/api-reference/payouts/v1/get-beneficiary-history","pageMetadata":{"openapi":"get /payout/v1/beneHistory","og:title":"Beneficiary History v1 | Cashfree","og:description":"Audit past disbursals to a beneficiary by calling Cashfree Payouts v1 bene history, which returns transfer IDs, amounts, statuses, and timestamps.","keywords":["payouts API","disbursements","API reference","bank transfer","beneficiary management"],"title":"Get Beneficiary History","description":"Use this API to fetch the transaction history for a particular beneficiary and for a desired period of time.","href":"/api-reference/payouts/v1/get-beneficiary-history","hidden":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 fetch the transaction history for a particular beneficiary and for a desired period of time.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Accordion,OptimizedFrame,Table,Warning}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!OptimizedFrame)_missingMdxReference(`OptimizedFrame`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(Warning,{children:[` This API will be retired soon. Please plan to migrate to the latest version, `,_jsx(_components.a,{href:`/api-reference/payouts/v2/beneficiary-v2/get-beneficiary-v2`,children:`Beneficiary V2`}),`. `]}),`\n`,_jsx(_components.p,{children:`Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)`}),`\n`,_jsx(OptimizedFrame,{src:`https://www.cashfree.com/devstudio/preview/payouts/embed/bearerToken`,width:`600`}),`\n`,_jsx(Accordion,{title:`Click to view the response codes.`,id:`click-to-view-the-response-codes`,children:_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`Sub code`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Status`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Message`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Solution`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`200`}),_jsx(_components.td,{style:{textAlign:`left`},children:`SUCCESS`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Data retrieved successfully.`}),_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`-`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`403`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Token is invalid.`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Validate the generated token.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`405`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Invalid request URL or HTTP method.`}),_jsx(_components.td,{style:{textAlign:`left`}})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`422`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Requested date range is invalid.`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid date rage.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`422`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Page value should be minimum 1.`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter the page value as 1.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`422`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Please provide a valid Beneficiary Id.`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid beneficiary ID.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`422`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`startDate should be of format yyyy-mm-dd`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter the date range in the format: yyyy-mm-dd.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`422`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`endDate should be of format yyyy-mm-dd`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter the date range in the format: yyyy-mm-dd.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`422`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`startDate should be less than or equal to EndDate`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a startDate value lesser than or equal to endDate.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`422`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`perPage should be at max 25`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter the perPage value lesser than or equal to 25.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`429`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Too many requests.`}),_jsx(_components.td,{style:{textAlign:`left`}})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`520`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Unknown error occurred.`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Try again after some time.`})]})]})]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"openapi":"get /payout/v1/beneHistory","og:title":"Beneficiary History v1 | Cashfree","og:description":"Audit past disbursals to a beneficiary by calling Cashfree Payouts v1 bene history, which returns transfer IDs, amounts, statuses, and timestamps.","keywords":["payouts API","disbursements","API reference","bank transfer","beneficiary management"],"title":"Get Beneficiary History","description":"Use this API to fetch the transaction history for a particular beneficiary and for a desired period of time.","href":"/api-reference/payouts/v1/get-beneficiary-history","hidden":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":{"summary":"Get Beneficiary History","description":"Use this API to fetch the transaction history for a particular beneficiary and for a desired period of time.","operationId":"getbeneficiary-history","parameters":["49c99cd1-7395-4ebf-924c-83716143c5b9","7376d05b-cd57-4c94-a260-76d213d81373","9d769a51-0fa5-48cb-92d9-5c728d816adc","2595776a-1096-4af3-85a5-e7ce742fd47f","2024c1f1-289e-42dc-9eaf-1521c2632423","de3f91cd-b42e-4ff7-9dfd-3ab13e1d274f","2442dd78-6fbf-4641-be9b-b0dce5744653"],"responses":{"200":"804dcbc9-e55b-45d3-8725-a67cc4cfd583","403":"dd28d751-3dfc-4a34-95aa-8a4124872e7e","422":"c666490c-e537-41ba-94cb-782dd5f35da1"},"deprecated":false,"security":[],"x-readme":{"code-samples":[{"language":"curl","code":"curl --location --request GET 'https://payout-api.cashfree.com//payout/v1/beneHistory?beneId=VENKY_UPI\u0026startDate=2021-05-27\u0026endDate=2021-05-31\u0026perPage=10\u0026page=1' \\\n--header 'Authorization: Bearer \u003ctoken>'"}],"samples-languages":["curl"]},"method":"get","type":"path","servers":["9059d37a-cc35-4a70-8409-4ac1a3ae4ff5","bc9bb299-f28f-4c5a-a338-b653858c64be"],"path":"/payout/v1/beneHistory","baseUrlOptions":["https://payout-api.cashfree.com","https://payout-gamma.cashfree.com"],"title":"Get Beneficiary History","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"49c99cd1-7395-4ebf-924c-83716143c5b9":{"name":"beneId","in":"query","description":"The beneficiary id that you have created. Alphanumeric characters accepted.","required":true,"style":"form","explode":true,"schema":{"type":"string","isRequired":true,"description":"The beneficiary id that you have created. Alphanumeric characters accepted.","uniqueKey":"","typeLabel":"string"}},"7376d05b-cd57-4c94-a260-76d213d81373":{"name":"startDate","in":"query","description":"Start date for the desired period. Format - yyyy-mm-dd","required":false,"style":"form","explode":true,"schema":{"type":"string","isRequired":false,"description":"Start date for the desired period. Format - yyyy-mm-dd","uniqueKey":"","typeLabel":"string"}},"9d769a51-0fa5-48cb-92d9-5c728d816adc":{"name":"endDate","in":"query","description":"End date for the desired period. Format - yyyy-mm-dd. If start date is provided, end date is a mandatory. End date has to be a day less than current date.","required":false,"style":"form","explode":true,"schema":{"type":"string","isRequired":false,"description":"End date for the desired period. Format - yyyy-mm-dd. If start date is provided, end date is a mandatory. End date has to be a day less than current date.","uniqueKey":"","typeLabel":"string"}},"2595776a-1096-4af3-85a5-e7ce742fd47f":{"name":"perPage","in":"query","description":"Number of transactions to be displayed on the page. Maximum = 25. Default value set is 25.","required":false,"style":"form","explode":true,"schema":{"type":"number","format":"float","isRequired":false,"description":"Number of transactions to be displayed on the page. Maximum = 25. Default value set is 25.","uniqueKey":"","typeLabel":"number\u003cfloat>"}},"2024c1f1-289e-42dc-9eaf-1521c2632423":{"name":"page","in":"query","description":"Will show the latest transfers on the first page. Minimum = 1. Default value set is 1.","required":false,"style":"form","explode":true,"schema":{"type":"number","format":"float","isRequired":false,"description":"Will show the latest transfers on the first page. Minimum = 1. Default value set is 1.","uniqueKey":"","typeLabel":"number\u003cfloat>"}},"de3f91cd-b42e-4ff7-9dfd-3ab13e1d274f":{"name":"Authorization","in":"header","description":"Bearer auth token","required":true,"style":"simple","explode":false,"schema":{"type":"string","isRequired":true,"description":"Bearer auth token","uniqueKey":"","typeLabel":"string"}},"2442dd78-6fbf-4641-be9b-b0dce5744653":{"name":"Content-Type","in":"header","description":"application/json","required":true,"style":"simple","explode":false,"schema":{"type":"string","isRequired":true,"description":"application/json","uniqueKey":"","typeLabel":"string"}}},"responses":{"804dcbc9-e55b-45d3-8725-a67cc4cfd583":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"SUCCESS","uniqueKey":"status","typeLabel":"string"},"subCode":{"type":"string","example":"200","uniqueKey":"subCode","typeLabel":"string"},"message":{"type":"string","example":"Data retrieved successfully","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"transfers":{"type":"array","items":{"type":"object","properties":{"transferDate":{"type":"string","example":"2020-06-16T00:00:00.000Z","uniqueKey":"data.transfers.items.[INDEX].transferDate","typeLabel":"string"},"amount":{"type":"string","example":"1","uniqueKey":"data.transfers.items.[INDEX].amount","typeLabel":"string"},"mode":{"type":"string","example":"IMPS","uniqueKey":"data.transfers.items.[INDEX].mode","typeLabel":"string"},"beneId":{"type":"string","example":"John Doe","uniqueKey":"data.transfers.items.[INDEX].beneId","typeLabel":"string"},"status":{"type":"string","example":"SUCCESS","uniqueKey":"data.transfers.items.[INDEX].status","typeLabel":"string"}},"uniqueKey":"data.transfers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.transfers","typeLabel":"object[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Result":{"title":"Result","value":{"status":"SUCCESS","subCode":"200","message":"Data retrieved successfully","data":{"transfers":[{"transferDate":"2020-06-16T00:00:00.000Z","amount":"1","mode":"IMPS","beneId":"John Doe","status":"SUCCESS"},{"transferDate":"2020-05-28T00:00:00.000Z","amount":"1","mode":"NEFT","beneId":"John Doe","status":"SUCCESS"},{"transferDate":"2020-05-15T00:00:00.000Z","amount":"1.1","mode":"IMPS","beneId":"John Doe","status":"SUCCESS"},{"transferDate":"2020-05-15T00:00:00.000Z","amount":"1.1","mode":"IMPS","beneId":"John Doe","status":"SUCCESS"},{"transferDate":"2020-05-15T00:00:00.000Z","amount":"1","mode":"IMPS","beneId":"John Doe","status":"SUCCESS"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"dd28d751-3dfc-4a34-95aa-8a4124872e7e":{"description":"403","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"ERROR","uniqueKey":"status","typeLabel":"string"},"subCode":{"type":"string","example":"403","uniqueKey":"subCode","typeLabel":"string"},"message":{"type":"string","example":"APIs not enabled. Please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\u0026raise_issue=1)","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"ERROR","subCode":"403","message":"APIs not enabled. Please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\u0026raise_issue=1)"}}},"exampleType":"generated"}},"exampleType":"generated"},"c666490c-e537-41ba-94cb-782dd5f35da1":{"description":"422","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"ERROR","uniqueKey":"status","typeLabel":"string"},"subCode":{"type":"string","example":"422","uniqueKey":"subCode","typeLabel":"string"},"message":{"type":"string","example":"Please provide a valid beneId","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"ERROR","subCode":"422","message":"Please provide a valid beneId"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"9059d37a-cc35-4a70-8409-4ac1a3ae4ff5":{"url":"https://payout-api.cashfree.com","description":"Production"},"bc9bb299-f28f-4c5a-a338-b653858c64be":{"url":"https://payout-gamma.cashfree.com","description":"Sandbox"}}},"originalFileLocation":"openapi/payouts/payoutsv1.yaml"},"subdomain":"cashfreepayments-d00050e9","siteName":"Cashfree Developer Documentation","title":"Beneficiary History v1 | Cashfree","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"manual"},"contextualStarterQuestions":[{"_id":"6a79b16b3629fc88876dfc50","deploymentId":"66d5827f2de686bc28e7722b","questionText":"What date format should I use?","status":"active","generatedBy":"contextual","path":"api-reference/payouts/v1/get-beneficiary-history","createdAt":"2026-08-10T11:09:31.968Z","updatedAt":"2026-08-10T11:09:31.968Z","__v":0},{"_id":"6a79b16b3629fc88876dfc51","deploymentId":"66d5827f2de686bc28e7722b","questionText":"How do I fix invalid tokens?","status":"active","generatedBy":"contextual","path":"api-reference/payouts/v1/get-beneficiary-history","createdAt":"2026-08-10T11:09:31.968Z","updatedAt":"2026-08-10T11:09:31.968Z","__v":0},{"_id":"6a79b16b3629fc88876dfc4f","deploymentId":"66d5827f2de686bc28e7722b","questionText":"How do I get beneficiary history?","status":"active","generatedBy":"contextual","path":"api-reference/payouts/v1/get-beneficiary-history","createdAt":"2026-08-10T11:09:31.968Z","updatedAt":"2026-08-10T11:09:31.968Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-13T12:29:17.222Z","originalFileLocation":"api-reference/payouts/v1/get-beneficiary-history.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 fetch the transaction history for a particular beneficiary and for a desired period of time.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cashfree Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/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=\"Beneficiary History v1 | Cashfree\">\u003cmeta data-mint-head property=\"og:description\" content=\"Audit past disbursals to a beneficiary by calling Cashfree Payouts v1 bene history, which returns transfer IDs, amounts, statuses, and timestamps.\">\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/payouts/v1/get-beneficiary-history\">\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=Beneficiary\u0026amp;title=Get+Beneficiary+History\u0026amp;description=Use+this+API+to+fetch+the+transaction+history+for+a+particular+beneficiary+and+for+a+desired+period+of+time.\u0026amp;theme=2adde9c6a50d91a75e16dbfe\u0026amp;signature=370dbc542b3d1882449a2fa0e8d5c82b4e348a2a6cc6bc15077b36c516ef86f3\">\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=\"Beneficiary History v1 | Cashfree\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Audit past disbursals to a beneficiary by calling Cashfree Payouts v1 bene history, which returns transfer IDs, amounts, statuses, and timestamps.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cashfreepayments-d00050e9.mintlify.app/_mintlify/api/og/v2?division=Beneficiary\u0026amp;title=Get+Beneficiary+History\u0026amp;description=Use+this+API+to+fetch+the+transaction+history+for+a+particular+beneficiary+and+for+a+desired+period+of+time.\u0026amp;theme=2adde9c6a50d91a75e16dbfe\u0026amp;signature=370dbc542b3d1882449a2fa0e8d5c82b4e348a2a6cc6bc15077b36c516ef86f3\">\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/payouts/v1/get-beneficiary-history\">\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/payouts/v1/get-beneficiary-history.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.cashfree.com/#organization\",\"name\":\"Cashfree Developer Documentation\",\"url\":\"https://www.cashfree.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cashfreepayments-d00050e9/6mQw7is1us8FhXrb/static/logo/light.svg?fit=max\u0026auto=format\u0026n=6mQw7is1us8FhXrb\u0026q=85\u0026s=8a2837083063d8a01e0be6b454a1baf1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.cashfree.com/docs#website\",\"name\":\"Cashfree Developer Documentation\",\"url\":\"https://www.cashfree.com/docs\",\"publisher\":{\"@id\":\"https://www.cashfree.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.cashfree.com/docs/api-reference/payouts/v1/get-beneficiary-history#webpage\",\"url\":\"https://www.cashfree.com/docs/api-reference/payouts/v1/get-beneficiary-history\",\"name\":\"Get Beneficiary History\",\"description\":\"Use this API to fetch the transaction history for a particular beneficiary and for a desired period of time.\",\"dateModified\":\"2026-04-13T12:29:17.222Z\",\"isPartOf\":{\"@id\":\"https://www.cashfree.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.cashfree.com/docs/api-reference/payouts/v1/get-beneficiary-history#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.cashfree.com/docs/api-reference/payouts/v1/get-beneficiary-history#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"V1\",\"item\":\"https://www.cashfree.com/docs/api-reference/payouts/v1/payouts-api-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Beneficiary\",\"item\":\"https://www.cashfree.com/docs/api-reference/payouts/v1/add-beneficiary\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Beneficiary History\",\"item\":\"https://www.cashfree.com/docs/api-reference/payouts/v1/get-beneficiary-history\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.cashfree.com/docs/api-reference/payouts/v1/get-beneficiary-history#apireference\",\"headline\":\"Get Beneficiary History\",\"name\":\"Get Beneficiary History\",\"description\":\"Use this API to fetch the transaction history for a particular beneficiary and for a desired period of time.\",\"url\":\"https://www.cashfree.com/docs/api-reference/payouts/v1/get-beneficiary-history\",\"mainEntityOfPage\":{\"@id\":\"https://www.cashfree.com/docs/api-reference/payouts/v1/get-beneficiary-history#webpage\"},\"dateModified\":\"2026-04-13T12:29:17.222Z\",\"keywords\":\"payouts API, disbursements, API reference, bank transfer, beneficiary management\",\"publisher\":{\"@id\":\"https://www.cashfree.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.cashfree.com/docs#website\"}}]}\u003c/script>\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","pages":[{"title":"Payments","href":"/payments/introduction"}]},{"tab":"Payouts","pages":[{"title":"Payouts","href":"/payouts/payouts/introduction"}]},{"tab":"Secure ID","pages":[{"title":"Secure ID","href":"/secure-id/introduction"}]},{"tab":"Partners and Platforms","pages":[{"title":"Partners and Platforms","href":"/partners/introduction"}]},{"tab":"Payments APIs","hidden":true,"pages":[{"title":"Payments APIs","href":"/api-reference/payments/overview"}]},{"tab":"Payouts APIs","hidden":true,"groups":[{"group":"Payout APIs","pages":[{"title":"Overview","sidebarTitle":"Overview","description":"Explore the Cashfree Payouts APIs that disburse funds to bank accounts, UPI IDs, and cards with sandbox endpoints, authentication, and webhooks.","href":"/api-reference/payouts/overview"},{"title":"Getting Started","sidebarTitle":"Getting Started","description":"Review the prerequisites, sandbox credentials, IP whitelisting, and signature setup you need before testing Cashfree Payouts APIs in your integration.","href":"/api-reference/payouts/getting-started-with-payouts-apis"},{"title":"Payouts Webhooks","sidebarTitle":"Webhooks","icon":"webhook","description":"Consolidated index for Payouts webhook documentation, including V2 JSON webhooks, legacy V1 webhooks, Cashgram, dashboard setup, and signature rules.","href":"/api-reference/payouts/webhooks-overview"},{"group":"Account","pages":[{"openapi":"get /payout/v1/getBalance","title":"Get Balance","description":"Use this API to get the ledger balance and available balance of your account. Available balance is ledger balance minus the sum of all pending transfers (transfers triggered and processing or pending now).","href":"/api-reference/payouts/v1/get-balance"},{"openapi":"post /payout/v1/internalTransfer","title":"Internal Transfer","description":"Use this API to request an internal transfer at Cashfree. The internal transfer API is useful for multiple Payouts accounts. The API response will either result in an ERROR or SUCCESS response.","href":"/api-reference/payouts/v1/internal-transfer"},{"openapi":"post /payout/v1/selfWithdrawal","title":"Self Withdrawal","description":"Use this API to request a self withdrawal at Cashfree. Self withdrawal is allowed a maximum of 3 times a day. The API response will either result in an ERROR or SUCCESS response. The status of the withdrawal request is available on the dashboard.","href":"/api-reference/payouts/v1/self-withdrawal"},{"openapi":"get /payout/v1.2/getBalance","title":"Get Balance V1.2","description":"Use this API to get the ledger balance and available balance of your account. Available balance is ledger balance minus the sum of all pending transfers (transfers triggered and processing or pending now).","href":"/api-reference/payouts/v1/get-balance-v12"},{"openapi":"post /payout/v1.2/internalTransfer","title":"Internal Transfer V1.2","description":"Use this API to request an internal transfer. It is useful for accounts with multiple fund sources. You need to provide either the rechargeAccount or paymentInstrumentId and toPaymentInstrumentId along with the amount.","href":"/api-reference/payouts/v1/internal-transfer-v12"}]},{"group":"Authentication","pages":[{"openapi":"post /payout/v1/authorize","title":"Authorize","description":"Use this API to authenticate with the Cashfree system and obtain the authorization bearer token. All other API calls must have this token as Authorization header in the format 'Bearer \u003ctoken>' (without quotes) for them to get processed.","href":"/api-reference/payouts/v1/authorize"},{"openapi":"post /payout/v1/verifyToken","title":"Verify","description":"Verify the bearer token generated. If the token does not exist, is invalid, or has expired, the response \"Token is not valid\" is returned. Regenerate token in case of token expiry for making API calls ( use /payout/v1/authorize for this).","href":"/api-reference/payouts/v1/verify-1"}]}]},{"group":"V2","pages":[{"title":"Overview","sidebarTitle":"Overview","description":"Learn the benefits of upgrading to Cashfree Payouts v2 APIs, including the unified transfers endpoint, richer beneficiary management, and v1 to v2 migration.","href":"/api-reference/payouts/v2/payouts-api-v2-new"},{"group":"Transfers V2","pages":[{"openapi":"get /transfers","title":"Get Transfer Status V2","description":"Use this API to get the status of the initiated transfer. You can use either the transfer_id or cf_transfer_id to fetch the details.","href":"/api-reference/payouts/v2/transfers-v2/get-transfer-status-v2"},{"openapi":"post /transfers","title":"Standard Transfer V2","description":"Use this API to initiate an amount transfer at Cashfree. It is an async request by default.","href":"/api-reference/payouts/v2/transfers-v2/standard-transfer-v2"},{"openapi":"get /transfers/batch","title":"Get Batch Transfer Status V2","description":"Use this API to get the status of the initiated batch transfer. You can use either the batch_transfer_id or cf_batch_transfer_id to fetch the details.","href":"/api-reference/payouts/v2/transfers-v2/get-batch-transfer-status-v2"},{"openapi":"post /transfers/batch","title":"Batch Transfer V2","description":"Use this API to initiate a batch transfer request at Cashfree. You can transfer money to multiple beneficiaries. The batch transfer limit is 5,000 in the production environment and 1,000 by default in the test environment.","href":"/api-reference/payouts/v2/transfers-v2/batch-transfer-v2"}]},{"group":"Beneficiary V2","pages":[{"openapi":"get /beneficiary","title":"Get Beneficiary V2","description":"Use this API to get the details of a particular beneficiary from your account. You can pass either beneficiary_id or the combination of bank_account_number and bank_ifsc to fetch the details.","href":"/api-reference/payouts/v2/beneficiary-v2/get-beneficiary-v2"},{"openapi":"post /beneficiary","title":"Create Beneficiary V2","description":"Use this API to add a beneficiary to your Cashfree account by providing the bank account number, IFSC, and other required details. Ensure the successful creation of the benficiary in your account before initiating a transfer.","href":"/api-reference/payouts/v2/beneficiary-v2/create-beneficiary-v2"},{"openapi":"delete /beneficiary","title":"Remove Beneficiary V2","description":"Use this API to remove an existing beneficiary from the list of added beneficiaries.","href":"/api-reference/payouts/v2/beneficiary-v2/remove-beneficiary-v2"}]},{"group":"Verify and Pay","pages":[{"openapi":"post /payout/validatePayout","title":"Validate Payout","description":"Validates a UPI VPA or phone number and returns a single-use transfer token valid for one hour. Pass this token to the [Process Validated Payout API](/docs/api-reference/payouts/v2/verify-and-pay-transfers-v2) (`POST /payout/transfers`) to initiate the payout.\n\nIn the request body, pass the value for exactly one of `vpa` or `phone`, not both.\n\nThe response contains either basic or advanced VPA details. Advanced details include IFSC branch information. To enable advanced details for your account, fill the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\u0026raise_issue=1).\n","href":"/api-reference/payouts/v2/validate-payout-v2"},{"openapi":"post /payout/transfers","title":"Process Validated Payout","description":"Initiates a UPI payout using the transfer token returned by the [Validate Payout API](/docs/api-reference/payouts/v2/validate-payout-v2). The token is single-use and expires after one hour. When you use a transfer token, only `upi` is supported as the transfer mode.\n\nThe `transfer_id` in this request must match the `transfer_id` you used in that Validate Payout call.\n\nOptionally set `fundsource_id` to the connected bank account to use as the fund source.\n","href":"/api-reference/payouts/v2/verify-and-pay-transfers-v2"}]},{"title":"Webhooks Version V2","sidebarTitle":"Webhooks V2","description":"Set up Cashfree Payouts v2 webhooks to receive HTTP callbacks for transfer events, configure retries, whitelist Cashfree IPs, and explore sample event payloads.","icon":"webhook","href":"/api-reference/payouts/v2/webhooks/webhooks-v2"},{"title":"Response Codes","sidebarTitle":"Response Codes","description":"Look up Cashfree Payouts v2 response codes for beneficiary and transfer APIs, with HTTP status, error subcodes, sample messages, and recommended next actions.","href":"/api-reference/payouts/v2/response-codes"}]},{"group":"V1","pages":[{"title":"Overview","sidebarTitle":"Overview","description":"Use Cashfree Payouts v1 APIs to send funds to bank accounts, UPI IDs, cards, and wallets, with sandbox and production keys, request parameters, and error codes.","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","description":"Use this API to get the status of the Batch Transfer.","href":"/api-reference/payouts/v1/get-batch-transfer-status-1"}]},{"group":"Beneficiary","pages":[{"openapi":"post /payout/v1/addBeneficiary","title":"Add Beneficiary","description":"Use this API to add a beneficiary to your Cashfree account by providing the bank account number, IFSC, and other required details. Before you request a transfer, ensure the account has been successfully added as a beneficiary.","href":"/api-reference/payouts/v1/add-beneficiary"},{"openapi":"get /payout/v1/getBeneId","title":"Get Beneficiary ID","description":"Use this API to get the beneficiary ID by providing the bank account number and ifsc.","href":"/api-reference/payouts/v1/get-beneficiary-id"},{"openapi":"post /payout/v1/removeBeneficiary","title":"Remove Beneficiary","description":"Use this API to remove an existing beneficiary from a list of added beneficiaries.","href":"/api-reference/payouts/v1/remove-beneficiary"},{"openapi":"get /payout/v1/getBeneficiary/{beneId}","title":"Get Beneficiary Details","description":"Use this API to get the details of a particular beneficiary in your account.","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","description":"Use this API to get the list of incidents on banks(Resolved,Unresolved,All) for a given time range.","href":"/api-reference/payouts/v1/get-incidents"}]},{"group":"Transfers","pages":[{"title":"Overview","sidebarTitle":"Overview","description":"Transfer funds to your beneficiaries through Cashfree Payouts v1 using bank transfers, Paytm, Amazon Pay, UPI, IMPS, and NEFT, with sync and async modes.","href":"/api-reference/payouts/v1/transfer"},{"openapi":"get /payout/v1/getBatchTransferStatus","title":"Get Batch Transfer Status","description":"Use this API to get the status of the Batch Transfer.","href":"/api-reference/payouts/v1/get-batch-transfer-status"},{"openapi":"post /payout/v1/requestAsyncTransfer","title":"Standard Transfer Async","description":"Use this API to initiate an amount transfer request at Cashfree by providing beneficiary id, amount, and transfer id. This is an async transfer request.","href":"/api-reference/payouts/v1/standard-transfer-async"},{"openapi":"get /payout/v1.1/getTransferStatus","title":"Get Transfer Status","description":"Use these details to get details of a particular transfer. You can pass referenceId or transferId to fetch the details.","href":"/api-reference/payouts/v1/get-transfer-status"},{"openapi":"post /payout/v1/requestTransfer","title":"Standard Transfer Sync","description":"Use this API to initiate an amount transfer request at Cashfree by providing beneficiary id, amount, and transfer id. This is a sync transfer request.","href":"/api-reference/payouts/v1/standard-transfer-sync"},{"openapi":"post /payout/v1/requestBatchTransfer","title":"Batch Transfer","description":"Use this API to create multiple transfers to multiple beneficiaries. This API accepts an array of transfer objects under the batch field.","href":"/api-reference/payouts/v1/batch-transfer"},{"openapi":"post /payout/v1/directTransfer","title":"Direct Transfer","description":"Use this API to initiate amount transfers directly to the beneficiary account via a bank transfer or UPI. You can add the beneficiary details in the same API request.","href":"/api-reference/payouts/v1/direct-transfer"},{"openapi":"post /payout/v1/cardpay","title":"CardPay","description":"Use this API to transfer money to beneficiary cards. Provide details such as beneficiary name, card type, network type, and transfer ID.\n\nYou need to pass the tokenised card number or card token for this transfer.","href":"/api-reference/payouts/v1/cardpay"},{"openapi":"post /payout/v1/lend","title":"Lend","description":"Use this API to send requests for loan disbursement to the beneficiary. The service charges are pooled for the respective party and disbursed at the end of day. Disbursement amount = (Amount - total service charges).","href":"/api-reference/payouts/v1/lend"}]},{"group":"Transfers V1.2","pages":[{"title":"Overview","sidebarTitle":"Overview","description":"Use the Payouts Transfers v1.2 API to disburse funds to beneficiaries through bank accounts, UPI, IMPS, NEFT, Paytm, and Amazon Pay wallets.","href":"/api-reference/payouts/v1/transfer-v12"},{"openapi":"post /payout/v1.2/requestTransfer","title":"Standard Transfer Sync v1.2","description":"Use this API to initiate an amount transfer request at Cashfree by providing beneficiary id, amount, and transfer id. This is a sync transfer request.","href":"/api-reference/payouts/v1/standard-transfer-sync-v12"},{"openapi":"get /payout/v1.2/getBatchTransferStatus","title":"Get Batch Transfer Status V1.2","description":"Use this API to get the status of the Batch Transfer.","href":"/api-reference/payouts/v1/get-batch-transfer-status-v12"},{"openapi":"post /payout/v1.2/requestAsyncTransfer","title":"Standard Transfer Async v1.2","description":"Use this API to initiate an amount transfer request at Cashfree by providing beneficiary id, amount, and transfer id. This is an async transfer request.","href":"/api-reference/payouts/v1/standard-transfer-async-v12"},{"openapi":"post /payout/v1.2/requestBatchTransfer","title":"Batch Transfer V1.2","description":"Use this API to create transfers to multiple beneficiaries. This API accepts an array of transfer objects under the batch field.","href":"/api-reference/payouts/v1/batch-transfer-v12"},{"openapi":"get /payout/v1.2/getTransferStatus","title":"Get Transfer Status V1.2","description":"Use these details to get details of a particular transfer. You can pass referenceId or transferId to fetch the details.","href":"/api-reference/payouts/v1/get-transfer-status-v12"},{"openapi":"post /payout/v1.2/directTransfer","title":"Direct Transfer V1.2","description":"Use this API to initiate amount transfers directly to the beneficiary account via a bank transfer or UPI. You can add the beneficiary details in the same API request.","href":"/api-reference/payouts/v1/direct-transfer-v12"}]},{"group":"Verify and Pay","pages":[{"openapi":"post /payout/v1/validatePayout","title":"Validate Payout V1","description":"Validates a UPI VPA or phone number and returns a single-use transfer token valid for one hour. Pass this token to the [Process Validated Payout API](/api-reference/payouts/v1/verify-and-pay-direct-transfer-v1) to initiate the payout.\n\nIn the request body, pass the value for exactly one of `vpa` or `phone`, not both.\n\nThe response contains either basic or advanced VPA details. Advanced details include IFSC branch information. To enable advanced details for your account, contact your account manager or fill in the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\u0026raise_issue=1).\n","href":"/api-reference/payouts/v1/validate-payout-v1"},{"openapi":"post /payout/v1/directTransfer","sidebarTitle":"Direct Transfer V1","title":"Direct Transfer","description":"Use this API to initiate amount transfers directly to the beneficiary account via a bank transfer or UPI. You can add the beneficiary details in the same API request.","href":"/api-reference/payouts/v1/verify-and-pay-direct-transfer-v1"},{"openapi":"post /payout/v1.2/validatePayout","title":"Validate Payout V1.2","description":"Validates either a Virtual Payment Address (VPA) on UPI or a phone number, and returns a single-use transfer token valid for one hour. Pass this token to the [Process Validated Payout API](/api-reference/payouts/v1/verify-and-pay-direct-transfer-v1-2) to initiate the payout.\n\nIn the request body, pass the value for exactly one of `vpa` or `phone`, not both.\n\nThe response contains either basic or advanced VPA details. Advanced details include Indian Financial System Code (IFSC) branch information. To enable advanced details for your account, contact your account manager or fill in the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\u0026raise_issue=1).\n","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","description":"Use this API to initiate amount transfers directly to the beneficiary account via a bank transfer or UPI. You can add the beneficiary details in the same API request.","href":"/api-reference/payouts/v1/verify-and-pay-direct-transfer-v1-2"}]},{"title":"Webhook Version V1","sidebarTitle":"Webhook Version V1","description":"Configure Cashfree Payouts v1 webhooks to receive HTTP callbacks for transfer events, set the webhook URL in the dashboard, and verify signatures.","icon":"webhook","href":"/api-reference/payouts/v2/webhooks/webhooks-v1"}]},{"group":"One Escrow","pages":[{"openapi":"post /fundsources/connected/virtual-account","title":"Create Virtual Account","description":"Use this API to create a virtual account that helps streamline the management of funds, enhance tracking capabilities, and simplify the financial process.","href":"/api-reference/payouts/v1/oneescrow/create-virtual-account"},{"openapi":"post /v1.2/internalTransfer","title":"Transfer Funds Between VAs","description":"Use this API to transfer funds between virtual accounts (VAs).","href":"/api-reference/payouts/v1/oneescrow/transfer-funds-between-vas"},{"openapi":"get /v1/accountStatement","title":"Get Account Statement","description":"Use this API to fetch the account statement of the virtual account in a paginated format using cursor-based pagination.","href":"/api-reference/payouts/v1/oneescrow/get-account-statement"},{"openapi":"post /v1/connected-wallet/recharge","title":"Allocate Funds to Virtual Account","description":"Use this API to recharge the OneEscrow account (notional credit) using a payment instrument.","href":"/api-reference/payouts/v1/oneescrow/recharge-oneescrow-account"},{"openapi":"get /v1/fundsources/{paymentInstrumentId}","title":"Get Fund Source Details","description":"Use this API to get the details of the fund source.","href":"/api-reference/payouts/v1/oneescrow/get-fund-source-details"},{"openapi":"post /v1/whitelisted-bank-accounts","title":"Add Registered Recharge Account(Whitelist Bank Account)","description":null,"href":"/api-reference/payouts/v1/oneescrow/add-registered-recharge-accountwhitelist-bank-account"},{"openapi":"post /payout/v1/connected-wallet/debit","title":"Debit Connected Wallet","description":null,"href":"/api-reference/payouts/v1/oneescrow/debit-connected-wallet"}]},{"group":"Cashgram","pages":[{"title":"End Points","sidebarTitle":"End Points","description":"Find the production and sandbox base URLs for Cashfree Payouts v1 APIs, plus the credentials verification endpoint you use to validate your AppId and SecretKey.","href":"/api-reference/payouts/v1/end-points"},{"title":"Postman Collection","sidebarTitle":"Postman Collection","description":"Download the Cashfree Cashgram Postman collection, import it into Postman, and start trying Cashgram API requests against sandbox without writing code.","href":"/api-reference/payouts/v1/cashgram-postman-collection"},{"title":"Webhooks","sidebarTitle":"Webhooks","description":"Configure Cashgram webhooks to receive real-time HTTP callbacks for redeemed, reversed, and expired events, and learn how Cashfree polls bank status updates.","icon":"webhook","href":"/api-reference/payouts/v1/webhooks"},{"openapi":"post /payout/v1/createCashgram","title":"Create Cashgram","description":"Use this API to create a Cashgram.","href":"/api-reference/payouts/v1/create-cashgram"},{"openapi":"post /payout/v1/deactivateCashgram","title":"Deactivate Cashgram","description":"","href":"/api-reference/payouts/v1/deactivate-cashgram"},{"openapi":"get /payout/v1/getCashgramStatus","title":"Get Cashgram Status","description":"Use this API to get the status of the Cashgram created.","href":"/api-reference/payouts/v1/get-cashgram-status"},{"title":"Response Codes","sidebarTitle":"Response Codes","description":"Look up Cashfree Payouts v1 response codes for Cashgram, beneficiary, and transfer APIs, with HTTP status, error codes, messages, and recommended next actions.","href":"/api-reference/payouts/v1/response-codes"}]}]},{"tab":"Secure ID APIs","hidden":true,"pages":[{"title":"Secure ID APIs","href":"/api-reference/vrs/overview"}]},{"tab":"Additional APIs","hidden":true,"pages":[{"title":"Additional APIs","href":"/api-reference/prepaid-payment-instruments/overview"}]},{"tab":"Partners APIs","hidden":true,"pages":[{"title":"Partners APIs","href":"/api-reference/platforms/overview"}]},{"tab":"Additional APIs","hidden":true,"pages":[{"title":"Additional APIs","href":"/api-reference/other-apis/bbps/overview"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/overview"}]},{"tab":"AI Stack","pages":[{"title":"AI Stack","href":"/tools-ai/overview"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help/overview"}]}]},"title":"Beneficiary History v1 | Cashfree","buildId":"dpl_AUojGTPodKNPTVaxVPcxnNvkSVqo","deploymentId":"dpl_AUojGTPodKNPTVaxVPcxnNvkSVqo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D2GYGXhJ.js","utils-BFd71lo2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-i162M7Za.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-oUw0la6W.js","snippetPresets-DtIWL37f.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BCMBbEQM.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DC4RgS91.js","shallow-CgVeLRFv.js","getApiPlaygroundDisplay-D5biMY5x.js","CodeSnippet-BFsbT-Fu.js","CodeSnippets-zLLOIece.js","Page-Ddn8iQDL.js","getPastedJson-BrHW4jRt.js","icon-CkMCp-Tk.js","MethodPill-CCcSM-Ep.js","DuplicateIcon-4tBrFI-V.js","createIcon-YbZxtfvX.js","DynamicMarkdown-BQC1aHST.js","SectionHeading-Dyh8yRs0.js","axios-vUo_bRtp.js","Markdown-DnRxVfNy.js","clsx-BHwt7gjg.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI1QhstW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ctpizp2W.js"]}