Create Beneficiary
curl --request POST \
--url https://service-sandbox.tazapay.com/v3/beneficiary \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "acc_cr83unf7j0t2odh9ioc0",
"name": "test",
"type": "individual",
"email": "test@example.com",
"tax_id": "",
"destination_details": {
"type": "bank",
"bank": {
"country": "IN",
"currency": "INR",
"bank_codes": {
"swift_code": "Test",
"ifsc_code": "Test"
},
"bank_name": "hdfc",
"account_number": "Test",
"firc_required": true,
"purpose_code": "Test"
}
},
"address": {
"line1": "Test",
"line2": "Test",
"city": "Test",
"state": "Test",
"country": "IN",
"postal_code": "110017"
},
"phone": {
"number": "",
"calling_code": "91"
},
"nationality": "IN"
}
'import requests
url = "https://service-sandbox.tazapay.com/v3/beneficiary"
payload = {
"account_id": "acc_cr83unf7j0t2odh9ioc0",
"name": "test",
"type": "individual",
"email": "test@example.com",
"tax_id": "",
"destination_details": {
"type": "bank",
"bank": {
"country": "IN",
"currency": "INR",
"bank_codes": {
"swift_code": "Test",
"ifsc_code": "Test"
},
"bank_name": "hdfc",
"account_number": "Test",
"firc_required": True,
"purpose_code": "Test"
}
},
"address": {
"line1": "Test",
"line2": "Test",
"city": "Test",
"state": "Test",
"country": "IN",
"postal_code": "110017"
},
"phone": {
"number": "",
"calling_code": "91"
},
"nationality": "IN"
}
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({
account_id: 'acc_cr83unf7j0t2odh9ioc0',
name: 'test',
type: 'individual',
email: 'test@example.com',
tax_id: '',
destination_details: {
type: 'bank',
bank: {
country: 'IN',
currency: 'INR',
bank_codes: {swift_code: 'Test', ifsc_code: 'Test'},
bank_name: 'hdfc',
account_number: 'Test',
firc_required: true,
purpose_code: 'Test'
}
},
address: {
line1: 'Test',
line2: 'Test',
city: 'Test',
state: 'Test',
country: 'IN',
postal_code: '110017'
},
phone: {number: '', calling_code: '91'},
nationality: 'IN'
})
};
fetch('https://service-sandbox.tazapay.com/v3/beneficiary', 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://service-sandbox.tazapay.com/v3/beneficiary",
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([
'account_id' => 'acc_cr83unf7j0t2odh9ioc0',
'name' => 'test',
'type' => 'individual',
'email' => 'test@example.com',
'tax_id' => '',
'destination_details' => [
'type' => 'bank',
'bank' => [
'country' => 'IN',
'currency' => 'INR',
'bank_codes' => [
'swift_code' => 'Test',
'ifsc_code' => 'Test'
],
'bank_name' => 'hdfc',
'account_number' => 'Test',
'firc_required' => true,
'purpose_code' => 'Test'
]
],
'address' => [
'line1' => 'Test',
'line2' => 'Test',
'city' => 'Test',
'state' => 'Test',
'country' => 'IN',
'postal_code' => '110017'
],
'phone' => [
'number' => '',
'calling_code' => '91'
],
'nationality' => 'IN'
]),
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://service-sandbox.tazapay.com/v3/beneficiary"
payload := strings.NewReader("{\n \"account_id\": \"acc_cr83unf7j0t2odh9ioc0\",\n \"name\": \"test\",\n \"type\": \"individual\",\n \"email\": \"test@example.com\",\n \"tax_id\": \"\",\n \"destination_details\": {\n \"type\": \"bank\",\n \"bank\": {\n \"country\": \"IN\",\n \"currency\": \"INR\",\n \"bank_codes\": {\n \"swift_code\": \"Test\",\n \"ifsc_code\": \"Test\"\n },\n \"bank_name\": \"hdfc\",\n \"account_number\": \"Test\",\n \"firc_required\": true,\n \"purpose_code\": \"Test\"\n }\n },\n \"address\": {\n \"line1\": \"Test\",\n \"line2\": \"Test\",\n \"city\": \"Test\",\n \"state\": \"Test\",\n \"country\": \"IN\",\n \"postal_code\": \"110017\"\n },\n \"phone\": {\n \"number\": \"\",\n \"calling_code\": \"91\"\n },\n \"nationality\": \"IN\"\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://service-sandbox.tazapay.com/v3/beneficiary")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"acc_cr83unf7j0t2odh9ioc0\",\n \"name\": \"test\",\n \"type\": \"individual\",\n \"email\": \"test@example.com\",\n \"tax_id\": \"\",\n \"destination_details\": {\n \"type\": \"bank\",\n \"bank\": {\n \"country\": \"IN\",\n \"currency\": \"INR\",\n \"bank_codes\": {\n \"swift_code\": \"Test\",\n \"ifsc_code\": \"Test\"\n },\n \"bank_name\": \"hdfc\",\n \"account_number\": \"Test\",\n \"firc_required\": true,\n \"purpose_code\": \"Test\"\n }\n },\n \"address\": {\n \"line1\": \"Test\",\n \"line2\": \"Test\",\n \"city\": \"Test\",\n \"state\": \"Test\",\n \"country\": \"IN\",\n \"postal_code\": \"110017\"\n },\n \"phone\": {\n \"number\": \"\",\n \"calling_code\": \"91\"\n },\n \"nationality\": \"IN\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://service-sandbox.tazapay.com/v3/beneficiary")
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 \"account_id\": \"acc_cr83unf7j0t2odh9ioc0\",\n \"name\": \"test\",\n \"type\": \"individual\",\n \"email\": \"test@example.com\",\n \"tax_id\": \"\",\n \"destination_details\": {\n \"type\": \"bank\",\n \"bank\": {\n \"country\": \"IN\",\n \"currency\": \"INR\",\n \"bank_codes\": {\n \"swift_code\": \"Test\",\n \"ifsc_code\": \"Test\"\n },\n \"bank_name\": \"hdfc\",\n \"account_number\": \"Test\",\n \"firc_required\": true,\n \"purpose_code\": \"Test\"\n }\n },\n \"address\": {\n \"line1\": \"Test\",\n \"line2\": \"Test\",\n \"city\": \"Test\",\n \"state\": \"Test\",\n \"country\": \"IN\",\n \"postal_code\": \"110017\"\n },\n \"phone\": {\n \"number\": \"\",\n \"calling_code\": \"91\"\n },\n \"nationality\": \"IN\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "",
"data": {
"address": {
"city": "Test",
"country": "IN",
"line1": "Test",
"line2": "Test",
"postal_code": "110017",
"state": "Test"
},
"created_at": "2024-10-03T11:03:40.326462Z",
"destination": "bnk_crv7k337eoqgk10pqp40",
"destination_details": {
"bank": {
"account_number": "Test",
"account_type": "",
"bank_codes": {
"ifsc_code": "Test",
"swift_code": "Test"
},
"bank_name": "hdfc",
"branch_name": "",
"country": "IN",
"currency": "INR",
"firc_required": true,
"purpose_code": "Test"
},
"type": "bank"
},
"documents": [],
"email": "test@example.com",
"id": "bnf_crv7k31h1l071n2fkbjg",
"metadata": null,
"name": "test",
"object": "beneficiary",
"phone": {
"calling_code": "91",
"number": "9362987920"
},
"tax_id": "",
"type": "individual"
}
}"{}"Beneficiary
Create Beneficiary
This lets you create a beneficiary
POST
/
v3
/
beneficiary
Create Beneficiary
curl --request POST \
--url https://service-sandbox.tazapay.com/v3/beneficiary \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"account_id": "acc_cr83unf7j0t2odh9ioc0",
"name": "test",
"type": "individual",
"email": "test@example.com",
"tax_id": "",
"destination_details": {
"type": "bank",
"bank": {
"country": "IN",
"currency": "INR",
"bank_codes": {
"swift_code": "Test",
"ifsc_code": "Test"
},
"bank_name": "hdfc",
"account_number": "Test",
"firc_required": true,
"purpose_code": "Test"
}
},
"address": {
"line1": "Test",
"line2": "Test",
"city": "Test",
"state": "Test",
"country": "IN",
"postal_code": "110017"
},
"phone": {
"number": "",
"calling_code": "91"
},
"nationality": "IN"
}
'import requests
url = "https://service-sandbox.tazapay.com/v3/beneficiary"
payload = {
"account_id": "acc_cr83unf7j0t2odh9ioc0",
"name": "test",
"type": "individual",
"email": "test@example.com",
"tax_id": "",
"destination_details": {
"type": "bank",
"bank": {
"country": "IN",
"currency": "INR",
"bank_codes": {
"swift_code": "Test",
"ifsc_code": "Test"
},
"bank_name": "hdfc",
"account_number": "Test",
"firc_required": True,
"purpose_code": "Test"
}
},
"address": {
"line1": "Test",
"line2": "Test",
"city": "Test",
"state": "Test",
"country": "IN",
"postal_code": "110017"
},
"phone": {
"number": "",
"calling_code": "91"
},
"nationality": "IN"
}
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({
account_id: 'acc_cr83unf7j0t2odh9ioc0',
name: 'test',
type: 'individual',
email: 'test@example.com',
tax_id: '',
destination_details: {
type: 'bank',
bank: {
country: 'IN',
currency: 'INR',
bank_codes: {swift_code: 'Test', ifsc_code: 'Test'},
bank_name: 'hdfc',
account_number: 'Test',
firc_required: true,
purpose_code: 'Test'
}
},
address: {
line1: 'Test',
line2: 'Test',
city: 'Test',
state: 'Test',
country: 'IN',
postal_code: '110017'
},
phone: {number: '', calling_code: '91'},
nationality: 'IN'
})
};
fetch('https://service-sandbox.tazapay.com/v3/beneficiary', 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://service-sandbox.tazapay.com/v3/beneficiary",
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([
'account_id' => 'acc_cr83unf7j0t2odh9ioc0',
'name' => 'test',
'type' => 'individual',
'email' => 'test@example.com',
'tax_id' => '',
'destination_details' => [
'type' => 'bank',
'bank' => [
'country' => 'IN',
'currency' => 'INR',
'bank_codes' => [
'swift_code' => 'Test',
'ifsc_code' => 'Test'
],
'bank_name' => 'hdfc',
'account_number' => 'Test',
'firc_required' => true,
'purpose_code' => 'Test'
]
],
'address' => [
'line1' => 'Test',
'line2' => 'Test',
'city' => 'Test',
'state' => 'Test',
'country' => 'IN',
'postal_code' => '110017'
],
'phone' => [
'number' => '',
'calling_code' => '91'
],
'nationality' => 'IN'
]),
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://service-sandbox.tazapay.com/v3/beneficiary"
payload := strings.NewReader("{\n \"account_id\": \"acc_cr83unf7j0t2odh9ioc0\",\n \"name\": \"test\",\n \"type\": \"individual\",\n \"email\": \"test@example.com\",\n \"tax_id\": \"\",\n \"destination_details\": {\n \"type\": \"bank\",\n \"bank\": {\n \"country\": \"IN\",\n \"currency\": \"INR\",\n \"bank_codes\": {\n \"swift_code\": \"Test\",\n \"ifsc_code\": \"Test\"\n },\n \"bank_name\": \"hdfc\",\n \"account_number\": \"Test\",\n \"firc_required\": true,\n \"purpose_code\": \"Test\"\n }\n },\n \"address\": {\n \"line1\": \"Test\",\n \"line2\": \"Test\",\n \"city\": \"Test\",\n \"state\": \"Test\",\n \"country\": \"IN\",\n \"postal_code\": \"110017\"\n },\n \"phone\": {\n \"number\": \"\",\n \"calling_code\": \"91\"\n },\n \"nationality\": \"IN\"\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://service-sandbox.tazapay.com/v3/beneficiary")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"account_id\": \"acc_cr83unf7j0t2odh9ioc0\",\n \"name\": \"test\",\n \"type\": \"individual\",\n \"email\": \"test@example.com\",\n \"tax_id\": \"\",\n \"destination_details\": {\n \"type\": \"bank\",\n \"bank\": {\n \"country\": \"IN\",\n \"currency\": \"INR\",\n \"bank_codes\": {\n \"swift_code\": \"Test\",\n \"ifsc_code\": \"Test\"\n },\n \"bank_name\": \"hdfc\",\n \"account_number\": \"Test\",\n \"firc_required\": true,\n \"purpose_code\": \"Test\"\n }\n },\n \"address\": {\n \"line1\": \"Test\",\n \"line2\": \"Test\",\n \"city\": \"Test\",\n \"state\": \"Test\",\n \"country\": \"IN\",\n \"postal_code\": \"110017\"\n },\n \"phone\": {\n \"number\": \"\",\n \"calling_code\": \"91\"\n },\n \"nationality\": \"IN\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://service-sandbox.tazapay.com/v3/beneficiary")
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 \"account_id\": \"acc_cr83unf7j0t2odh9ioc0\",\n \"name\": \"test\",\n \"type\": \"individual\",\n \"email\": \"test@example.com\",\n \"tax_id\": \"\",\n \"destination_details\": {\n \"type\": \"bank\",\n \"bank\": {\n \"country\": \"IN\",\n \"currency\": \"INR\",\n \"bank_codes\": {\n \"swift_code\": \"Test\",\n \"ifsc_code\": \"Test\"\n },\n \"bank_name\": \"hdfc\",\n \"account_number\": \"Test\",\n \"firc_required\": true,\n \"purpose_code\": \"Test\"\n }\n },\n \"address\": {\n \"line1\": \"Test\",\n \"line2\": \"Test\",\n \"city\": \"Test\",\n \"state\": \"Test\",\n \"country\": \"IN\",\n \"postal_code\": \"110017\"\n },\n \"phone\": {\n \"number\": \"\",\n \"calling_code\": \"91\"\n },\n \"nationality\": \"IN\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "",
"data": {
"address": {
"city": "Test",
"country": "IN",
"line1": "Test",
"line2": "Test",
"postal_code": "110017",
"state": "Test"
},
"created_at": "2024-10-03T11:03:40.326462Z",
"destination": "bnk_crv7k337eoqgk10pqp40",
"destination_details": {
"bank": {
"account_number": "Test",
"account_type": "",
"bank_codes": {
"ifsc_code": "Test",
"swift_code": "Test"
},
"bank_name": "hdfc",
"branch_name": "",
"country": "IN",
"currency": "INR",
"firc_required": true,
"purpose_code": "Test"
},
"type": "bank"
},
"documents": [],
"email": "test@example.com",
"id": "bnf_crv7k31h1l071n2fkbjg",
"metadata": null,
"name": "test",
"object": "beneficiary",
"phone": {
"calling_code": "91",
"number": "9362987920"
},
"tax_id": "",
"type": "individual"
}
}"{}"Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Beneficiary Name
Maximum string length:
140business or individual
Available options:
business, individual Email Address
Address details
Show child attributes
Show child attributes
Phone contact details
Show child attributes
Show child attributes
Destination details for beneficiary payouts (discriminated union based on type)
Show child attributes
Show child attributes
ID of the destination attached to the beneficiary
Set of key-value pairs to attach to the beneficiary
Tax ID of the beneficiary. (CPF or CPNJ is mandatory for payouts to Brazil)
Documents to attach to the beneficiary
Show child attributes
Show child attributes
National ID of the individual
Registration number of the business (Mandatory if destination_details.type is a wallet and type is business)
Date of birth of individual, Format DD-MM-YYYY (Mandatory if destination_details.type is a wallet and type is individual)
ISO 3166-1 alpha-2 country code representing the beneficiary's nationality (e.g., US, GB, IN, FR). Optional field used for enhanced compliance screening. Sending this field will reduce compliance hold.
Type of relationship between beneficiary and creator of beneficiary Possible values - self, third_party (Mandatory if destination_details.type is a wallet)
Available options:
self, third_party Name in local language
Response
200
Represents a payout beneficiary with personal, contact, and destination details.
Address details
Show child attributes
Show child attributes
Date of birth of the beneficiary in YYYY-MM-DD format.
ISO 3166-1 alpha-2 country code representing the beneficiary's nationality. Optional field used for enhanced compliance screening. Sending this field will reduce compliance hold.
Identifier or reference to the beneficiary's payment destination (bank account, wallet, etc.).
Destination details for beneficiary payouts (discriminated union based on type)
Show child attributes
Show child attributes
List of documents associated with the beneficiary (e.g., ID proof, address proof).
Email address of the beneficiary.
Full name of the beneficiary.
Local language representation of the beneficiary's name, if applicable.
National identification number or equivalent ID.
Classification of the beneficiary.Possible Values - 'self', 'third_party'.
Phone contact details
Show child attributes
Show child attributes
Registration or incorporation number for business beneficiaries.
Tax identification number for the beneficiary.
Specifies whether the beneficiary is an 'individual' or a 'business'.
Was this page helpful?