Skip to main content
POST
/
v1
/
wallets
/
{walletId}
/
beneficiaries
Create
curl --request POST \
  --url https://api.blockradar.co/v1/wallets/{walletId}/beneficiaries \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
"{\n    \"name\": \"Ledger Wallet\",\n    \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n    \"settlementFrequency\": \"DAILY\", // Optional: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY\n    \"isWhitelisted\": true  // Optional\n}"
'
import requests

url = "https://api.blockradar.co/v1/wallets/{walletId}/beneficiaries"

payload = "{
\"name\": \"Ledger Wallet\",
\"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",
\"settlementFrequency\": \"DAILY\", // Optional: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY
\"isWhitelisted\": true // Optional
}"
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify('{\n "name": "Ledger Wallet",\n "address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",\n "settlementFrequency": "DAILY", // Optional: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY\n "isWhitelisted": true // Optional\n}')
};

fetch('https://api.blockradar.co/v1/wallets/{walletId}/beneficiaries', 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.blockradar.co/v1/wallets/{walletId}/beneficiaries",
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": "Ledger Wallet",
"address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
"settlementFrequency": "DAILY", // Optional: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY
"isWhitelisted": true // Optional
}'),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$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.blockradar.co/v1/wallets/{walletId}/beneficiaries"

payload := strings.NewReader("\"{\\n \\\"name\\\": \\\"Ledger Wallet\\\",\\n \\\"address\\\": \\\"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\\\",\\n \\\"settlementFrequency\\\": \\\"DAILY\\\", // Optional: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY\\n \\\"isWhitelisted\\\": true // Optional\\n}\"")

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

req.Header.Add("x-api-key", "<api-key>")
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.blockradar.co/v1/wallets/{walletId}/beneficiaries")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("\"{\\n \\\"name\\\": \\\"Ledger Wallet\\\",\\n \\\"address\\\": \\\"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\\\",\\n \\\"settlementFrequency\\\": \\\"DAILY\\\", // Optional: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY\\n \\\"isWhitelisted\\\": true // Optional\\n}\"")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.blockradar.co/v1/wallets/{walletId}/beneficiaries")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "\"{\\n \\\"name\\\": \\\"Ledger Wallet\\\",\\n \\\"address\\\": \\\"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\\\",\\n \\\"settlementFrequency\\\": \\\"DAILY\\\", // Optional: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY\\n \\\"isWhitelisted\\\": true // Optional\\n}\""

response = http.request(request)
puts response.read_body
{
  "data": {
    "address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
    "createdAt": "2025-08-27T22:27:17.071Z",
    "deletedAt": null,
    "id": "cc7a86eb-28f8-49e0-aa77-eb01bb38ad2b",
    "isActive": true,
    "isDefault": false,
    "isSettlement": true,
    "isWhitelisted": true,
    "name": "Ledger Wallet",
    "settlementFrequency": "DAILY",
    "updatedAt": "2025-08-27T22:27:17.071Z"
  },
  "message": "Beneficiary created successfully",
  "statusCode": 200
}

Authorizations

x-api-key
string
header
required

Path Parameters

walletId
string
required
Example:

"YOUR_WALLET_ID"

Response

201 - application/json

200

data
object
message
string
Example:

"Beneficiary created successfully"

statusCode
number
Example:

200