Skip to main content
POST
/
api
/
v2
/
payout
/
beneficiary
/
create
Add Beneficiary
curl --request POST \
  --url https://api.paytring.com/api/v2/payout/beneficiary/create \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "user",
  "phone": "<string>",
  "email": "<string>",
  "address": "delhi",
  "account_number": "<string>",
  "ifsc": "<string>",
  "vpa": "<string>"
}
'
"{\n    \"status\": true,\n    \"message\": \"Beneficiary Account Added successfully.\",\n    \"beneficiary_id\": \"59113xxxxxxxxx6\"\n}"
This API is used to add a new beneficiary to the payout system.

​
Request Body

{
  "name": "string", // Beneficiary name
  "email": "string", // Beneficiary email
  "phone": "string", // Beneficiary phone number
  "vpa": "string", // Virtual Payment Address (VPA)
  "account": {
    "account_no": "string", // Account number
    "ifsc": "string" // IFSC code
  }
}

​
Responses

​
200 OK

{
  "status": true,
  "beneficiary_id": "string"
}

​
400 Bad Request

{
  "status": false,
  "error": {
    "message": "Invalid request",
    "code": 400
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
name
string
default:user
required

Name of Beneficiary

​
phone
string
required

Phone no of Beneficiary. eg. 9900990099

​
email
string
required

Email of Beneficiary

​
address
string
default:delhi
required

Address of Beneficiary

​
account_number
string
required

Account Number of Beneficiary

​
ifsc
string
required

IFS Code of Beneficiary Account

​
vpa
string
required

Response

200

​
status
boolean
default:true
Example:

true

​
message
string
Example:

"Beneficiary Account Added successfully."

​
beneficiary_id
string
Example:

"59113xxxxxxxxx6"