POST
/
beneficiary
curl --request POST \
  --url https://sandbox.cashfree.com/payout/beneficiary \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "beneficiary_id": "JOHN18011343",
  "beneficiary_name": "John Doe",
  "beneficiary_instrument_details": {
    "bank_account_number": "1223334444",
    "bank_ifsc": "HDFC0000001",
    "vpa": "test@upi"
  },
  "beneficiary_contact_details": {
    "beneficiary_email": "sample@cashfree.com",
    "beneficiary_phone": "9876543210",
    "beneficiary_country_code": "+91",
    "beneficiary_address": "177A Bleecker Street",
    "beneficiary_city": "New York City",
    "beneficiary_state": "New York",
    "beneficiary_postal_code": "560011"
  }
}'
{
  "beneficiary_id": "JOHN18011343",
  "beneficiary_name": "John Doe",
  "beneficiary_instrument_details": {
    "bank_account_number": "1223334444",
    "bank_ifsc": "HDFC0000001",
    "vpa": "test@upi"
  },
  "beneficiary_contact_details": {
    "beneficiary_email": "sample@cashfree.com",
    "beneficiary_phone": "9876543210",
    "beneficiary_country_code": "+91",
    "beneficiary_address": "177A Bleecker Street",
    "beneficiary_city": "New York City",
    "beneficiary_state": "New York",
    "beneficiary_postal_code": "560011"
  },
  "beneficiary_status": "VERIFIED",
  "added_on": "2023-12-04T15:50:00Z"
}

Authorizations

ā€‹
x-client-id
string
headerrequired

Client ID. You can find your app id in the Merchant Dashboard.

ā€‹
x-client-secret
string
headerrequired

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

ā€‹
x-api-version
string
default: 2024-01-01required

It is the API version to be used. The accepted format is YYYY-MM-DD.

ā€‹
x-request-id
string

It is the request ID for the API call. This ID can be used to resolve tech realted issues. Communicate this in your tech related queries to Cashfree Payments.

Body

application/json

Find the request parameters to create a beneficiary

ā€‹
beneficiary_id
string
required

It is the unique ID you create to identify the beneficiary. Alphanumeric, underscore ( _ ), pipe ( | ), and dot ( . ) are allowed.

Maximum length: 50
ā€‹
beneficiary_name
string
required

It is the name of the beneficiary. The maximum character limit is 100. Only alphabets and whitespaces are allowed.

Maximum length: 100
ā€‹
beneficiary_instrument_details
object

Beneficiary instrument details

ā€‹
beneficiary_contact_details
object

It should contain the contact details of the beneficiary.

Response

201 - application/json

Contains the information of the created beneficiary

ā€‹
beneficiary_id
string

It displays the unique Id you created to identify the beneficiary.

ā€‹
beneficiary_name
string

It displays the name of the beneficiary.

ā€‹
beneficiary_instrument_details
object

It displays the payment instrument details of the beneficiary.

ā€‹
beneficiary_contact_details
object

It displays the contact details of the beneficiary.

ā€‹
beneficiary_status
enum<string>

It displays the current status of the beneficiary. Possible values are as follows

  • VERIFIED: Beneficiary is verified and is available for payouts
  • INVALID: Beneficiary is invalid
  • INITIATED: Beneficiary verification initiated
  • CANCELLED: Beneficiary verification cancelled
  • FAILED: Failed to verify beneficiary
  • DELETED: Beneficiary is deleted
Available options:
VERIFIED,
INVALID,
INITIATED,
CANCELLED,
FAILED,
DELETED
ā€‹
added_on
string

It displays the time of the addition of the beneficiary in UTC.

Was this page helpful?

Get Beneficiary V2Remove Beneficiary V2