curl --request POST \
--url https://api.portalhq.io/api/v3/clients/me/integrations/due/recipients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"details": {
"address": "<string>",
"schema": "<string>"
},
"chainId": "<string>",
"isExternal": true
}
'import requests
url = "https://api.portalhq.io/api/v3/clients/me/integrations/due/recipients"
payload = {
"name": "<string>",
"details": {
"address": "<string>",
"schema": "<string>"
},
"chainId": "<string>",
"isExternal": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
details: {address: '<string>', schema: '<string>'},
chainId: '<string>',
isExternal: true
})
};
fetch('https://api.portalhq.io/api/v3/clients/me/integrations/due/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.portalhq.io/api/v3/clients/me/integrations/due/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([
'name' => '<string>',
'details' => [
'address' => '<string>',
'schema' => '<string>'
],
'chainId' => '<string>',
'isExternal' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.portalhq.io/api/v3/clients/me/integrations/due/recipients"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"details\": {\n \"address\": \"<string>\",\n \"schema\": \"<string>\"\n },\n \"chainId\": \"<string>\",\n \"isExternal\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.portalhq.io/api/v3/clients/me/integrations/due/recipients")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"details\": {\n \"address\": \"<string>\",\n \"schema\": \"<string>\"\n },\n \"chainId\": \"<string>\",\n \"isExternal\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portalhq.io/api/v3/clients/me/integrations/due/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"details\": {\n \"address\": \"<string>\",\n \"schema\": \"<string>\"\n },\n \"chainId\": \"<string>\",\n \"isExternal\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"label": "<string>",
"details": {},
"isExternal": true,
"isActive": true,
"isValid": true
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Create recipient
Creates a recipient. For onchain recipients, pass a CAIP-2 chainId and
omit the address to default it to the client’s Portal wallet. For a fiat
beneficiary, set isExternal: true and provide the bank details.
curl --request POST \
--url https://api.portalhq.io/api/v3/clients/me/integrations/due/recipients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"details": {
"address": "<string>",
"schema": "<string>"
},
"chainId": "<string>",
"isExternal": true
}
'import requests
url = "https://api.portalhq.io/api/v3/clients/me/integrations/due/recipients"
payload = {
"name": "<string>",
"details": {
"address": "<string>",
"schema": "<string>"
},
"chainId": "<string>",
"isExternal": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
details: {address: '<string>', schema: '<string>'},
chainId: '<string>',
isExternal: true
})
};
fetch('https://api.portalhq.io/api/v3/clients/me/integrations/due/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.portalhq.io/api/v3/clients/me/integrations/due/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([
'name' => '<string>',
'details' => [
'address' => '<string>',
'schema' => '<string>'
],
'chainId' => '<string>',
'isExternal' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.portalhq.io/api/v3/clients/me/integrations/due/recipients"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"details\": {\n \"address\": \"<string>\",\n \"schema\": \"<string>\"\n },\n \"chainId\": \"<string>\",\n \"isExternal\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.portalhq.io/api/v3/clients/me/integrations/due/recipients")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"details\": {\n \"address\": \"<string>\",\n \"schema\": \"<string>\"\n },\n \"chainId\": \"<string>\",\n \"isExternal\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.portalhq.io/api/v3/clients/me/integrations/due/recipients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"details\": {\n \"address\": \"<string>\",\n \"schema\": \"<string>\"\n },\n \"chainId\": \"<string>\",\n \"isExternal\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"label": "<string>",
"details": {},
"isExternal": true,
"isActive": true,
"isValid": true
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.
Headers
Optional key to deduplicate retries.
Body
Recipient details. For onchain recipients, schema and address are
defaulted from chainId when omitted; provide them explicitly for an
external wallet. For fiat beneficiaries, include the bank schema and
account fields.
Show child attributes
Show child attributes
CAIP-2 chain id used to default an onchain recipient's schema and address.
Set true for external wallets and fiat beneficiaries; disables Portal-wallet defaulting.
Response
Recipient created
Show child attributes
Show child attributes
Was this page helpful?