Get Beneficiary ID

Use this API to get the beneficiary ID by providing the bank account number and ifsc.

GET /payout/v1/getBeneId

Get Beneficiary ID

cURL

curl --request GET \
  --url https://payout-api.cashfree.com/payout/v1/getBeneId \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'

import requests

url = "https://payout-api.cashfree.com/payout/v1/getBeneId"

headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'}
};

fetch('https://payout-api.cashfree.com/payout/v1/getBeneId', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payout-api.cashfree.com/payout/v1/getBeneId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://payout-api.cashfree.com/payout/v1/getBeneId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://payout-api.cashfree.com/payout/v1/getBeneId")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://payout-api.cashfree.com/payout/v1/getBeneId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'

response = http.request(request)
puts response.read_body

200

{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "beneId retrieved successfully",
  "data": {
    "beneId": "JOHN18011"
  }
}

{
  "status": "ERROR",
  "subCode": "403",
  "message": "APIs not enabled. Please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1)"
}

{
  "status": "ERROR",
  "subCode": "404",
  "message": "Beneficiary not found with given bank account details"
}

This API will be retired soon. Please plan to migrate to the latest version, Beneficiary V2.

Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)

Click to view the response codes.

Sub code	Status	Message	Next action
200	SUCCESS	BeneId retrieved successfully	-
52	ERROR	Error while fetching beneId	Retry or try again after some time.
403	ERROR	Token is not valid	Validate the generated token.
403	ERROR	IP not whitelisted	Whitelist the IP address.
404	ERROR	Beneficiary not found with given bank account details	Enter a valid bank account number and IFSC.
412	ERROR	Token missing in the request	Enter the generated token as the value for Authorization under Headers in this format: Bearer <token>.
422	ERROR	Please provide a valid bank account and ifsc	Enter a valid bank account number and IFSC.
422	ERROR	Please provide both bank account and ifsc	Enter both the bank account number and IFSC.
422	ERROR	Please provide a valid ifsc	Enter 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

application/json

200

status · string

Example:

"SUCCESS"

subCode · string

Example:

"200"

message · string

Example:

"beneId retrieved successfully"

data · object

Show child attributes