Recipients
Create recipient
Register a recipient.
POST
/
api
/
recipients
Create recipient
curl --request POST \
--url https://api.example.com/api/recipients \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"country": "<string>",
"isBusiness": "<string>",
"businessName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"address": {
"streetLine1": "<string>",
"streetLine2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"externalReference": {}
}
'import requests
url = "https://api.example.com/api/recipients"
payload = {
"email": "<string>",
"country": "<string>",
"isBusiness": "<string>",
"businessName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"address": {
"streetLine1": "<string>",
"streetLine2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"externalReference": {}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
country: '<string>',
isBusiness: '<string>',
businessName: '<string>',
firstName: '<string>',
lastName: '<string>',
phone: '<string>',
address: {
streetLine1: '<string>',
streetLine2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
},
externalReference: {}
})
};
fetch('https://api.example.com/api/recipients', 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.example.com/api/recipients",
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([
'email' => '<string>',
'country' => '<string>',
'isBusiness' => '<string>',
'businessName' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>',
'address' => [
'streetLine1' => '<string>',
'streetLine2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'externalReference' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.example.com/api/recipients"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"country\": \"<string>\",\n \"isBusiness\": \"<string>\",\n \"businessName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"externalReference\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.example.com/api/recipients")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"country\": \"<string>\",\n \"isBusiness\": \"<string>\",\n \"businessName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"externalReference\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"country\": \"<string>\",\n \"isBusiness\": \"<string>\",\n \"businessName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"externalReference\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "8b1a4c1d-7a3c-4a08-94ad-9f1ef1e0c3a2",
"email": "payments@acme-ph.com",
"isBusiness": true,
"businessName": "Acme Corp Philippines",
"country": "PH",
"currency": "PHP",
"transferType": "fiat",
"externalReference": { "vendor_id": "ACME-001" },
"status": "pending",
"createdAt": "2026-06-09T10:00:00Z",
"updatedAt": "2026-06-09T10:00:00Z"
}
{
"id": "8b1a4c1d-7a3c-4a08-94ad-9f1ef1e0c3a2",
"email": "treasury@acme-singapore.com",
"isBusiness": true,
"businessName": "Acme Singapore",
"country": "SG",
"transferType": "stablecoin",
"walletAddresses": {
"137": "0xAbcDef0123456789AbcDef0123456789AbcDef01",
"42161": "0xAbcDef0123456789AbcDef0123456789AbcDef01"
},
"status": "accepted",
"createdAt": "2026-06-09T10:00:00Z",
"updatedAt": "2026-06-09T10:00:00Z"
}
Body is a common section + a type-specific section keyed on
transferType. Call GET /recipients/requirements first for the live field list.
Scope
recipients:write · rate-limitedHeaders
string
required
API key.
string
Optional. Up to 255 url-safe characters (≥8). Replays the cached response within 24 hours; mismatched bodies on the same key return
409 IDEMPOTENCY_KEY_REUSED.Request body
Common
string
required
string
required
ISO 3166-1 alpha-2.
string
"business" (default) or "individual".string
Required when
isBusiness="business".string
Required when
isBusiness="individual".string
Required when
isBusiness="individual".string
E.164.
object
Map of
string → string. Echoed back on reads.Type-specific
- Fiat (bank)
- Stablecoin (wallet)
string
required
"fiat"object[]
required
One entry per (currency, rail). Send only fields the chosen
rail needs.Response
string
UUID.
string
boolean
string
string
string
string
ISO 3166-1 alpha-2.
string
Inferred from
country when omitted.string
string
"fiat" or "stablecoin".object
Chain ID → address, when
transferType is "stablecoin".object
Map of
string → string.string
"pending", "accepted", or "rejected".string
ISO 8601.
string
ISO 8601.
{
"id": "8b1a4c1d-7a3c-4a08-94ad-9f1ef1e0c3a2",
"email": "payments@acme-ph.com",
"isBusiness": true,
"businessName": "Acme Corp Philippines",
"country": "PH",
"currency": "PHP",
"transferType": "fiat",
"externalReference": { "vendor_id": "ACME-001" },
"status": "pending",
"createdAt": "2026-06-09T10:00:00Z",
"updatedAt": "2026-06-09T10:00:00Z"
}
{
"id": "8b1a4c1d-7a3c-4a08-94ad-9f1ef1e0c3a2",
"email": "treasury@acme-singapore.com",
"isBusiness": true,
"businessName": "Acme Singapore",
"country": "SG",
"transferType": "stablecoin",
"walletAddresses": {
"137": "0xAbcDef0123456789AbcDef0123456789AbcDef01",
"42161": "0xAbcDef0123456789AbcDef0123456789AbcDef01"
},
"status": "accepted",
"createdAt": "2026-06-09T10:00:00Z",
"updatedAt": "2026-06-09T10:00:00Z"
}
⌘I
Create recipient
curl --request POST \
--url https://api.example.com/api/recipients \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"country": "<string>",
"isBusiness": "<string>",
"businessName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"address": {
"streetLine1": "<string>",
"streetLine2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"externalReference": {}
}
'import requests
url = "https://api.example.com/api/recipients"
payload = {
"email": "<string>",
"country": "<string>",
"isBusiness": "<string>",
"businessName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phone": "<string>",
"address": {
"streetLine1": "<string>",
"streetLine2": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"externalReference": {}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
country: '<string>',
isBusiness: '<string>',
businessName: '<string>',
firstName: '<string>',
lastName: '<string>',
phone: '<string>',
address: {
streetLine1: '<string>',
streetLine2: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
},
externalReference: {}
})
};
fetch('https://api.example.com/api/recipients', 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.example.com/api/recipients",
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([
'email' => '<string>',
'country' => '<string>',
'isBusiness' => '<string>',
'businessName' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'phone' => '<string>',
'address' => [
'streetLine1' => '<string>',
'streetLine2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'externalReference' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"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.example.com/api/recipients"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"country\": \"<string>\",\n \"isBusiness\": \"<string>\",\n \"businessName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"externalReference\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
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.example.com/api/recipients")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"country\": \"<string>\",\n \"isBusiness\": \"<string>\",\n \"businessName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"externalReference\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"country\": \"<string>\",\n \"isBusiness\": \"<string>\",\n \"businessName\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": {\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"externalReference\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "8b1a4c1d-7a3c-4a08-94ad-9f1ef1e0c3a2",
"email": "payments@acme-ph.com",
"isBusiness": true,
"businessName": "Acme Corp Philippines",
"country": "PH",
"currency": "PHP",
"transferType": "fiat",
"externalReference": { "vendor_id": "ACME-001" },
"status": "pending",
"createdAt": "2026-06-09T10:00:00Z",
"updatedAt": "2026-06-09T10:00:00Z"
}
{
"id": "8b1a4c1d-7a3c-4a08-94ad-9f1ef1e0c3a2",
"email": "treasury@acme-singapore.com",
"isBusiness": true,
"businessName": "Acme Singapore",
"country": "SG",
"transferType": "stablecoin",
"walletAddresses": {
"137": "0xAbcDef0123456789AbcDef0123456789AbcDef01",
"42161": "0xAbcDef0123456789AbcDef0123456789AbcDef01"
},
"status": "accepted",
"createdAt": "2026-06-09T10:00:00Z",
"updatedAt": "2026-06-09T10:00:00Z"
}