Cashfree Payments Developer Documentation home pagelight logodark logo
  • Discord
  • Create Account
  • Create Account
Payments
Payouts
Secure ID
Partners and Platforms
Payments APIs
Payouts APIs
Secure ID APIs
Partners APIs
Additional APIs
API Reference
AI and Tools
Help Center
Payout APIs
  • Overview
  • Getting Started
  • Account
  • Authentication
V2
  • Overview
  • Transfers V2
  • Beneficiary V2
    • GET
      Get Beneficiary V2
    • POST
      Create Beneficiary V2
    • DEL
      Remove Beneficiary V2
  • Webhooks Version V2
  • Response Codes
V1
  • Overview
  • Batch Transfer V1.3
  • Beneficiary
  • Incidents
  • Transfers
  • Transfers V1.2
  • Webhook Version V1
One Escrow
  • POST
    Create Virtual Account
  • POST
    Transfer Funds Between VAs
  • GET
    Get Account Statement
  • POST
    Allocate Funds to Virtual Account
  • GET
    Get Fund Source Details
  • POST
    Add Registered Recharge Account(Whitelist Bank Account)
  • POST
    Debit Connected Wallet
Cashgram
  • End Points
  • Postman Collection
  • Webhooks
  • POST
    Create Cashgram
  • POST
    Deactivate Cashgram
  • GET
    Get Cashgram Status
  • Response Codes
Beneficiary V2

Get Beneficiary V2

Use this API to get the details of a particular beneficiary from your account. You can pass either beneficiary_id or the combination of bank_account_number and bank_ifsc to fetch the details.

Click to view the response codes.

HTTP Status CodeError CodeMessageNext Action
200---
400too_many_parameters_in_requestPlease provide either bank_account_number and bank_ifsc together or beneficiary_id alone. Do not include all three parameters in the requestPlease provide either bank_account_number and bank_ifsc together or beneficiary_id alone. Do not include all three parameters in the request.
400bank_ifsc_missingbank_ifsc : should be provided with the request if bank_account_number is providedProvide a valid bank_ifsc if bank_account_number is provided.
400bank_account_number_missingbank_account_number: should be provided with the request if bank_ifsc is providedProvide a valid bank_account_number is bank_ifsc is provided.
400beneficiary_identifiers_missingbeneficiary_identifiers_missing beneficiary_identifiers : Either beneficiary_id or the combination of bank_account_number and bank_ifsc has to be provided with the requestPlease provide either beneficiary_id or the combination of bank_account_number and bank_ifsc.
400beneficiary_id_length_exceededbeneficiary_id : should not be more than 50 characters long. value received: test_bene_idEnter a valid beneficiary_id
400beneficiary_id_invalidbeneficiary_id : should contain only letters, numbers, hyphen, underscore, pipe, and dot. Value received: .\qewqefwqevEnter a valid beneficiary_id.
400bank_account_number_length_exceededbank_account_number : should not be more than 25 characters long. value received: 235142352346523462456345263452345Provide a valid bank_account_number.
400bank_account_number_length_shortbank_account_number : should not be less than 4 characters long. value received: 12Provide a valid bank_account_number.
.400bank_account_number_invalidbank_account_number : should be alphanumeric. value received: 123@Provide a valid bank_account_number.
400bank_ifsc_invalidbank_ifsc : please provide a valid IFSC. value received: SBIN00708410Provide a valid bank_ifsc.
404beneficiary_not_foundBeneficiary does not existProvide the details of an existing beneficiary. If such a beneficiary does not exist, use CREATE API to create a new beneficiary.
404beneficiary_not_foundBeneficiary with the given bank_account_number and bank_ifsc does not existProvide the details of an existing beneficiary. If such a beneficiary does not exist, use CREATE API to create a new beneficiary
404beneficiary_not_foundBeneficiary exists with the given bank_account_number but a different bank_ifscIf the required a beneficiary does not exist, use CREATE API to create a new beneficiary

Was this page helpful?

Batch Transfer V2Create Beneficiary V2
githubyoutubewebsite
Assistant
Responses are generated using AI and may contain mistakes.