Crypto Customer beneficiary
curl --request POST \
--url https://business-api.onboard.xyz/ledger/crypto-beneficiaries \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"address": "<string>",
"network": "<string>",
"name": "<string>",
"memo": "<string>"
}
'import requests
url = "https://business-api.onboard.xyz/ledger/crypto-beneficiaries"
payload = {
"address": "<string>",
"network": "<string>",
"name": "<string>",
"memo": "<string>"
}
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({address: '<string>', network: '<string>', name: '<string>', memo: '<string>'})
};
fetch('https://business-api.onboard.xyz/ledger/crypto-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://business-api.onboard.xyz/ledger/crypto-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([
'address' => '<string>',
'network' => '<string>',
'name' => '<string>',
'memo' => '<string>'
]),
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://business-api.onboard.xyz/ledger/crypto-beneficiaries"
payload := strings.NewReader("{\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"name\": \"<string>\",\n \"memo\": \"<string>\"\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://business-api.onboard.xyz/ledger/crypto-beneficiaries")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"name\": \"<string>\",\n \"memo\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://business-api.onboard.xyz/ledger/crypto-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 \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"name\": \"<string>\",\n \"memo\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {},
"error": {
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}
}{
"code": "BAD_REQUEST",
"message": "Request could not be validated."
}{
"code": "UNAUTHORIZED",
"message": "Either client security header is missing or it is not valid."
}{
"code": "ACCESS_DENIED",
"message": "Expected permission or scope is not present."
}{
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred."
}Crypto Beneficiaries
Create Crypto Beneficiary
This Operation allows crypto users to save beneficiary
POST
/
ledger
/
crypto-beneficiaries
Crypto Customer beneficiary
curl --request POST \
--url https://business-api.onboard.xyz/ledger/crypto-beneficiaries \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"address": "<string>",
"network": "<string>",
"name": "<string>",
"memo": "<string>"
}
'import requests
url = "https://business-api.onboard.xyz/ledger/crypto-beneficiaries"
payload = {
"address": "<string>",
"network": "<string>",
"name": "<string>",
"memo": "<string>"
}
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({address: '<string>', network: '<string>', name: '<string>', memo: '<string>'})
};
fetch('https://business-api.onboard.xyz/ledger/crypto-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://business-api.onboard.xyz/ledger/crypto-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([
'address' => '<string>',
'network' => '<string>',
'name' => '<string>',
'memo' => '<string>'
]),
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://business-api.onboard.xyz/ledger/crypto-beneficiaries"
payload := strings.NewReader("{\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"name\": \"<string>\",\n \"memo\": \"<string>\"\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://business-api.onboard.xyz/ledger/crypto-beneficiaries")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"name\": \"<string>\",\n \"memo\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://business-api.onboard.xyz/ledger/crypto-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 \"address\": \"<string>\",\n \"network\": \"<string>\",\n \"name\": \"<string>\",\n \"memo\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {},
"error": {
"code": "UNKNOWN_ERROR",
"message": "Request could not be completed due to an error",
"data": {}
}
}{
"code": "BAD_REQUEST",
"message": "Request could not be validated."
}{
"code": "UNAUTHORIZED",
"message": "Either client security header is missing or it is not valid."
}{
"code": "ACCESS_DENIED",
"message": "Expected permission or scope is not present."
}{
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred."
}Adds a new crypto beneficiary (wallet address + network).
Authorizations
Requires authentication via API key and HMAC signature.
x-api-key: Your API key generated from your Onboard Business dashboard.x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 secondsx-signature: SHA256 HMAC HEX signature calculated overt={x-timestamp}&{requestBody}using your API Secret.
Body
application/json
Response
Beneficiary details saved successfully
Status data, check additional message field.
Status can be successful or failed, a value of true indicates success.
Example:
true
additional message describing status.
Data associated with the status, this will not always be present
Default error object for services. This gives consistent error object that all services may use.
Show child attributes
Show child attributes
⌘I