Beneficiary

You can manage beneficiaries with the set of API provided below. You can make a transfer request only against an added beneficiary.

post
Create Beneficiary

https://public_key:[email protected]/v1/payout/beneficiary/create
Use this api to create a beneficiary on your account to use it for initiating transfer. You can get your keys from the payout api dashboard.
Request
Response
Request
Body Parameters
acc_number
required
string
Account number of the beneficiary
ifsc
required
string
IFSC code for the account
name
required
string
Account holder name
beneficiary_ref
required
string
Unique Reference id for the beneficiary. Accepts only alpha numeric.
Response
200: OK
{
"success": true,
"message": "Beneficiary created Successfully"
}
{
"acc_number":"50100012345678",
"ifsc":"HDFC0000001",
"name":"Account Holder Name",
"beneficiary_ref":"reference_id"
}

get
Beneficiary List

https://public_key:[email protected]/v1/payout/beneficiary/list
Use this api to fetch list of beneficiaries on your account. You can get your keys from the payout api dashboard.
Request
Response
Request
Query Parameters
limit
optional
number
Limits the number of records to fetch
page
optional
number
The page number to fetch the list
Response
200: OK
{
"success": true,
"message": "Beneficiary list",
"data": {
"beneficiaries": [
{
"account": {
"number": "501000000012345678",
"ifsc": "HDFC0000001"
}
"name": {
"first": "",
"last": "",
"full": "Jaikumar R"
}
"status": "active",
"merchant_id": "XXXXXX",
"beneficiary_id": "bene_XXXX",
"beneficiary_ref": "unique_beneficiary_ref",
"tags": [],
"updatedAt": "2021-05-11T14:23:05.112Z",
"createdAt": "2021-05-11T14:23:04.668Z"
}
],
"total": 1
}
}

get
Get Beneficiary Details

https://public_key:[email protected]/v1/payout/beneficiary/getdetails/{beneficiary_ref}
Use this api to get a particular beneficiary on your account. You can get your keys from the payout api dashboard.
Request
Response
Request
Path Parameters
beneficiary_ref
optional
string
Reference id of the beneficiary
Response
200: OK
{
"success": true,
"message": "Beneficiary Detail",
"data": {
"beneficiary":
{
"account": {
"number": "501000000012345678",
"ifsc": "HDFC0000001"
}
"name": {
"first": "",
"last": "",
"full": "Jaikumar R"
}
"status": "active",
"merchant_id": "XXXXXX",
"beneficiary_id": "bene_XXXX",
"beneficiary_ref": "unique_beneficiary_ref",
"tags": [],
"updatedAt": "2021-05-11T14:23:05.112Z",
"createdAt": "2021-05-11T14:23:04.668Z"
}
}
}