Skip to main content
POST
/
resellers
/
custodians
Create a sub-custodian
curl --request POST \
  --url https://api.portalhq.io/api/v3/resellers/custodians \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custodian": {
    "name": "Acme Payments"
  },
  "user": {
    "email": "admin@acmepayments.com",
    "firstName": "Avery",
    "lastName": "Stone"
  }
}
'
import requests

url = "https://api.portalhq.io/api/v3/resellers/custodians"

payload = {
"custodian": { "name": "Acme Payments" },
"user": {
"email": "admin@acmepayments.com",
"firstName": "Avery",
"lastName": "Stone"
}
}
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({
custodian: {name: 'Acme Payments'},
user: {email: 'admin@acmepayments.com', firstName: 'Avery', lastName: 'Stone'}
})
};

fetch('https://api.portalhq.io/api/v3/resellers/custodians', 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/resellers/custodians",
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([
'custodian' => [
'name' => 'Acme Payments'
],
'user' => [
'email' => 'admin@acmepayments.com',
'firstName' => 'Avery',
'lastName' => 'Stone'
]
]),
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/resellers/custodians"

payload := strings.NewReader("{\n \"custodian\": {\n \"name\": \"Acme Payments\"\n },\n \"user\": {\n \"email\": \"admin@acmepayments.com\",\n \"firstName\": \"Avery\",\n \"lastName\": \"Stone\"\n }\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/resellers/custodians")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"custodian\": {\n \"name\": \"Acme Payments\"\n },\n \"user\": {\n \"email\": \"admin@acmepayments.com\",\n \"firstName\": \"Avery\",\n \"lastName\": \"Stone\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.portalhq.io/api/v3/resellers/custodians")

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 \"custodian\": {\n \"name\": \"Acme Payments\"\n },\n \"user\": {\n \"email\": \"admin@acmepayments.com\",\n \"firstName\": \"Avery\",\n \"lastName\": \"Stone\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "custodian": {
    "id": "custodian_123",
    "name": "Acme Payments",
    "slug": "acme-payments",
    "billingStatus": "ACTIVE",
    "isReseller": false,
    "resellerParentId": "reseller_custodian_123",
    "sessionTokensEnabled": true,
    "createdAt": "2026-07-08T18:00:00.000Z",
    "updatedAt": "2026-07-08T18:00:00.000Z",
    "billingPlan": {
      "name": "Start-Up"
    },
    "environments": [
      {
        "id": "env_dev_123",
        "name": "Development",
        "createdAt": "2026-07-08T18:00:00.000Z",
        "updatedAt": "2026-07-08T18:00:00.000Z"
      },
      {
        "id": "env_prod_123",
        "name": "Production",
        "createdAt": "2026-07-08T18:00:00.000Z",
        "updatedAt": "2026-07-08T18:00:00.000Z"
      }
    ],
    "users": [
      {
        "id": "user_123",
        "email": "admin@acmepayments.com",
        "firstName": "Avery",
        "lastName": "Stone",
        "createdAt": "2026-07-08T18:00:00.000Z",
        "updatedAt": "2026-07-08T18:00:00.000Z"
      }
    ]
  }
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}

Authorizations

Authorization
string
header
required

Reseller API key created in the Portal dashboard.

Body

application/json
custodian
object
required
user
object
required

Response

Sub-custodian created successfully

custodian
object
required