Skip to main content
GET
/
payout
/
v1
/
getBeneId
Get Beneficiary ID
curl --request GET \
  --url https://payout-api.cashfree.com/payout/v1/getBeneId \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
"{\n  \"status\": \"SUCCESS\", \n  \"subCode\": \"200\", \n  \"message\": \"beneId retrieved successfully\", \n  \"data\":\n  {\n    \"beneId\": \"JOHN18011\"\n  }\n}"
This API will be retired soon. Please plan to migrate to the latest version, Beneficiary V2.
Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)
Sub CodeStatusMessageNext Action
200SUCCESSBeneId retrieved successfully-
52ERRORError while fetching beneIdRetry or try again after some time.
403ERRORToken is not validValidate the generated token.
403ERRORIP not whitelistedWhitelist the IP address.
404ERRORBeneficiary not found with given bank account detailsEnter a valid bank account number and IFSC.
412ERRORToken missing in the requestEnter the generated token as the value for Authorization under Headers in this format: Bearer <token>.
422ERRORPlease provide a valid bank account and ifscEnter a valid bank account number and IFSC.
422ERRORPlease provide both bank account and ifscEnter both the bank account number and IFSC.
422ERRORPlease provide a valid ifscEnter a valid IFSC.

Headers

ā€‹
Authorization
string
required

Bearer auth token

ā€‹
Content-Type
string
required

application/json

Query Parameters

ā€‹
bankAccount
string

Beneficiaries bank account number, alphanumeric ( >=6 and <= 40 characters).

ā€‹
ifsc
string

Beneficiaries bank's IFSC code (standard IFSC format) - length 11, first four IFSC and 5th character must be 0.

Response

200

ā€‹
status
string
Example:

"SUCCESS"

ā€‹
subCode
string
Example:

"200"

ā€‹
message
string
Example:

"beneId retrieved successfully"

ā€‹
data
object