Remove Beneficiary

Use this API to remove an existing beneficiary from a list of added beneficiaries.

POST /payout/v1/removeBeneficiary

Remove Beneficiary

cURL

curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1/removeBeneficiary \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "beneId": "<string>"
}
'

import requests

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

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

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({beneId: '<string>'})
};

fetch('https://payout-api.cashfree.com/payout/v1/removeBeneficiary', 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/removeBeneficiary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'beneId' => '<string>'
  ]),
  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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"beneId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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.post("https://payout-api.cashfree.com/payout/v1/removeBeneficiary")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .body("{\n  \"beneId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n  \"beneId\": \"<string>\"\n}"

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

200

{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Beneficiary removed"
}

{}

{
  "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)"
}

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	Beneficiary removed	-
403	ERROR	Token is not valid	Validate the generated token.
403	ERROR	IP not whitelisted	Whitelist the IP address.
404	ERROR	Beneficiary does not exist with given Id	Enter a valid beneficiary ID.
412	ERROR	Token missing in the request	Enter the generated token as the value for Authorization under Headers in this format: Bearer <token>
412	ERROR	BeneId missing in the request	Enter a valid beneficiary ID.
422	ERROR	Please provide a valid Beneficiary Id	Enter a valid beneficiary ID.
520	ERROR	Unknown error occurred	Try again after some time.

Headers

Authorization · string · required

Bearer auth token

Content-Type · string · required

application/json

Body

application/json

beneId · string · required

Beneficiaries Id to delete, alphanumeric and underscore allowed (50 character limit)

Response

200

application/json

200

status · string

Example:

"SUCCESS"

subCode · string

Example:

"200"

message · string

Example:

"Beneficiary removed"