Create Sub-Merchant
curl --request POST \
--url https://mapi.zbx.com/v1/partners/orgs \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-Nonce: <api-key>' \
--header 'X-API-Signature: <api-key>' \
--data '
{
"external_reference": "<string>",
"name": "<string>",
"owner": {
"email": "<string>",
"name": "<string>",
"phone": "<string>"
},
"country_of_incorporation": "<string>",
"dba_name": "<string>",
"end_user_ip": "<string>",
"kyc_questionnaire": {
"acting_capacity": "156",
"annual_income": "75",
"employment_jurisdiction": "MT",
"employment_type_or_status": "16",
"expected_deposit_one_year": "83",
"hnwi_str": "79",
"industry": "51",
"investment_citizenship": "82",
"sdd_country_select": "MT",
"source_of_funds": "66,70",
"source_of_funds_of_country": "MT,DE",
"source_of_wealth_of_country": "MT"
},
"legal_name": "<string>",
"mid": "<string>",
"partner_id": "<string>",
"payment_fee_pct": 123,
"principal_place_of_business": "<string>",
"registration_number": "<string>",
"settlement_accounts": [
"<unknown>"
],
"share_token": "<string>",
"webhook_url": "<string>"
}
'import requests
url = "https://mapi.zbx.com/v1/partners/orgs"
payload = {
"external_reference": "<string>",
"name": "<string>",
"owner": {
"email": "<string>",
"name": "<string>",
"phone": "<string>"
},
"country_of_incorporation": "<string>",
"dba_name": "<string>",
"end_user_ip": "<string>",
"kyc_questionnaire": {
"acting_capacity": "156",
"annual_income": "75",
"employment_jurisdiction": "MT",
"employment_type_or_status": "16",
"expected_deposit_one_year": "83",
"hnwi_str": "79",
"industry": "51",
"investment_citizenship": "82",
"sdd_country_select": "MT",
"source_of_funds": "66,70",
"source_of_funds_of_country": "MT,DE",
"source_of_wealth_of_country": "MT"
},
"legal_name": "<string>",
"mid": "<string>",
"partner_id": "<string>",
"payment_fee_pct": 123,
"principal_place_of_business": "<string>",
"registration_number": "<string>",
"settlement_accounts": ["<unknown>"],
"share_token": "<string>",
"webhook_url": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"X-API-Nonce": "<api-key>",
"X-API-Signature": "<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>',
'X-API-Nonce': '<api-key>',
'X-API-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
external_reference: '<string>',
name: '<string>',
owner: {email: '<string>', name: '<string>', phone: '<string>'},
country_of_incorporation: '<string>',
dba_name: '<string>',
end_user_ip: '<string>',
kyc_questionnaire: {
acting_capacity: '156',
annual_income: '75',
employment_jurisdiction: 'MT',
employment_type_or_status: '16',
expected_deposit_one_year: '83',
hnwi_str: '79',
industry: '51',
investment_citizenship: '82',
sdd_country_select: 'MT',
source_of_funds: '66,70',
source_of_funds_of_country: 'MT,DE',
source_of_wealth_of_country: 'MT'
},
legal_name: '<string>',
mid: '<string>',
partner_id: '<string>',
payment_fee_pct: 123,
principal_place_of_business: '<string>',
registration_number: '<string>',
settlement_accounts: ['<unknown>'],
share_token: '<string>',
webhook_url: '<string>'
})
};
fetch('https://mapi.zbx.com/v1/partners/orgs', 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://mapi.zbx.com/v1/partners/orgs",
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([
'external_reference' => '<string>',
'name' => '<string>',
'owner' => [
'email' => '<string>',
'name' => '<string>',
'phone' => '<string>'
],
'country_of_incorporation' => '<string>',
'dba_name' => '<string>',
'end_user_ip' => '<string>',
'kyc_questionnaire' => [
'acting_capacity' => '156',
'annual_income' => '75',
'employment_jurisdiction' => 'MT',
'employment_type_or_status' => '16',
'expected_deposit_one_year' => '83',
'hnwi_str' => '79',
'industry' => '51',
'investment_citizenship' => '82',
'sdd_country_select' => 'MT',
'source_of_funds' => '66,70',
'source_of_funds_of_country' => 'MT,DE',
'source_of_wealth_of_country' => 'MT'
],
'legal_name' => '<string>',
'mid' => '<string>',
'partner_id' => '<string>',
'payment_fee_pct' => 123,
'principal_place_of_business' => '<string>',
'registration_number' => '<string>',
'settlement_accounts' => [
'<unknown>'
],
'share_token' => '<string>',
'webhook_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>",
"X-API-Nonce: <api-key>",
"X-API-Signature: <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://mapi.zbx.com/v1/partners/orgs"
payload := strings.NewReader("{\n \"external_reference\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"country_of_incorporation\": \"<string>\",\n \"dba_name\": \"<string>\",\n \"end_user_ip\": \"<string>\",\n \"kyc_questionnaire\": {\n \"acting_capacity\": \"156\",\n \"annual_income\": \"75\",\n \"employment_jurisdiction\": \"MT\",\n \"employment_type_or_status\": \"16\",\n \"expected_deposit_one_year\": \"83\",\n \"hnwi_str\": \"79\",\n \"industry\": \"51\",\n \"investment_citizenship\": \"82\",\n \"sdd_country_select\": \"MT\",\n \"source_of_funds\": \"66,70\",\n \"source_of_funds_of_country\": \"MT,DE\",\n \"source_of_wealth_of_country\": \"MT\"\n },\n \"legal_name\": \"<string>\",\n \"mid\": \"<string>\",\n \"partner_id\": \"<string>\",\n \"payment_fee_pct\": 123,\n \"principal_place_of_business\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"settlement_accounts\": [\n \"<unknown>\"\n ],\n \"share_token\": \"<string>\",\n \"webhook_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("X-API-Nonce", "<api-key>")
req.Header.Add("X-API-Signature", "<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://mapi.zbx.com/v1/partners/orgs")
.header("X-API-KEY", "<api-key>")
.header("X-API-Nonce", "<api-key>")
.header("X-API-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_reference\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"country_of_incorporation\": \"<string>\",\n \"dba_name\": \"<string>\",\n \"end_user_ip\": \"<string>\",\n \"kyc_questionnaire\": {\n \"acting_capacity\": \"156\",\n \"annual_income\": \"75\",\n \"employment_jurisdiction\": \"MT\",\n \"employment_type_or_status\": \"16\",\n \"expected_deposit_one_year\": \"83\",\n \"hnwi_str\": \"79\",\n \"industry\": \"51\",\n \"investment_citizenship\": \"82\",\n \"sdd_country_select\": \"MT\",\n \"source_of_funds\": \"66,70\",\n \"source_of_funds_of_country\": \"MT,DE\",\n \"source_of_wealth_of_country\": \"MT\"\n },\n \"legal_name\": \"<string>\",\n \"mid\": \"<string>\",\n \"partner_id\": \"<string>\",\n \"payment_fee_pct\": 123,\n \"principal_place_of_business\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"settlement_accounts\": [\n \"<unknown>\"\n ],\n \"share_token\": \"<string>\",\n \"webhook_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mapi.zbx.com/v1/partners/orgs")
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["X-API-Nonce"] = '<api-key>'
request["X-API-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_reference\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"country_of_incorporation\": \"<string>\",\n \"dba_name\": \"<string>\",\n \"end_user_ip\": \"<string>\",\n \"kyc_questionnaire\": {\n \"acting_capacity\": \"156\",\n \"annual_income\": \"75\",\n \"employment_jurisdiction\": \"MT\",\n \"employment_type_or_status\": \"16\",\n \"expected_deposit_one_year\": \"83\",\n \"hnwi_str\": \"79\",\n \"industry\": \"51\",\n \"investment_citizenship\": \"82\",\n \"sdd_country_select\": \"MT\",\n \"source_of_funds\": \"66,70\",\n \"source_of_funds_of_country\": \"MT,DE\",\n \"source_of_wealth_of_country\": \"MT\"\n },\n \"legal_name\": \"<string>\",\n \"mid\": \"<string>\",\n \"partner_id\": \"<string>\",\n \"payment_fee_pct\": 123,\n \"principal_place_of_business\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"settlement_accounts\": [\n \"<unknown>\"\n ],\n \"share_token\": \"<string>\",\n \"webhook_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": "<string>",
"kyc_next_action": "<string>",
"kyc_status": "<string>",
"name": "<string>",
"org_id": "<string>",
"owner": {
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"user_id": "<string>"
},
"partner_id": "<string>",
"settlement_accounts": [
{
"account_number": "<string>",
"address": "<string>",
"bank": {
"account_holder_name": "<string>",
"address": "<string>",
"bic": "<string>",
"country": "<string>",
"name": "<string>"
},
"chain_id": 123,
"currencies": [
"<string>"
],
"id": 123,
"name": "<string>",
"reference": "<string>"
}
]
},
"error": true,
"message": "<string>"
}{
"data": {
"created_at": "<string>",
"kyc_next_action": "<string>",
"kyc_status": "<string>",
"name": "<string>",
"org_id": "<string>",
"owner": {
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"user_id": "<string>"
},
"partner_id": "<string>",
"settlement_accounts": [
{
"account_number": "<string>",
"address": "<string>",
"bank": {
"account_holder_name": "<string>",
"address": "<string>",
"bic": "<string>",
"country": "<string>",
"name": "<string>"
},
"chain_id": 123,
"currencies": [
"<string>"
],
"id": 123,
"name": "<string>",
"reference": "<string>"
}
]
},
"error": true,
"message": "<string>"
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}Partners
Create Sub-Merchant
Onboard a merchant under your partner account. If KYC is required, the response includes kyc_next_action with a one-time verification URL; accounts are provisioned after KYC approval. To reuse an existing Sumsub KYC, send share_token with kyc_questionnaire; no verification URL is returned. Reusing the same external_reference returns the existing org and ignores share_token.
POST
/
partners
/
orgs
Create Sub-Merchant
curl --request POST \
--url https://mapi.zbx.com/v1/partners/orgs \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-Nonce: <api-key>' \
--header 'X-API-Signature: <api-key>' \
--data '
{
"external_reference": "<string>",
"name": "<string>",
"owner": {
"email": "<string>",
"name": "<string>",
"phone": "<string>"
},
"country_of_incorporation": "<string>",
"dba_name": "<string>",
"end_user_ip": "<string>",
"kyc_questionnaire": {
"acting_capacity": "156",
"annual_income": "75",
"employment_jurisdiction": "MT",
"employment_type_or_status": "16",
"expected_deposit_one_year": "83",
"hnwi_str": "79",
"industry": "51",
"investment_citizenship": "82",
"sdd_country_select": "MT",
"source_of_funds": "66,70",
"source_of_funds_of_country": "MT,DE",
"source_of_wealth_of_country": "MT"
},
"legal_name": "<string>",
"mid": "<string>",
"partner_id": "<string>",
"payment_fee_pct": 123,
"principal_place_of_business": "<string>",
"registration_number": "<string>",
"settlement_accounts": [
"<unknown>"
],
"share_token": "<string>",
"webhook_url": "<string>"
}
'import requests
url = "https://mapi.zbx.com/v1/partners/orgs"
payload = {
"external_reference": "<string>",
"name": "<string>",
"owner": {
"email": "<string>",
"name": "<string>",
"phone": "<string>"
},
"country_of_incorporation": "<string>",
"dba_name": "<string>",
"end_user_ip": "<string>",
"kyc_questionnaire": {
"acting_capacity": "156",
"annual_income": "75",
"employment_jurisdiction": "MT",
"employment_type_or_status": "16",
"expected_deposit_one_year": "83",
"hnwi_str": "79",
"industry": "51",
"investment_citizenship": "82",
"sdd_country_select": "MT",
"source_of_funds": "66,70",
"source_of_funds_of_country": "MT,DE",
"source_of_wealth_of_country": "MT"
},
"legal_name": "<string>",
"mid": "<string>",
"partner_id": "<string>",
"payment_fee_pct": 123,
"principal_place_of_business": "<string>",
"registration_number": "<string>",
"settlement_accounts": ["<unknown>"],
"share_token": "<string>",
"webhook_url": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"X-API-Nonce": "<api-key>",
"X-API-Signature": "<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>',
'X-API-Nonce': '<api-key>',
'X-API-Signature': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
external_reference: '<string>',
name: '<string>',
owner: {email: '<string>', name: '<string>', phone: '<string>'},
country_of_incorporation: '<string>',
dba_name: '<string>',
end_user_ip: '<string>',
kyc_questionnaire: {
acting_capacity: '156',
annual_income: '75',
employment_jurisdiction: 'MT',
employment_type_or_status: '16',
expected_deposit_one_year: '83',
hnwi_str: '79',
industry: '51',
investment_citizenship: '82',
sdd_country_select: 'MT',
source_of_funds: '66,70',
source_of_funds_of_country: 'MT,DE',
source_of_wealth_of_country: 'MT'
},
legal_name: '<string>',
mid: '<string>',
partner_id: '<string>',
payment_fee_pct: 123,
principal_place_of_business: '<string>',
registration_number: '<string>',
settlement_accounts: ['<unknown>'],
share_token: '<string>',
webhook_url: '<string>'
})
};
fetch('https://mapi.zbx.com/v1/partners/orgs', 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://mapi.zbx.com/v1/partners/orgs",
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([
'external_reference' => '<string>',
'name' => '<string>',
'owner' => [
'email' => '<string>',
'name' => '<string>',
'phone' => '<string>'
],
'country_of_incorporation' => '<string>',
'dba_name' => '<string>',
'end_user_ip' => '<string>',
'kyc_questionnaire' => [
'acting_capacity' => '156',
'annual_income' => '75',
'employment_jurisdiction' => 'MT',
'employment_type_or_status' => '16',
'expected_deposit_one_year' => '83',
'hnwi_str' => '79',
'industry' => '51',
'investment_citizenship' => '82',
'sdd_country_select' => 'MT',
'source_of_funds' => '66,70',
'source_of_funds_of_country' => 'MT,DE',
'source_of_wealth_of_country' => 'MT'
],
'legal_name' => '<string>',
'mid' => '<string>',
'partner_id' => '<string>',
'payment_fee_pct' => 123,
'principal_place_of_business' => '<string>',
'registration_number' => '<string>',
'settlement_accounts' => [
'<unknown>'
],
'share_token' => '<string>',
'webhook_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>",
"X-API-Nonce: <api-key>",
"X-API-Signature: <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://mapi.zbx.com/v1/partners/orgs"
payload := strings.NewReader("{\n \"external_reference\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"country_of_incorporation\": \"<string>\",\n \"dba_name\": \"<string>\",\n \"end_user_ip\": \"<string>\",\n \"kyc_questionnaire\": {\n \"acting_capacity\": \"156\",\n \"annual_income\": \"75\",\n \"employment_jurisdiction\": \"MT\",\n \"employment_type_or_status\": \"16\",\n \"expected_deposit_one_year\": \"83\",\n \"hnwi_str\": \"79\",\n \"industry\": \"51\",\n \"investment_citizenship\": \"82\",\n \"sdd_country_select\": \"MT\",\n \"source_of_funds\": \"66,70\",\n \"source_of_funds_of_country\": \"MT,DE\",\n \"source_of_wealth_of_country\": \"MT\"\n },\n \"legal_name\": \"<string>\",\n \"mid\": \"<string>\",\n \"partner_id\": \"<string>\",\n \"payment_fee_pct\": 123,\n \"principal_place_of_business\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"settlement_accounts\": [\n \"<unknown>\"\n ],\n \"share_token\": \"<string>\",\n \"webhook_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("X-API-Nonce", "<api-key>")
req.Header.Add("X-API-Signature", "<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://mapi.zbx.com/v1/partners/orgs")
.header("X-API-KEY", "<api-key>")
.header("X-API-Nonce", "<api-key>")
.header("X-API-Signature", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_reference\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"country_of_incorporation\": \"<string>\",\n \"dba_name\": \"<string>\",\n \"end_user_ip\": \"<string>\",\n \"kyc_questionnaire\": {\n \"acting_capacity\": \"156\",\n \"annual_income\": \"75\",\n \"employment_jurisdiction\": \"MT\",\n \"employment_type_or_status\": \"16\",\n \"expected_deposit_one_year\": \"83\",\n \"hnwi_str\": \"79\",\n \"industry\": \"51\",\n \"investment_citizenship\": \"82\",\n \"sdd_country_select\": \"MT\",\n \"source_of_funds\": \"66,70\",\n \"source_of_funds_of_country\": \"MT,DE\",\n \"source_of_wealth_of_country\": \"MT\"\n },\n \"legal_name\": \"<string>\",\n \"mid\": \"<string>\",\n \"partner_id\": \"<string>\",\n \"payment_fee_pct\": 123,\n \"principal_place_of_business\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"settlement_accounts\": [\n \"<unknown>\"\n ],\n \"share_token\": \"<string>\",\n \"webhook_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mapi.zbx.com/v1/partners/orgs")
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["X-API-Nonce"] = '<api-key>'
request["X-API-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_reference\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"country_of_incorporation\": \"<string>\",\n \"dba_name\": \"<string>\",\n \"end_user_ip\": \"<string>\",\n \"kyc_questionnaire\": {\n \"acting_capacity\": \"156\",\n \"annual_income\": \"75\",\n \"employment_jurisdiction\": \"MT\",\n \"employment_type_or_status\": \"16\",\n \"expected_deposit_one_year\": \"83\",\n \"hnwi_str\": \"79\",\n \"industry\": \"51\",\n \"investment_citizenship\": \"82\",\n \"sdd_country_select\": \"MT\",\n \"source_of_funds\": \"66,70\",\n \"source_of_funds_of_country\": \"MT,DE\",\n \"source_of_wealth_of_country\": \"MT\"\n },\n \"legal_name\": \"<string>\",\n \"mid\": \"<string>\",\n \"partner_id\": \"<string>\",\n \"payment_fee_pct\": 123,\n \"principal_place_of_business\": \"<string>\",\n \"registration_number\": \"<string>\",\n \"settlement_accounts\": [\n \"<unknown>\"\n ],\n \"share_token\": \"<string>\",\n \"webhook_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": "<string>",
"kyc_next_action": "<string>",
"kyc_status": "<string>",
"name": "<string>",
"org_id": "<string>",
"owner": {
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"user_id": "<string>"
},
"partner_id": "<string>",
"settlement_accounts": [
{
"account_number": "<string>",
"address": "<string>",
"bank": {
"account_holder_name": "<string>",
"address": "<string>",
"bic": "<string>",
"country": "<string>",
"name": "<string>"
},
"chain_id": 123,
"currencies": [
"<string>"
],
"id": 123,
"name": "<string>",
"reference": "<string>"
}
]
},
"error": true,
"message": "<string>"
}{
"data": {
"created_at": "<string>",
"kyc_next_action": "<string>",
"kyc_status": "<string>",
"name": "<string>",
"org_id": "<string>",
"owner": {
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"user_id": "<string>"
},
"partner_id": "<string>",
"settlement_accounts": [
{
"account_number": "<string>",
"address": "<string>",
"bank": {
"account_holder_name": "<string>",
"address": "<string>",
"bic": "<string>",
"country": "<string>",
"name": "<string>"
},
"chain_id": 123,
"currencies": [
"<string>"
],
"id": 123,
"name": "<string>",
"reference": "<string>"
}
]
},
"error": true,
"message": "<string>"
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}Authorizations
Body
application/json
Merchant to onboard
External reference for this resource.
Display name.
Owner for this resource. owner.phone must be a verified E.164 mobile.
Show child attributes
Show child attributes
Postal address. Country and city are required when present.
Show child attributes
Show child attributes
alpha-3
Dba name for this resource.
Merchant IP address at signup, used for risk assessment. Optional. If omitted, the connecting server address is used, which is usually a datacenter IP.
Answers to ZBX's CDD questionnaire. Required with share_token, and only accepted with it.
Show child attributes
Show child attributes
Legal name used to match inbound bank transfers to this merchant. Falls back to name when omitted.
Mcc for this resource. Optional, but all three sub-fields are required when it is present — a half-filled MCC is a mistake, an absent one is a choice.
Show child attributes
Show child attributes
Mid for this resource.
Identifier of the partner organisation, when this org is under a partner.
Payment fee percentage.
alpha-3 country code
Registration number for this resource.
Accounts exists only to be rejected, and is untyped so that any shape gets the explanation below rather than a binding error about a missing sub-field.
Sumsub share token from your own Sumsub account, generated for ZBX's Sumsub client id. It imports the merchant's KYC so they do not upload documents again. Requires kyc_questionnaire, and is used once, when the org is created.
HTTPS URL that receives webhook events.