{
"status": "ERROR",
"subCode": "403",
"message": "APIs not enabled. Please fill out the [Support Form](https://telr.cashfree.com/merchants/landing?env=prod&raise_issue=1)"
}
{
"status": "ERROR",
"subCode": "412",
"message": "Post data is empty or not a valid JSON"
}
{
"status": "ERROR",
"subCode": "422",
"message": "Please provide a valid Bank IFSC code."
}
Add Beneficiary
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.
{
"status": "ERROR",
"subCode": "403",
"message": "APIs not enabled. Please fill out the [Support Form](https://telr.cashfree.com/merchants/landing?env=prod&raise_issue=1)"
}
Bank account and VPA are both provided in the request. Please add either of them to add the beneficiary.
Enter any of the information in the request.
412
ERROR
Cannot add yourself as a beneficiary
Enter an individual’s information apart from yours to add a beneficiary.
422
ERROR
Please provide a valid Beneficiary Id
Enter a valid beneficiary ID.
422
ERROR
Please provide a valid email
Enter a valid email address.
422
ERROR
Please provide a valid name
Enter a valid name.
422
ERROR
Please provide a valid Phone Number
Enter a valid phone number.
422
ERROR
Please provide a valid Bank Account
Enter valid bank account information.
422
ERROR
Please provide a valid Bank IFSC code
Enter a valid IFSC.
422
ERROR
Please provide a valid Virtual Payee Address
Enter a valid VPA.
422
ERROR
Please provide a valid Address
Enter a valid address.
422
ERROR
Please provide a valid City Name
Enter a valid city name.
422
ERROR
Please provide a valid State Name
Enter a valid state name.
422
ERROR
Please provide a valid Pin code
Enter a valid PIN code.
422
ERROR
Telr VBA/VPA cannot be added as a beneficiary
Enter a different VBA/VPA to add the beneficiary.
422
ERROR
Please provide a valid MasterCard or Visa card number
Enter a valid MasterCard or Visa card number.
422
ERROR
Please provide a masked card number of a valid MasterCard or Visa card
Enter a masked card number of a valid MasterCard or Visa card.
422
ERROR
Invalid details provided
Enter valid details of the beneficiary to add the beneficiary in the system.
520
ERROR
Adding beneficiary Failed
Re-enter the details or try again after some time.
Note: If you are attempting to create a transfer in the Sandbox environment, you can obtain the test data details from this link.
Headers
Authorization
string
required
Bearer auth token
Content-Type
string
required
application/json
Body
application/json
beneId
string
required
Unique Beneficiary ID to identify the beneficiary. Alphanumeric and underscore (_) allowed (50 character limit)
name
string
required
It is the name of the beneficiary. A maximum of 100 characters are allowed. Alphabets, numbers, white spaces ( ), and special characters are allowed.
email
string
required
Beneficiaries email, string in email Id format (Ex: johndoe_1@cashfree.com) - should contain @ and dot (.) - (200 character limit)
phone
string
required
Beneficiaries phone number, phone number registered in India (only digits, 8 - 12 characters after stripping +91)
address1
string
required
Beneficiaries address, alphanumeric and space allowed (but script, HTML tags gets sanitized or removed) (150 character limit)
bankAccount
string
Beneficiary bank account (9 - 18 alphanumeric character limit)
ifsc
string
Accounts IFSC (standard IFSC format) - length 11, first four bank IFSC and 5th digit 0
vpa
string
Beneficiary VPA, alphanumeric, dot (.), hyphen (-), at sign (@), and underscore () allowed (100 character limit). Note: underscore () and dot (.) gets accepted before and after at sign (@), but hyphen (-) get only accepted before at sign (@)
address2
string
Beneficiary address, alphanumeric and space allowed (but script, HTML tags gets sanitized or removed) (150 character limit)
city
string
Beneficiary city, only alphabets and white space (50 character limit)
state
string
Beneficiary state, only alphabets and white space (50 character limit)
pincode
string
Beneficiaries pincode, only numbers (6 character limit)
Response
200
status
string
Example:
"SUCCESS"
subCode
string
Example:
"200"
message
string
Example:
"Beneficiary added successfully"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Telr Developer Documentation","colors":{"primary":"#006E4F","light":"#00A887","dark":"#244C2F"},"logo":{"light":"https://mintcdn.com/telr/0gWXSd3fXAm_cMMR/static/logo/Telr_Logo.png?fit=max\u0026auto=format\u0026n=0gWXSd3fXAm_cMMR\u0026q=85\u0026s=1eab94fcaa68dc82f3f3201b2a47e789","dark":"https://mintcdn.com/telr/0gWXSd3fXAm_cMMR/static/logo/Telr_Logo.png?fit=max\u0026auto=format\u0026n=0gWXSd3fXAm_cMMR\u0026q=85\u0026s=1eab94fcaa68dc82f3f3201b2a47e789"},"favicon":"/static/telr_favicon-32x32.png","appearance":{"default":"light","strict":false},"background":{"color":{"light":"#fbfbfb","dark":"#000000"}},"navbar":{},"footer":{},"search":{"prompt":"Search or ask..."},"seo":{"metatags":{"og:title":"Telr Developer Documentation","og:description":"Welcome to the Telr developer documentation. You will find help about Telr products and APIs that will help you start using our products quickly.","og:site_name":"Telr Developer Documentation"},"indexing":"all"},"integrations":{},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"telr","hasAudioNarration":false,"actualSubdomain":"telr","customDomains":["telr-docs.cashfree.com"],"gitSource":{"type":"github","owner":"cashfree-telr","repo":"docs","deployBranch":"telr","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9288385770375310653a8:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Payment Gateway","count":46},{"language":"default","tag":"Payments APIs","count":44},{"language":"default","tag":"Payments","count":44},{"language":"default","tag":"v2025-01-01","count":38},{"language":"default","tag":"Help Center","count":12},{"language":"default","tag":"No Code","count":12},{"language":"default","tag":"Manage","count":7},{"language":"default","tag":"Customise experience","count":7},{"language":"default","tag":"Custom Web Checkout","count":7},{"language":"default","tag":"Payments API","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"grid.css","content":".container,.container-fluid{margin-right:auto;margin-left:auto;padding-top:3rem;padding-bottom:3rem}.container-fluid{padding-right:2rem;padding-left:2rem}.row{box-sizing:border-box;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:-0.5rem;margin-left:-0.5rem}.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;-webkit-box-direction:reverse;-ms-flex-direction:column-reverse;flex-direction:column-reverse}.col-xs,.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:0.5rem;padding-left:0.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,.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:0.5rem;padding-left:0.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,.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:0.5rem;padding-left:0.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,.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:0.5rem;padding-left:0.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":"style.css","content":"/* arabic */\n@font-face {\n font-family: 'Rubik';\n font-style: italic;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWEBXyIfDnIV7nEnXu61F3f.woff2) format('woff2');\n unicode-range: U+0600-06FF, U+0750-077F, U+0870-0891, U+0897-08E1, U+08E3-08FF, U+200C-200E, U+2010-2011, U+204F, U+2E41, U+FB50-FDFF, U+FE70-FE74, U+FE76-FEFC, U+102E0-102FB, U+10E60-10E7E, U+10EC2-10EC7, U+10EC9-10EEE, U+10EF0-10EFF, U+1EE00-1EE03, U+1EE05-1EE1F, U+1EE21-1EE22, U+1EE24, U+1EE27, U+1EE29-1EE32, U+1EE34-1EE37, U+1EE39, U+1EE3B, U+1EE42, U+1EE47, U+1EE49, U+1EE4B, U+1EE4D-1EE4F, U+1EE51-1EE52, U+1EE54, U+1EE57, U+1EE59, U+1EE5B, U+1EE5D, U+1EE5F, U+1EE61-1EE62, U+1EE64, U+1EE67-1EE6A, U+1EE6C-1EE72, U+1EE74-1EE77, U+1EE79-1EE7C, U+1EE7E, U+1EE80-1EE89, U+1EE8B-1EE9B, U+1EEA1-1EEA3, U+1EEA5-1EEA9, U+1EEAB-1EEBB, U+1EEF0-1EEF1;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Rubik';\n font-style: italic;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWEBXyIfDnIV7nEnXO61F3f.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Rubik';\n font-style: italic;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWEBXyIfDnIV7nEnXq61F3f.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* hebrew */\n@font-face {\n font-family: 'Rubik';\n font-style: italic;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWEBXyIfDnIV7nEnXy61F3f.woff2) format('woff2');\n unicode-range: U+0307-0308, U+0590-05FF, U+200C-2010, U+20AA, U+25CC, U+FB1D-FB4F;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Rubik';\n font-style: italic;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWEBXyIfDnIV7nEnXC61F3f.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Rubik';\n font-style: italic;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWEBXyIfDnIV7nEnX661A.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* arabic */\n@font-face {\n font-family: 'Rubik';\n font-style: normal;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWKBXyIfDnIV7nErXyi0A.woff2) format('woff2');\n unicode-range: U+0600-06FF, U+0750-077F, U+0870-0891, U+0897-08E1, U+08E3-08FF, U+200C-200E, U+2010-2011, U+204F, U+2E41, U+FB50-FDFF, U+FE70-FE74, U+FE76-FEFC, U+102E0-102FB, U+10E60-10E7E, U+10EC2-10EC7, U+10EC9-10EEE, U+10EF0-10EFF, U+1EE00-1EE03, U+1EE05-1EE1F, U+1EE21-1EE22, U+1EE24, U+1EE27, U+1EE29-1EE32, U+1EE34-1EE37, U+1EE39, U+1EE3B, U+1EE42, U+1EE47, U+1EE49, U+1EE4B, U+1EE4D-1EE4F, U+1EE51-1EE52, U+1EE54, U+1EE57, U+1EE59, U+1EE5B, U+1EE5D, U+1EE5F, U+1EE61-1EE62, U+1EE64, U+1EE67-1EE6A, U+1EE6C-1EE72, U+1EE74-1EE77, U+1EE79-1EE7C, U+1EE7E, U+1EE80-1EE89, U+1EE8B-1EE9B, U+1EEA1-1EEA3, U+1EEA5-1EEA9, U+1EEAB-1EEBB, U+1EEF0-1EEF1;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Rubik';\n font-style: normal;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWKBXyIfDnIV7nMrXyi0A.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Rubik';\n font-style: normal;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWKBXyIfDnIV7nFrXyi0A.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* hebrew */\n@font-face {\n font-family: 'Rubik';\n font-style: normal;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWKBXyIfDnIV7nDrXyi0A.woff2) format('woff2');\n unicode-range: U+0307-0308, U+0590-05FF, U+200C-2010, U+20AA, U+25CC, U+FB1D-FB4F;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Rubik';\n font-style: normal;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWKBXyIfDnIV7nPrXyi0A.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Rubik';\n font-style: normal;\n font-weight: 300 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/rubik/v31/iJWKBXyIfDnIV7nBrXw.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n@font-face{font-family:\"Termina Demi\";src:url(https://cashfree.pages.dev/fonts/Termina-Demi.woff2) format(\"woff2\"),\n\t\turl(https://cashfree.pages.dev/fonts/Termina-Demi.woff) format(\"woff\");font-style:normal;font-display:swap}body,html{margin:0;padding:0}#navbar{width:100%}span.absolute.inset-0.bg-primary-dark{border-radius:4px!important}#content-area{max-width:100%}#navbar .max-w-8xl{max-width:100%;margin:0}#navbar .mx-auto{margin-left:0!important;margin-right:0!important}.font-rubik{font-family:\"Rubik\", sans-serif}.font-termina{font-family:\"Termina Demi\", sans-serif!important}h1,h2,h3,h4,h5,h6{font-family:\"Rubik\", sans-serif}p,.custom-prose{font-family:\"Rubik\", sans-serif}#content-container .prose{font-size:0.9rem;line-height:1.4}.custom-card a{background:transparent;border:none}.custom-card a>div div:first-child.h-6{height:2rem!important;width:4rem!important;margin-bottom:1rem!important}.custom-card a>div div:first-child img{width:4rem!important}.footer-container{display:flex;justify-content:space-between;align-items:start;padding:1rem 1.25rem 6rem 1.25rem;max-width:87rem;margin:auto;border-top:1px solid #ccc;margin-top:2rem;flex-direction:row;font-size:0.875rem}.footer-container a{font-size:0.75rem}.footer-column{flex:1;margin-right:1rem;margin-bottom:1rem}.footer-link{display:flex;align-items:normal}.footer-link span{margin-left:0.3rem;font-size:calc(1rem + 0.8px)}.footer-link svg{margin-top:5px}.footer-column.support-links p{margin-bottom:0.5rem}.footer-column.support-links icon{margin-right:1rem}.footer-column.support-links{margin-top:0.5rem}.footer-column .subscribe-heading{font-size:18px;padding-top:0.25rem}.footer-column form{margin-top:0.25rem}.footer-column.social-links{display:flex;justify-content:space-between;gap:1rem;flex-wrap:wrap}.footer-column.social-links a{display:inline-flex;align-items:center;margin-right:1rem}.footer-column.social-links a:last-child{margin-right:0}a img{outline:none;pointer-events:none}@media (max-width: 768px){.footer-container{flex-direction:column;padding-left:1rem;padding-right:1rem}.footer-column{margin-bottom:1rem;margin-right:0}.footer-column.social-links{justify-content:center}}.video-thumbnail{position:relative;display:inline-block;cursor:pointer}.video-thumbnail img{width:200px;height:auto}.play-button{position:absolute;left:50%;top:50%;transform:translate(-50%, -50%);width:50px;height:50px;background-color:rgba(0, 0, 0, 0.7);border-radius:50%;display:flex;justify-content:center;align-items:center}.play-button::after{content:\"\";display:block;width:0;height:0;border-top:10px solid transparent;border-bottom:10px solid transparent;border-left:15px solid white;margin-left:5px}.cfgap{margin-top:10px;height:5px;width:100%}.cfbadge{font-size:12px;border:1px solid #6d8299;border-radius:4px;overflow:hidden;margin-right:10px;display:inline-block;line-height:1rem}.cfbadge span{padding:3px 5px;text-align:center;text-transform:small-caps}.cfbadge .t{background-color:transparent;color:#333}.cfbadge .v{background-color:#6d8299;color:#fff}.cfbadge.green{border:1px solid #5f939a}.cfbadge.green .v{background-color:#5f939a}.cfbadge.yellow{border:1px solid #bd9354}.cfbadge.yellow .v{background-color:#bd9354}.v3jsrequired{color:#d57e7e;text-transform:uppercase;font-size:10px;font-weight:bold}.v3jsoptional{color:#5f939a;text-transform:uppercase;font-size:10px;font-weight:bold}.checklist-circle-icon{display:inline-flex;align-items:center;justify-content:center;width:20px;height:20px;border:2px solid currentColor;border-radius:50%;flex-shrink:0}.checklist-circle-icon.checked{border-color:rgb(38, 201, 125);background:rgb(38, 201, 125)}.checklist-check-mark{width:12px;height:12px;stroke-width:2}.checklist-circle-icon.checked .checklist-check-mark{display:block}.button-group{display:flex;gap:8px}.checklist-btn{padding:4px 14px;border-radius:4px;border:none;cursor:pointer;transition:all 0.2s}.checklist-btn:hover{background:rgb(31, 41, 55, 0.4)}.checklist-btn.active-yes{background:rgb(38, 201, 125);color:white}.checklist-btn.active-no{background:#faab01;color:white}.checklist-btn.active-na{background:#4b5563;color:white}.warning-box{display:none;align-items:flex-start;border-radius:6px;padding:16px;margin-top:16px;background:#faab01;color:white}.info-box{display:flex;align-items:flex-start;border-radius:6px;font-weight:400;padding:16px;margin-top:16px;gap:8px}.icon{width:16px;height:16px}.warning-box.show{display:flex}.comparison-table{width:100%;border-collapse:collapse;font-family:system-ui, -apple-system, sans-serif;margin:20px 0}.comparison-table th{background-color:#f8fafc;padding:12px;text-align:left;border-bottom:2px solid #e2e8f0;font-weight:600}.comparison-table td{padding:12px;border-bottom:1px solid #e2e8f0;vertical-align:top;line-height:1.5}.comparison-table tr:hover{background-color:#f8fafc}.comparison-feature{font-weight:500;color:#1a202c;background-color:#e9ecef}.comparison-use-case-selector{margin:20px 0;padding:20px;background-color:#f8fafc;border-radius:8px;border:1px solid #e2e8f0}.comparison-use-case-selector select{width:100%;padding:12px;border:1px solid #cbd5e1;border-radius:6px;font-size:16px;margin-bottom:16px}.comparison-recommendation{padding:16px;border-radius:6px;display:none;margin-top:12px}.comparison-recommendation.active{display:block;animation:fadeIn 0.3s ease-in}.comparison-links{background-color:#e8f5e9;border:1px solid #c8e6c9}.comparison-forms{background-color:#e3f2fd;border:1px solid #bbdefb}@keyframes fadeIn{from{opacity:0}to{opacity:1}}.singleupdate{padding:10px 10px 10px 10px}.month{border-radius:3px 3px 3px 3px;color:#000;height:26px;line-height:26px;text-decoration:none}.pgapi{background:#fff;background-color:#0073e6;border-radius:3px 3px 3px 3px;color:#fff;display:inline-block;height:20px;line-height:20px;padding:0 16px 0 17px;position:relative;margin:0 8px 8px 0;text-decoration:none}.jssdk{background:#fff;background-color:#006E4F;border-radius:3px 3px 3px 3px;color:#fff;display:inline-block;height:20px;line-height:20px;padding:0 16px 0 17px;position:relative;margin:0 8px 8px 0;text-decoration:none}.android{background:#fff;background-color:#205375;border-radius:3px 3px 3px 3px;color:#fff;display:inline-block;height:20px;line-height:20px;padding:0 16px 0 17px;position:relative;margin:0 8px 8px 0;text-decoration:none}.ios{background:#fff;background-color:#06541b;border-radius:3px 3px 3px 3px;color:#fff;display:inline-block;height:20px;line-height:20px;padding:0 16px 0 17px;position:relative;margin:0 8px 8px 0;text-decoration:none}.react_native{background:#fff;background-color:#966d05;border-radius:3px 3px 3px 3px;color:#fff;display:inline-block;height:20px;line-height:20px;padding:0 16px 0 17px;position:relative;margin:0 8px 8px 0;text-decoration:none}.plugins{background:#fff;background-color:#f2388c;border-radius:3px 3px 3px 3px;color:#fff;display:inline-block;height:20px;line-height:20px;padding:0 16px 0 17px;position:relative;margin:0 8px 8px 0;text-decoration:none}.general{background:#fff;background-color:#ff7f50;border-radius:3px 3px 3px 3px;color:#fff;display:inline-block;height:20px;line-height:20px;padding:0 16px 0 17px;position:relative;margin:0 8px 8px 0;text-decoration:none}#sidebar-content #navigation-items li>a,#sidebar-content #navigation-items li>div{background:transparent!important;padding-top:5px;padding-bottom:5px}#sidebar-content #navigation-items>div:has(>h5){margin-top:15px!important}#sidebar-content #navigation-items>div:has(>h5)>h5{margin-bottom:0px!important}.pg-home-wrapper{padding:20px;display:flex;flex-wrap:wrap;gap:20px;font-family:-apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, sans-serif}.pg-home-card{background:white;border-radius:12px;padding:24px;width:calc(50% - 10px);box-shadow:0 2px 4px rgba(0, 0, 0, 0.05)}.pg-home-card-title{color:#666;font-size:14px;font-weight:600;margin-bottom:20px;text-transform:uppercase}.pg-home-integration-list{list-style:none;margin:0;padding:0}.pg-home-integration-item{display:flex;align-items:center;margin-bottom:16px}.pg-home-integration-item:last-child{margin-bottom:0}.pg-home-integration-icon{width:24px;height:24px;margin-right:12px;display:flex;align-items:center;justify-content:center;color:#006E4F}.pg-home-integration-content{flex:1}.pg-home-integration-title{font-size:14px;font-weight:500;color:#333;margin-bottom:2px}.pg-home-integration-subtitle{font-size:12px;color:#666}[data-table-of-contents]{width:16.5rem}#navbar .flex:has(>a[href=\"/docs/api-reference/overview\"]),#navbar .flex:has(>a[href=\"/api-reference/overview\"]){width:100%}.hidden.lg\\:flex.px-12.h-12 .h-full.flex a:nth-last-child(3){margin-left:auto}.hidden.lg\\:flex.px-12.h-12 .h-full.flex a:last-child(2){margin-left:1rem}.hidden.lg\\:flex.px-12.h-12 .h-full.flex a:last-child{margin-left:1rem}li.pg-home-integration-item{padding-left:0px!important}li.pg-home-integration-item::before{display:none!important}.pg-home-card-title{margin-top:0px!important}.one{position:absolute;top:0;left:0;width:100%;z-index:0;background-repeat:no-repeat;background-size:100%;height:100svh;clip-path:polygon(0 0, 100% 0, 100% 54%, 0% 100%);transform:blur(3px)}.one::after{content:\"\";position:absolute;background-image:linear-gradient(#006E4F 1px, transparent 1px),\n\t\tlinear-gradient(to right, #006E4F 1px, #fbfbfb 1px);-webkit-mask-image:linear-gradient(\n\t\tto bottom,\n\t\trgba(0, 0, 0, 1) 0%,\n\t\trgba(0, 0, 0, 0.8) 20%,\n\t\trgba(0, 0, 0, 0.6) 40%,\n\t\trgba(0, 0, 0, 0.4) 60%,\n\t\trgba(0, 0, 0, 0.2) 80%,\n\t\trgba(0, 0, 0, 0) 100%\n\t);mask-image:linear-gradient(\n\t\t135deg,\n\t\trgba(0, 0, 0, 0.2) 0%,\n\t\trgba(0, 0, 0, 0.1) 20%,\n\t\trgba(0, 0, 0, 0.05) 40%,\n\t\trgba(0, 0, 0, 0.025) 60%,\n\t\trgba(0, 0, 0, 0.0125) 80%,\n\t\trgba(0, 0, 0, 0) 100%\n\t);background-size:32px 32px;width:100%;height:100vh;top:0;left:0}.dark .one::after{background-image:linear-gradient(#fefefe 1px, transparent 1px),\n\t\tlinear-gradient(to right, #fefefe 1px, #000000 1px)}.blur-card{border-radius:100%/85%;background-color:rgba(255, 255, 255, 0.75);box-shadow:0 0 64px 64px rgba(255, 255, 255, 0.75)}.dark .blur-card{background-color:rgba(0, 0, 0, 0.75);box-shadow:0 0 64px 64px rgba(0, 0, 0, 0.75)}.shadow-2xl{box-shadow:rgba(0, 0, 0, 0.1) 0px 4px 12px}.padding{padding:1rem}.hero{border-radius:6px;box-shadow:rgba(50, 50, 93, 0.25) 0px 13px 27px -5px,\n\t\trgba(0, 0, 0, 0.3) 0px 8px 16px -8px}.button-61{align-items:center;appearance:none;border-radius:4px;border-style:none;box-shadow:rgba(0, 0, 0, 0.2) 0 3px 1px -2px, rgba(0, 0, 0, 0.14) 0 2px 2px 0,\n\t\trgba(0, 0, 0, 0.12) 0 1px 5px 0;box-sizing:border-box;color:#fff;cursor:pointer;display:inline-flex;font-size:0.875rem;font-weight:500;height:36px;justify-content:center;letter-spacing:0.0892857em;line-height:normal;min-width:64px;outline:none;overflow:visible;padding:0 16px;position:relative;text-align:center;text-decoration:none;text-transform:uppercase;transition:box-shadow 280ms cubic-bezier(0.4, 0, 0.2, 1);user-select:none;-webkit-user-select:none;touch-action:manipulation;vertical-align:middle;will-change:transform, opacity}.button-61:hover{box-shadow:rgba(0, 0, 0, 0.2) 0 2px 4px -1px, rgba(0, 0, 0, 0.14) 0 4px 5px 0,\n\t\trgba(0, 0, 0, 0.12) 0 1px 10px 0}.button-61:disabled{background-color:rgba(0, 0, 0, 0.12);box-shadow:rgba(0, 0, 0, 0.2) 0 0 0 0, rgba(0, 0, 0, 0.14) 0 0 0 0,\n\t\trgba(0, 0, 0, 0.12) 0 0 0 0;color:rgba(0, 0, 0, 0.37);cursor:default;pointer-events:none}.button-61:not(:disabled){background-color:#006E4F}.text-cf{color:#006E4F}a.underline{text-decoration:none}a.underline:hover{text-decoration:underline}.button-61:focus{box-shadow:rgba(0, 0, 0, 0.2) 0 2px 4px -1px, rgba(0, 0, 0, 0.14) 0 4px 5px 0,\n\t\trgba(0, 0, 0, 0.12) 0 1px 10px 0}.button-61:active{box-shadow:rgba(0, 0, 0, 0.2) 0 5px 5px -3px,\n\t\trgba(0, 0, 0, 0.14) 0 8px 10px 1px, rgba(0, 0, 0, 0.12) 0 3px 14px 2px;background:#006E4F}.bg-transparent{background-color:transparent!important}.button-61.bg-transparent{color:var(--text-gray-800);box-shadow:none}.z-20{z-index:20}.max-w-475{max-width:475px}.activation{display:inline-flex;align-items:center;padding:4px 12px;border-radius:4px;font-size:0.75rem;font-weight:500;letter-spacing:0.25px;color:white;transition:all 0.3s ease;cursor:default;box-shadow:0 2px 4px rgba(0, 0, 0, 0.1);margin:4px;font-family:system-ui, -apple-system, sans-serif;position:relative;overflow:hidden;max-width:fit-content;white-space:nowrap}.activation::before{content:\"\";position:absolute;top:0;left:0;width:100%;height:100%;background:linear-gradient(rgba(255, 255, 255, 0.1), transparent);pointer-events:none}.automatic{background-color:#059669;border:1px solid #047857}.automatic:hover{background-color:#047857;box-shadow:0 4px 6px rgba(5, 150, 105, 0.2)}.automatic::after{content:\"✓\";margin-left:4px;font-weight:bold}.self-activate{background-color:#00A887;border:1px solid #006E4F}.self-activate:hover{background-color:#006E4F;box-shadow:0 4px 6px rgba(37, 99, 235, 0.2)}.self-activate::after{content:\"→\";margin-left:4px;font-weight:bold}.request-activation{background-color:#f97316;border:1px solid #ea580c}.request-activation:hover{background-color:#ea580c;box-shadow:0 4px 6px rgba(249, 115, 22, 0.2)}.request-activation::after{content:\"!\";margin-left:4px;font-weight:bold}.activation:focus{outline:none;box-shadow:0 0 0 2px rgba(255, 255, 255, 0.5), 0 0 0 4px rgba(0, 0, 0, 0.1)}@media (max-width: 768px){.activation{padding:4px 8px;font-size:0.6875rem;margin:4px 2px}}@media (prefers-contrast: high){.activation{border-width:2px}.automatic{background-color:#006400}.self-activate{background-color:#00008b}.request-activation{background-color:#b8860b}}.product-card{position:relative;padding:15px;padding-left:48px;display:block}.product-card>span{position:absolute;width:32px;height:32px;top:20px;left:5px}.product-card h4{font-size:1rem!important;overflow:hidden;white-space:nowrap;text-overflow:ellipsis}.product-card p{font-size:0.8rem;overflow:hidden;white-space:nowrap;text-overflow:ellipsis}.embed-widget{#navbar {\n\t\tdisplay: none;\n\t}\n\t#content-container > div {\n\t\tpadding: 0;\n\t}\n\tfooter {\n\t\tdisplay: none;\n\t}}.lowmhr hr{margin-bottom:1em!important;margin-top:1em!important}#announcement-bar{display:flex;justify-content:center;align-items:center;gap:10px;padding:10px 20px;position:fixed;top:0;left:0;width:100%;background-color:#E1F1E6;color:#000;font-size:16px;font-family:Arial, sans-serif;z-index:1000;box-shadow:0 2px 4px rgba(0, 0, 0, 0.1);text-align:center}#announcement-bar a{color:#006E4F;text-decoration:none}#dismiss-btn{color:#000;font-size:18px;font-weight:bold;cursor:pointer;display:inline}#dismiss-btn:hover{color:#FF0000}@media (max-width: 768px){#announcement-bar{flex-direction:column;align-items:flex-start;padding:15px;font-size:14px;text-align:left;gap:10px}#announcement-bar a{margin-top:5px}#dismiss-btn{margin-top:5px}}"},{"filePath":"typography.css","content":"h1{font-size:2.4rem}h2{font-size:2rem}h3{font-size:1.6rem}h4{font-size:1.2rem}h5{font-size:1rem}h6{font-size:0.8rem}.bold{font-weight:bold}.semibold{font-weight:600}.medium{font-weight:500}.regular{font-weight:400}.light{font-weight:300}"}],"page":{"pagePath":"api-reference/payouts/v1/add-beneficiary","slug":"/api-reference/payouts/v1/add-beneficiary","pageMetadata":{"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"},"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 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.\"\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`,strong:`strong`,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`,_jsxs(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:`Next Action`})]})}),_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:`Beneficiary added 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:`400`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Please provide a valid VPA`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid VPA in the API request.`})]}),_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 not valid`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid token in the request.`})]}),_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:`IP not whitelisted`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Whitelist the API.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`403`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`APIs not enabled. Please fill out the `,_jsx(_components.a,{href:`https://telr.cashfree.com/merchants/landing?env=prod\u0026raise_issue=1`,children:`Support Form`})]}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.a,{href:`https://telr.cashfree.com/merchants/landing?env=prod\u0026raise_issue=1`,children:`Support Form`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`409`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Beneficiary Id already exists`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a unique ID for the beneficiary.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`409`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Entered bank Account is already registered`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter different bank account information.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`412`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Token missing in the request`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid token in the request.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`412`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Beneficiary group is not an active group`}),_jsx(_components.td,{style:{textAlign:`left`}})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`412`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Bank account and VPA are both provided in the request. Please add either of them to add the beneficiary.`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter any of the information in the request.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`412`}),_jsx(_components.td,{style:{textAlign:`left`},children:`ERROR`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Cannot add yourself as a beneficiary`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter an individual’s information apart from yours to add a beneficiary.`})]}),_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:`Please provide a valid email`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid email address.`})]}),_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 name`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid name.`})]}),_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 Phone Number`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid phone number.`})]}),_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 Bank Account`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter valid bank account information.`})]}),_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 Bank IFSC code`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid IFSC.`})]}),_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 Virtual Payee Address`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid VPA.`})]}),_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 Address`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid address.`})]}),_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 City Name`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid city name.`})]}),_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 State Name`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid state name.`})]}),_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 Pin code`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid PIN code.`})]}),_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:`Telr VBA/VPA cannot be added as a beneficiary`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a different VBA/VPA to add the beneficiary.`})]}),_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 MasterCard or Visa card number`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a valid MasterCard or Visa card number.`})]}),_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 masked card number of a valid MasterCard or Visa card`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter a masked card number of a valid MasterCard or Visa card.`})]}),_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:`Invalid details provided`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Enter valid details of the beneficiary to add the beneficiary in the system.`})]}),_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:`Adding beneficiary Failed`}),_jsx(_components.td,{style:{textAlign:`left`},children:`Re-enter the details or try again after some time.`})]})]})]}),_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Note`}),`: If you are attempting to create a transfer in the Sandbox environment, you can obtain the test data details from this `,_jsx(_components.a,{href:`doc:data-to-test`,children:`link`}),`.`]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"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"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/telr/79a79d8b9ca0b2a1/addframe.js","/_mintlify/custom/telr/bc4eac15553663a2/openapi-rm-desc.js","/_mintlify/custom/telr/5748000362acad1e/quote-openapi.js","/_mintlify/custom/telr/a58c8caa48620fe4/script.js","/_mintlify/custom/telr/d99a96c0c4b010fe/updateHelpAccordionsWithPostHog.js","/_mintlify/custom/telr/bd8561d01634fd2e/updateIframeSrc.js","/_mintlify/custom/telr/7b49b0aba32ccd66/util/checkLinks.js","/_mintlify/custom/telr/0a1efd0b138512b4/util/downloadImages.js","/_mintlify/custom/telr/6520965c686ab08e/util/updateFrontmatter.js"],"openApiReferenceData":{"operation":{"summary":"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.","operationId":"create-beneficiary-11","parameters":["aa59299c-b06e-4812-a43b-b261957ced94","ae5db00b-ddac-4020-bfc6-26da3d905d15"],"requestBody":"a127e6ff-b0ac-4202-9881-0ad9e3209b8b","responses":{"200":"469cbbc0-a98b-4894-8688-6600fd971962","403":"85a28ba1-e45f-439b-93fe-21227520bfb5","409":"2c1ad69e-a477-4398-9918-f6986ec9771e","412":"0241cf3e-be03-4b09-8a8b-bc2c76785b2a","422":"6fc2518a-6933-4e94-bbdc-afe86539ec4e"},"deprecated":false,"security":[],"x-readme":{"code-samples":[{"language":"curl","code":"curl -X POST \\\n 'http://{{Host%20Url}}/payout/v1/addBeneficiary' \\\n -H 'Authorization: Bearer {{Token}}' \\\n -d '{\n \"beneId\": \"JOHN18011343\",\n \"name\": \"john doe\",\n \"email\": \"johndoe@cashfree.com\",\n \"phone\": \"9876543210\",\n \"bankAccount\": \"00111122233\",\n \"ifsc\": \"HDFC0000001\",\n \"address1\": \"ABC Street\",\n \"city\": \"Bangalore\",\n \"state\": \"Karnataka\",\n \"pincode\": \"560001\"\n}'"},{"language":"text","code":"const cfSdk = require('cashfree-sdk');\nconst {Beneficiary} = cfSdk.Payouts;\n\nconst response = await Beneficiary.Add({\n \"beneId\": \"JOHN180127\", \n \"name\": \"john doe\",\n \"email\": \"johndoe@cashfree.com\", \n \"phone\": \"9876543210\",\n \"bankAccount\": \"00011020001773\", \n \"address1\" : \"ABC Street\", \n \"city\": \"Bangalore\", \n \"state\":\"Karnataka\", \n \"pincode\": \"560001\"\n });","name":"Node"},{"language":"java","code":"import com.cashfree.lib.clients.Payouts;\nimport com.cashfree.lib.clients.Payouts;\nimport com.cashfree.lib.clients.Beneficiary;\nimport com.cashfree.lib.domains.BeneficiaryDetails;\n\npublic static void main(){\n\nPayouts payouts = Payouts.getInstance(\n Environment.PRODUCTION, \"\u003cclient_id>\", \"\u003cclient_secret>\");\npayouts.init();\nBeneficiary beneficiary = new Beneficiary(payouts);\n\nBeneficiaryDetails beneficiaryDetails = new BeneficiaryDetails()\n .setBeneId(\"JOHN18012\")\n .setName(\"john doe\")\n .setEmail(\"johndoe@cashfree.com\")\n .setPhone(\"9876543210\")\n .setBankAccount(\"00001111222233\")\n .setIfsc(\"HDFC0000001\")\n .setAddress1(\"ABC Street\")\n .setCity(\"Bangalore\")\n .setState(\"Karnataka\")\n .setPincode(\"560001\");\n\nbeneficiary.addBeneficiary(beneficiaryDetails);\n}"},{"language":"python","code":"from cashfree_sdk.payouts import Payouts\nfrom cashfree_sdk.payouts.beneficiary import Beneficiary\n\nbene_add = Benefeciary.add(beneId=\"JOHN18012\", name=\"john doe\", email=\"johndoe@cashfree.com\", phone=\"9876543210\", address1=\"ABC Street\", bankAccount=\"00001111222233\", ifsc=\"HDFC0000001\")"}],"samples-languages":["curl","text","java","python"]},"method":"post","type":"path","servers":["10251349-8ea6-461b-a475-c78010bd6cd0"],"path":"/payout/v1/addBeneficiary","baseUrlOptions":["https://payout-api.cashfree.com"],"title":"Add Beneficiary","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"aa59299c-b06e-4812-a43b-b261957ced94":{"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"}},"ae5db00b-ddac-4020-bfc6-26da3d905d15":{"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"}}},"requestBody":{"content":{"application/json":{"schema":{"required":["address1","beneId","email","name","phone"],"type":"object","properties":{"beneId":{"type":"string","description":"Unique Beneficiary ID to identify the beneficiary. Alphanumeric and underscore (_) allowed (50 character limit)","isRequired":true,"uniqueKey":"beneId","typeLabel":"string"},"name":{"type":"string","description":"It is the name of the beneficiary. A maximum of 100 characters are allowed. Alphabets, numbers, white spaces ( ), and special characters are allowed.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"email":{"type":"string","description":"Beneficiaries email, string in email Id format (Ex: johndoe_1@cashfree.com) - should contain @ and dot (.) - (200 character limit)","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"phone":{"type":"string","description":"Beneficiaries phone number, phone number registered in India (only digits, 8 - 12 characters after stripping +91)","isRequired":true,"uniqueKey":"phone","typeLabel":"string"},"address1":{"type":"string","description":"Beneficiaries address, alphanumeric and space allowed (but script, HTML tags gets sanitized or removed) (150 character limit)","isRequired":true,"uniqueKey":"address1","typeLabel":"string"},"bankAccount":{"type":"string","description":"Beneficiary bank account (9 - 18 alphanumeric character limit)","uniqueKey":"bankAccount","typeLabel":"string"},"ifsc":{"type":"string","description":"Accounts IFSC (standard IFSC format) - length 11, first four bank IFSC and 5th digit 0","uniqueKey":"ifsc","typeLabel":"string"},"vpa":{"type":"string","description":"Beneficiary VPA, alphanumeric, dot (.), hyphen (-), at sign (@), and underscore (_) allowed (100 character limit). Note: underscore (_) and dot (.) gets accepted before and after at sign (@), but hyphen (-) get only accepted before at sign (@)","uniqueKey":"vpa","typeLabel":"string"},"address2":{"type":"string","description":"Beneficiary address, alphanumeric and space allowed (but script, HTML tags gets sanitized or removed) (150 character limit)","uniqueKey":"address2","typeLabel":"string"},"city":{"type":"string","description":"Beneficiary city, only alphabets and white space (50 character limit)","uniqueKey":"city","typeLabel":"string"},"state":{"type":"string","description":"Beneficiary state, only alphabets and white space (50 character limit)","uniqueKey":"state","typeLabel":"string"},"pincode":{"type":"string","description":"Beneficiaries pincode, only numbers (6 character limit)","uniqueKey":"pincode","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"beneId":"\u003cstring>","name":"\u003cstring>","email":"\u003cstring>","phone":"\u003cstring>","address1":"\u003cstring>","bankAccount":"\u003cstring>","ifsc":"\u003cstring>","vpa":"\u003cstring>","address2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","pincode":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"469cbbc0-a98b-4894-8688-6600fd971962":{"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":"Beneficiary added successfully","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"SUCCESS","subCode":"200","message":"Beneficiary added successfully"}}},"exampleType":"generated"}},"exampleType":"generated"},"85a28ba1-e45f-439b-93fe-21227520bfb5":{"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://telr.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://telr.cashfree.com/merchants/landing?env=prod\u0026raise_issue=1)"}}},"exampleType":"generated"}},"exampleType":"generated"},"2c1ad69e-a477-4398-9918-f6986ec9771e":{"description":"409","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"ERROR","uniqueKey":"status","typeLabel":"string"},"subCode":{"type":"string","example":"409","uniqueKey":"subCode","typeLabel":"string"},"message":{"type":"string","example":"Beneficiary Id already exists","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"ERROR","subCode":"409","message":"Beneficiary Id already exists"}}},"exampleType":"generated"}},"exampleType":"generated"},"0241cf3e-be03-4b09-8a8b-bc2c76785b2a":{"description":"412","content":{"text/plain":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"ERROR","uniqueKey":"status","typeLabel":"string"},"subCode":{"type":"string","example":"412","uniqueKey":"subCode","typeLabel":"string"},"message":{"type":"string","example":"Post data is empty or not a valid JSON","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"ERROR","subCode":"412","message":"Post data is empty or not a valid JSON"}}},"exampleType":"generated"}},"exampleType":"generated"},"6fc2518a-6933-4e94-bbdc-afe86539ec4e":{"description":"422","content":{"text/plain":{"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 Bank IFSC code.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"ERROR","subCode":"422","message":"Please provide a valid Bank IFSC code."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"10251349-8ea6-461b-a475-c78010bd6cd0":{"url":"https://payout-api.cashfree.com"}}},"originalFileLocation":"openapi/payouts/payoutsv1.yaml"},"subdomain":"telr","siteName":"Telr Developer Documentation","title":"Telr Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T08:44:26.118Z","originalFileLocation":"api-reference/payouts/v1/add-beneficiary.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 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.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Telr Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/telr/JiXfTWYaV_zG4vhd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/telr/JiXfTWYaV_zG4vhd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/telr/JiXfTWYaV_zG4vhd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/telr/JiXfTWYaV_zG4vhd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/telr/JiXfTWYaV_zG4vhd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/telr/JiXfTWYaV_zG4vhd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/telr/JiXfTWYaV_zG4vhd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/telr/JiXfTWYaV_zG4vhd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/telr/JiXfTWYaV_zG4vhd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Telr Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to the Telr developer documentation. You will find help about Telr products and APIs that will help you start using our products quickly.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Telr Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://telr-docs.cashfree.com/api-reference/payouts/v1/add-beneficiary\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://telr.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Add+Beneficiary\u0026amp;description=Use+this+API+to+add+a+beneficiary+to+your+Cashfree+account+by+providing+the+bank+account+number%2C+IFSC%2C+and+other+required+details.+Before+you+request+a+transfer\u0026amp;theme=e88f79f2755d6f795d89763f\u0026amp;signature=9bc4f1ea5d27fac58af1e0de1eedad6bffb75d8a8119c7e82562da0b5976f8b8\">\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=\"Telr Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to the Telr developer documentation. You will find help about Telr products and APIs that will help you start using our products quickly.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://telr.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Add+Beneficiary\u0026amp;description=Use+this+API+to+add+a+beneficiary+to+your+Cashfree+account+by+providing+the+bank+account+number%2C+IFSC%2C+and+other+required+details.+Before+you+request+a+transfer\u0026amp;theme=e88f79f2755d6f795d89763f\u0026amp;signature=9bc4f1ea5d27fac58af1e0de1eedad6bffb75d8a8119c7e82562da0b5976f8b8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/telr/JiXfTWYaV_zG4vhd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Telr Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006E4F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://telr-docs.cashfree.com/api-reference/payouts/v1/add-beneficiary\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payouts/v1/add-beneficiary.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://telr-docs.cashfree.com/#organization\",\"name\":\"Telr Developer Documentation\",\"url\":\"https://telr-docs.cashfree.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/telr/0gWXSd3fXAm_cMMR/static/logo/Telr_Logo.png?fit=max\u0026auto=format\u0026n=0gWXSd3fXAm_cMMR\u0026q=85\u0026s=1eab94fcaa68dc82f3f3201b2a47e789\"}},{\"@type\":\"WebSite\",\"@id\":\"https://telr-docs.cashfree.com#website\",\"name\":\"Telr Developer Documentation\",\"url\":\"https://telr-docs.cashfree.com\",\"publisher\":{\"@id\":\"https://telr-docs.cashfree.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://telr-docs.cashfree.com/api-reference/payouts/v1/add-beneficiary#webpage\",\"url\":\"https://telr-docs.cashfree.com/api-reference/payouts/v1/add-beneficiary\",\"name\":\"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.\",\"dateModified\":\"2026-01-07T08:44:26.118Z\",\"isPartOf\":{\"@id\":\"https://telr-docs.cashfree.com#website\"}},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://telr-docs.cashfree.com/api-reference/payouts/v1/add-beneficiary#apireference\",\"headline\":\"Add Beneficiary\",\"name\":\"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.\",\"url\":\"https://telr-docs.cashfree.com/api-reference/payouts/v1/add-beneficiary\",\"mainEntityOfPage\":{\"@id\":\"https://telr-docs.cashfree.com/api-reference/payouts/v1/add-beneficiary#webpage\"},\"dateModified\":\"2026-01-07T08:44:26.118Z\",\"publisher\":{\"@id\":\"https://telr-docs.cashfree.com/#organization\"},\"isPartOf\":{\"@id\":\"https://telr-docs.cashfree.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Telr Developer Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Telr Developer Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/payouts/v1/add-beneficiary.md","siteName":"Telr Developer Documentation","nav":{"global":null,"tabs":[{"tab":"Payments","groups":[{"group":"Payments","pages":[{"title":"Introduction","sidebarTitle":"Introduction","href":"/payments/overview"}]},{"group":"Payment Gateway","pages":[{"group":"Telr Hosted Checkout","pages":[{"title":"Telr Hosted Checkout","sidebarTitle":"Integration","href":"/payments/online/web/redirect"}]},{"group":"Custom Web Checkout","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/online/element/overview"},{"title":"Introducing Cashfree.js","sidebarTitle":"Introducing Cashfree.js","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":"Component Customization","sidebarTitle":"Customize 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"}]},{"group":"No Code","pages":[{"title":"No Code","sidebarTitle":"Overview","href":"/payments/no-code/overview"},{"title":"Telr Payment Button","sidebarTitle":"Payment Button","href":"/payments/no-code/payment-button"},{"title":"Payment Link","sidebarTitle":"Payment Link","href":"/payments/no-code/payment-link"},{"group":"Payment Forms","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/no-code/payment-forms/overview"},{"title":"Webhooks","sidebarTitle":"Webhooks","href":"/payments/no-code/payment-forms/webhooks"}]},{"group":"Customise experience","pages":[{"title":"Custom SMS message","sidebarTitle":"Custom SMS message","href":"/payments/no-code/customize/custom-sms"},{"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":"Webhooks for Payment links and forms","sidebarTitle":"Webhooks","href":"/payments/no-code/customize/webhooks"}]}]},{"group":"Webhooks","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/payments/online/webhooks/overview"},{"title":"Configuration","sidebarTitle":"Configuration","href":"/payments/online/webhooks/configure"}]},{"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":"Manage","pages":[{"title":"Payment Methods","sidebarTitle":"Payment Methods","href":"/payments/manage/payment-methods"},{"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":"Settlements","sidebarTitle":"Settlements","href":"/payments/manage/settlements"},{"title":"Reports","sidebarTitle":"Reports","href":"/payments/manage/reports"},{"title":"Transactions","sidebarTitle":"Transactions","href":"/payments/manage/transactions"}]}]}]},{"tab":"Payments APIs","groups":[{"group":"Payments API","pages":[{"title":"Get Started","sidebarTitle":"Get Started","href":"/api-reference/payments/overview"},{"title":"Payment SDK","sidebarTitle":"Payment SDK","href":"/api-reference/payments/sdk"},{"title":"API Limits","sidebarTitle":"API Limits","href":"/api-reference/payments/rate-limits"},{"title":"Enums","sidebarTitle":"Enums","href":"/api-reference/payments/enums"},{"title":"API Best Practices","sidebarTitle":"Best Practices","href":"/api-reference/payments/api-best-practices"},{"title":"Errors","sidebarTitle":"Errors","href":"/api-reference/payments/errors"}]},{"group":"v2025-01-01","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/api-reference/payments/latest/overview"},{"group":"Orders","pages":[{"title":"Create Order","openapi":"openapi/payments/v2025-01-01.yaml post /orders","href":"/api-reference/payments/latest/orders/create"},{"title":"Get Order","openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}","href":"/api-reference/payments/latest/orders/get"},{"title":"Terminate Order","openapi":"openapi/payments/v2025-01-01.yaml patch /orders/{order_id}","href":"/api-reference/payments/latest/orders/terminate"},{"title":"Get Order Extended","openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}/extended","href":"/api-reference/payments/latest/orders/get-order-extended"},{"title":"Update Order Extended","openapi":"openapi/payments/v2025-01-01.yaml put /orders/{order_id}/extended","href":"/api-reference/payments/latest/orders/update-order-extended"}]},{"group":"Payments","pages":[{"title":"Order Pay","openapi":"openapi/payments/v2025-01-01.yaml post /orders/sessions","href":"/api-reference/payments/latest/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/latest/payments/authenticate"},{"title":"Preauthorization","openapi":"openapi/payments/v2025-01-01.yaml post /orders/{order_id}/authorization","href":"/api-reference/payments/latest/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/latest/payments/get"},{"title":"Get Payments for an Order","openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}/payments","href":"/api-reference/payments/latest/payments/get-payments-for-order"},{"title":"Payment Webhooks","sidebarTitle":"Payment Webhooks","icon":"webhook","href":"/api-reference/payments/latest/payments/webhooks"}]},{"group":"Payment Links","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /links","title":"Create Payment Link","href":"/api-reference/payments/latest/payment-links/create"},{"openapi":"openapi/payments/v2025-01-01.yaml get /links/{link_id}","title":"Fetch Payment Link Details","href":"/api-reference/payments/latest/payment-links/get"},{"openapi":"openapi/payments/v2025-01-01.yaml post /links/{link_id}/cancel","title":"Cancel Payment Link","href":"/api-reference/payments/latest/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/latest/payment-links/get-orders-for-link"},{"title":"Payment Link Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/latest/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/latest/refunds/create"},{"openapi":"openapi/payments/v2025-01-01.yaml get /orders/{order_id}/refunds/{refund_id}","title":"Get Refund","href":"/api-reference/payments/latest/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/latest/refunds/get-refunds-for-order"},{"title":"Refund Webhooks","sidebarTitle":"Webhooks","icon":"webhook","href":"/api-reference/payments/latest/refunds/webhooks"}]},{"group":"Customers","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /customers","title":"Create Customer at Cashfree","href":"/api-reference/payments/latest/customers/create"}]},{"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/latest/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/latest/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/latest/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/latest/eligibility/get-eligible-payment-methods"}]},{"group":"Offers","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /offers","title":"Create Offer","href":"/api-reference/payments/latest/offers/create"},{"openapi":"openapi/payments/v2025-01-01.yaml get /offers/{offer_id}","title":"Get Offer by ID","href":"/api-reference/payments/latest/offers/get"}]},{"group":"Settlements","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /settlements","title":"Get All Settlements","href":"/api-reference/payments/latest/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/latest/settlements/get-settlements-for-order"},{"openapi":"openapi/payments/v2025-01-01.yaml post /orders/settlements","title":"Mark Order For Settlement","href":"/api-reference/payments/latest/settlements/mark-order-for-settlement"},{"openapi":"openapi/payments/v2025-01-01.yaml post /recon","title":"PG Reconciliation","href":"/api-reference/payments/latest/settlements/reconcile"},{"title":"Settlement Reconciliation","openapi":"openapi/payments/v2025-01-01.yaml post /settlement/recon","href":"/api-reference/payments/latest/settlements/settlement-reconciliation"},{"title":"Settlement Webhooks","sidebarTitle":"Settlement Webhooks","icon":"webhook","href":"/api-reference/payments/latest/settlements/settlement-webhooks"}]},{"group":"Simulation","pages":[{"openapi":"openapi/payments/v2025-01-01.yaml post /simulate","title":"Simulate Payment","href":"/api-reference/payments/latest/simulation/simulate-payment"},{"openapi":"openapi/payments/v2025-01-01.yaml get /simulate/{simulation_id}","title":"Fetch Simulation","href":"/api-reference/payments/latest/simulation/fetch-simulation"}]},{"group":"Utilities","pages":[{"openapi":"post /utilities/cardbin","title":"Get Card BIN Details","href":"/api-reference/payments/latest/utilities/get-card-bin"},{"title":"Incident Service Webhook","icon":"webhook","sidebarTitle":"Incident Webhooks","href":"/api-reference/payments/latest/utilities/incident-webhook"}]}]}]},{"tab":"API Reference","groups":[{"group":"API","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"}]}]},{"tab":"Help Center","groups":[{"group":"Help Center","pages":[{"title":"Telr FAQs","sidebarTitle":"Overview","href":"/help/overview"}]},{"group":"Payment Gateway","pages":[{"title":"Transactions","sidebarTitle":"Transactions","href":"/help/payments/transactions/transactions"},{"title":"Summary","sidebarTitle":"Summary","href":"/help/payments/transactions/summary"},{"title":"Settlements","sidebarTitle":null,"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":"Product Walkthrough","sidebarTitle":"Product Walkthrough","href":"/help/payments/product-walkthrough/product-walkthrough"},{"title":"Payment Links FAQs","sidebarTitle":"Payment Links","href":"/help/payment-links/faqs/faqs"},{"title":"Payment Forms FAQs","sidebarTitle":"Payment Forms","href":"/help/payment-forms/faqs/faqs"}]}]}]},"basePath":"","title":"Telr Developer Documentation","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}