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>"
}
'
import requests

url = "https://api.paytring.com/api/v2/payout/beneficiary/create"

payload = {
"name": "user",
"phone": "<string>",
"email": "<string>",
"address": "delhi",
"account_number": "<string>",
"ifsc": "<string>",
"vpa": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'user',
phone: '<string>',
email: '<string>',
address: 'delhi',
account_number: '<string>',
ifsc: '<string>',
vpa: '<string>'
})
};

fetch('https://api.paytring.com/api/v2/payout/beneficiary/create', 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://api.paytring.com/api/v2/payout/beneficiary/create",
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([
'name' => 'user',
'phone' => '<string>',
'email' => '<string>',
'address' => 'delhi',
'account_number' => '<string>',
'ifsc' => '<string>',
'vpa' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);

$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://api.paytring.com/api/v2/payout/beneficiary/create"

payload := strings.NewReader("{\n \"name\": \"user\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"delhi\",\n \"account_number\": \"<string>\",\n \"ifsc\": \"<string>\",\n \"vpa\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.paytring.com/api/v2/payout/beneficiary/create")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"user\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"delhi\",\n \"account_number\": \"<string>\",\n \"ifsc\": \"<string>\",\n \"vpa\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.paytring.com/api/v2/payout/beneficiary/create")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"user\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"delhi\",\n \"account_number\": \"<string>\",\n \"ifsc\": \"<string>\",\n \"vpa\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
"{\n    \"status\": true,\n    \"message\": \"Beneficiary Account Added successfully.\",\n    \"beneficiary_id\": \"59113xxxxxxxxx6\"\n}"
"{\n    \"status\": false,\n    \"error\": {\n        \"message\": \"Hash is not verified\",\n        \"code\": 204\n    }\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"