Create Sub-Account
curl --request POST \
--url https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
--data '
{
"request_id": "35778162074976257",
"customer_id": "1234",
"display_name": "my test",
"account_holder": {
"entity_country": "AF",
"entity_type": "BUSINESS",
"entity_name": "My Business Ltd",
"entity_id_type": "BUSINESS_LICENSE",
"entity_id_number": "abcd1234",
"entity_id_expiry": {
"valid_from": 1763538010509
},
"address": {
"line1": "123 Main Street",
"country": "AF"
},
"merchant_category": "GENERAL_RETAIL",
"user_agreement": true,
"ubo_list": [
{
"country": "AF",
"full_name": "testName778",
"dob": {
"year": 2026,
"month": 3,
"day": 3
},
"id_type": "DRIVING_LICENSE",
"id_number": "130",
"id_expiry": {
"valid_from": 1773135745000,
"valid_to": 1873135745000
},
"relationship": {
"is_representative": false,
"is_owner": false,
"percent_ownership": "30"
}
}
]
}
}
'import requests
url = "https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create"
payload = {
"request_id": "35778162074976257",
"customer_id": "1234",
"display_name": "my test",
"account_holder": {
"entity_country": "AF",
"entity_type": "BUSINESS",
"entity_name": "My Business Ltd",
"entity_id_type": "BUSINESS_LICENSE",
"entity_id_number": "abcd1234",
"entity_id_expiry": { "valid_from": 1763538010509 },
"address": {
"line1": "123 Main Street",
"country": "AF"
},
"merchant_category": "GENERAL_RETAIL",
"user_agreement": True,
"ubo_list": [
{
"country": "AF",
"full_name": "testName778",
"dob": {
"year": 2026,
"month": 3,
"day": 3
},
"id_type": "DRIVING_LICENSE",
"id_number": "130",
"id_expiry": {
"valid_from": 1773135745000,
"valid_to": 1873135745000
},
"relationship": {
"is_representative": False,
"is_owner": False,
"percent_ownership": "30"
}
}
]
}
}
headers = {
"X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
"X-GatePay-Timestamp": "<x-gatepay-timestamp>",
"X-GatePay-Nonce": "<x-gatepay-nonce>",
"X-GatePay-Signature": "<x-gatepay-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
'X-GatePay-Nonce': '<x-gatepay-nonce>',
'X-GatePay-Signature': '<x-gatepay-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
request_id: '35778162074976257',
customer_id: '1234',
display_name: 'my test',
account_holder: {
entity_country: 'AF',
entity_type: 'BUSINESS',
entity_name: 'My Business Ltd',
entity_id_type: 'BUSINESS_LICENSE',
entity_id_number: 'abcd1234',
entity_id_expiry: {valid_from: 1763538010509},
address: {line1: '123 Main Street', country: 'AF'},
merchant_category: 'GENERAL_RETAIL',
user_agreement: true,
ubo_list: [
{
country: 'AF',
full_name: 'testName778',
dob: {year: 2026, month: 3, day: 3},
id_type: 'DRIVING_LICENSE',
id_number: '130',
id_expiry: {valid_from: 1773135745000, valid_to: 1873135745000},
relationship: {is_representative: false, is_owner: false, percent_ownership: '30'}
}
]
}
})
};
fetch('https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create', 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://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create",
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([
'request_id' => '35778162074976257',
'customer_id' => '1234',
'display_name' => 'my test',
'account_holder' => [
'entity_country' => 'AF',
'entity_type' => 'BUSINESS',
'entity_name' => 'My Business Ltd',
'entity_id_type' => 'BUSINESS_LICENSE',
'entity_id_number' => 'abcd1234',
'entity_id_expiry' => [
'valid_from' => 1763538010509
],
'address' => [
'line1' => '123 Main Street',
'country' => 'AF'
],
'merchant_category' => 'GENERAL_RETAIL',
'user_agreement' => true,
'ubo_list' => [
[
'country' => 'AF',
'full_name' => 'testName778',
'dob' => [
'year' => 2026,
'month' => 3,
'day' => 3
],
'id_type' => 'DRIVING_LICENSE',
'id_number' => '130',
'id_expiry' => [
'valid_from' => 1773135745000,
'valid_to' => 1873135745000
],
'relationship' => [
'is_representative' => false,
'is_owner' => false,
'percent_ownership' => '30'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
"X-GatePay-Nonce: <x-gatepay-nonce>",
"X-GatePay-Signature: <x-gatepay-signature>",
"X-GatePay-Timestamp: <x-gatepay-timestamp>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create")
.header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
.header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
.header("X-GatePay-Nonce", "<x-gatepay-nonce>")
.header("X-GatePay-Signature", "<x-gatepay-signature>")
.header("Content-Type", "application/json")
.body("{\n \"request_id\": \"35778162074976257\",\n \"customer_id\": \"1234\",\n \"display_name\": \"my test\",\n \"account_holder\": {\n \"entity_country\": \"AF\",\n \"entity_type\": \"BUSINESS\",\n \"entity_name\": \"My Business Ltd\",\n \"entity_id_type\": \"BUSINESS_LICENSE\",\n \"entity_id_number\": \"abcd1234\",\n \"entity_id_expiry\": {\n \"valid_from\": 1763538010509\n },\n \"address\": {\n \"line1\": \"123 Main Street\",\n \"country\": \"AF\"\n },\n \"merchant_category\": \"GENERAL_RETAIL\",\n \"user_agreement\": true,\n \"ubo_list\": [\n {\n \"country\": \"AF\",\n \"full_name\": \"testName778\",\n \"dob\": {\n \"year\": 2026,\n \"month\": 3,\n \"day\": 3\n },\n \"id_type\": \"DRIVING_LICENSE\",\n \"id_number\": \"130\",\n \"id_expiry\": {\n \"valid_from\": 1773135745000,\n \"valid_to\": 1873135745000\n },\n \"relationship\": {\n \"is_representative\": false,\n \"is_owner\": false,\n \"percent_ownership\": \"30\"\n }\n }\n ]\n }\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create"
payload := strings.NewReader("{\n \"request_id\": \"35778162074976257\",\n \"customer_id\": \"1234\",\n \"display_name\": \"my test\",\n \"account_holder\": {\n \"entity_country\": \"AF\",\n \"entity_type\": \"BUSINESS\",\n \"entity_name\": \"My Business Ltd\",\n \"entity_id_type\": \"BUSINESS_LICENSE\",\n \"entity_id_number\": \"abcd1234\",\n \"entity_id_expiry\": {\n \"valid_from\": 1763538010509\n },\n \"address\": {\n \"line1\": \"123 Main Street\",\n \"country\": \"AF\"\n },\n \"merchant_category\": \"GENERAL_RETAIL\",\n \"user_agreement\": true,\n \"ubo_list\": [\n {\n \"country\": \"AF\",\n \"full_name\": \"testName778\",\n \"dob\": {\n \"year\": 2026,\n \"month\": 3,\n \"day\": 3\n },\n \"id_type\": \"DRIVING_LICENSE\",\n \"id_number\": \"130\",\n \"id_expiry\": {\n \"valid_from\": 1773135745000,\n \"valid_to\": 1873135745000\n },\n \"relationship\": {\n \"is_representative\": false,\n \"is_owner\": false,\n \"percent_ownership\": \"30\"\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
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))
}require 'uri'
require 'net/http'
url = URI("https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request_id\": \"35778162074976257\",\n \"customer_id\": \"1234\",\n \"display_name\": \"my test\",\n \"account_holder\": {\n \"entity_country\": \"AF\",\n \"entity_type\": \"BUSINESS\",\n \"entity_name\": \"My Business Ltd\",\n \"entity_id_type\": \"BUSINESS_LICENSE\",\n \"entity_id_number\": \"abcd1234\",\n \"entity_id_expiry\": {\n \"valid_from\": 1763538010509\n },\n \"address\": {\n \"line1\": \"123 Main Street\",\n \"country\": \"AF\"\n },\n \"merchant_category\": \"GENERAL_RETAIL\",\n \"user_agreement\": true,\n \"ubo_list\": [\n {\n \"country\": \"AF\",\n \"full_name\": \"testName778\",\n \"dob\": {\n \"year\": 2026,\n \"month\": 3,\n \"day\": 3\n },\n \"id_type\": \"DRIVING_LICENSE\",\n \"id_number\": \"130\",\n \"id_expiry\": {\n \"valid_from\": 1773135745000,\n \"valid_to\": 1873135745000\n },\n \"relationship\": {\n \"is_representative\": false,\n \"is_owner\": false,\n \"percent_ownership\": \"30\"\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"request_id": "35778162074976257",
"status": "INIT",
"created": "1764139242707",
"display_name": "my test",
"customer_id": "1234",
"account_holder": {
"entity_country": "AF",
"entity_type": "BUSINESS",
"entity_name": "My Business Ltd",
"entity_id_type": "BUSINESS_LICENSE",
"entity_id_number": "abcd1234",
"entity_id_expiry": {
"valid_from": 1763538010509,
"valid_to": null
},
"dob": null,
"business_registration": null,
"address": {
"line1": "123 Main Street",
"country": "AF"
},
"merchant_category": "GENERAL_RETAIL",
"website": null,
"user_agreement": true
},
"metadata": null
}
}Accounts
Create Sub-account
Create a new sub-account for a customer under the institution account and register the account holder information.
POST
/
merchant
/
open
/
institution
/
v1
/
accounts
/
create
Create Sub-Account
curl --request POST \
--url https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
--data '
{
"request_id": "35778162074976257",
"customer_id": "1234",
"display_name": "my test",
"account_holder": {
"entity_country": "AF",
"entity_type": "BUSINESS",
"entity_name": "My Business Ltd",
"entity_id_type": "BUSINESS_LICENSE",
"entity_id_number": "abcd1234",
"entity_id_expiry": {
"valid_from": 1763538010509
},
"address": {
"line1": "123 Main Street",
"country": "AF"
},
"merchant_category": "GENERAL_RETAIL",
"user_agreement": true,
"ubo_list": [
{
"country": "AF",
"full_name": "testName778",
"dob": {
"year": 2026,
"month": 3,
"day": 3
},
"id_type": "DRIVING_LICENSE",
"id_number": "130",
"id_expiry": {
"valid_from": 1773135745000,
"valid_to": 1873135745000
},
"relationship": {
"is_representative": false,
"is_owner": false,
"percent_ownership": "30"
}
}
]
}
}
'import requests
url = "https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create"
payload = {
"request_id": "35778162074976257",
"customer_id": "1234",
"display_name": "my test",
"account_holder": {
"entity_country": "AF",
"entity_type": "BUSINESS",
"entity_name": "My Business Ltd",
"entity_id_type": "BUSINESS_LICENSE",
"entity_id_number": "abcd1234",
"entity_id_expiry": { "valid_from": 1763538010509 },
"address": {
"line1": "123 Main Street",
"country": "AF"
},
"merchant_category": "GENERAL_RETAIL",
"user_agreement": True,
"ubo_list": [
{
"country": "AF",
"full_name": "testName778",
"dob": {
"year": 2026,
"month": 3,
"day": 3
},
"id_type": "DRIVING_LICENSE",
"id_number": "130",
"id_expiry": {
"valid_from": 1773135745000,
"valid_to": 1873135745000
},
"relationship": {
"is_representative": False,
"is_owner": False,
"percent_ownership": "30"
}
}
]
}
}
headers = {
"X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
"X-GatePay-Timestamp": "<x-gatepay-timestamp>",
"X-GatePay-Nonce": "<x-gatepay-nonce>",
"X-GatePay-Signature": "<x-gatepay-signature>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
'X-GatePay-Nonce': '<x-gatepay-nonce>',
'X-GatePay-Signature': '<x-gatepay-signature>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
request_id: '35778162074976257',
customer_id: '1234',
display_name: 'my test',
account_holder: {
entity_country: 'AF',
entity_type: 'BUSINESS',
entity_name: 'My Business Ltd',
entity_id_type: 'BUSINESS_LICENSE',
entity_id_number: 'abcd1234',
entity_id_expiry: {valid_from: 1763538010509},
address: {line1: '123 Main Street', country: 'AF'},
merchant_category: 'GENERAL_RETAIL',
user_agreement: true,
ubo_list: [
{
country: 'AF',
full_name: 'testName778',
dob: {year: 2026, month: 3, day: 3},
id_type: 'DRIVING_LICENSE',
id_number: '130',
id_expiry: {valid_from: 1773135745000, valid_to: 1873135745000},
relationship: {is_representative: false, is_owner: false, percent_ownership: '30'}
}
]
}
})
};
fetch('https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create', 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://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create",
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([
'request_id' => '35778162074976257',
'customer_id' => '1234',
'display_name' => 'my test',
'account_holder' => [
'entity_country' => 'AF',
'entity_type' => 'BUSINESS',
'entity_name' => 'My Business Ltd',
'entity_id_type' => 'BUSINESS_LICENSE',
'entity_id_number' => 'abcd1234',
'entity_id_expiry' => [
'valid_from' => 1763538010509
],
'address' => [
'line1' => '123 Main Street',
'country' => 'AF'
],
'merchant_category' => 'GENERAL_RETAIL',
'user_agreement' => true,
'ubo_list' => [
[
'country' => 'AF',
'full_name' => 'testName778',
'dob' => [
'year' => 2026,
'month' => 3,
'day' => 3
],
'id_type' => 'DRIVING_LICENSE',
'id_number' => '130',
'id_expiry' => [
'valid_from' => 1773135745000,
'valid_to' => 1873135745000
],
'relationship' => [
'is_representative' => false,
'is_owner' => false,
'percent_ownership' => '30'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
"X-GatePay-Nonce: <x-gatepay-nonce>",
"X-GatePay-Signature: <x-gatepay-signature>",
"X-GatePay-Timestamp: <x-gatepay-timestamp>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create")
.header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
.header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
.header("X-GatePay-Nonce", "<x-gatepay-nonce>")
.header("X-GatePay-Signature", "<x-gatepay-signature>")
.header("Content-Type", "application/json")
.body("{\n \"request_id\": \"35778162074976257\",\n \"customer_id\": \"1234\",\n \"display_name\": \"my test\",\n \"account_holder\": {\n \"entity_country\": \"AF\",\n \"entity_type\": \"BUSINESS\",\n \"entity_name\": \"My Business Ltd\",\n \"entity_id_type\": \"BUSINESS_LICENSE\",\n \"entity_id_number\": \"abcd1234\",\n \"entity_id_expiry\": {\n \"valid_from\": 1763538010509\n },\n \"address\": {\n \"line1\": \"123 Main Street\",\n \"country\": \"AF\"\n },\n \"merchant_category\": \"GENERAL_RETAIL\",\n \"user_agreement\": true,\n \"ubo_list\": [\n {\n \"country\": \"AF\",\n \"full_name\": \"testName778\",\n \"dob\": {\n \"year\": 2026,\n \"month\": 3,\n \"day\": 3\n },\n \"id_type\": \"DRIVING_LICENSE\",\n \"id_number\": \"130\",\n \"id_expiry\": {\n \"valid_from\": 1773135745000,\n \"valid_to\": 1873135745000\n },\n \"relationship\": {\n \"is_representative\": false,\n \"is_owner\": false,\n \"percent_ownership\": \"30\"\n }\n }\n ]\n }\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create"
payload := strings.NewReader("{\n \"request_id\": \"35778162074976257\",\n \"customer_id\": \"1234\",\n \"display_name\": \"my test\",\n \"account_holder\": {\n \"entity_country\": \"AF\",\n \"entity_type\": \"BUSINESS\",\n \"entity_name\": \"My Business Ltd\",\n \"entity_id_type\": \"BUSINESS_LICENSE\",\n \"entity_id_number\": \"abcd1234\",\n \"entity_id_expiry\": {\n \"valid_from\": 1763538010509\n },\n \"address\": {\n \"line1\": \"123 Main Street\",\n \"country\": \"AF\"\n },\n \"merchant_category\": \"GENERAL_RETAIL\",\n \"user_agreement\": true,\n \"ubo_list\": [\n {\n \"country\": \"AF\",\n \"full_name\": \"testName778\",\n \"dob\": {\n \"year\": 2026,\n \"month\": 3,\n \"day\": 3\n },\n \"id_type\": \"DRIVING_LICENSE\",\n \"id_number\": \"130\",\n \"id_expiry\": {\n \"valid_from\": 1773135745000,\n \"valid_to\": 1873135745000\n },\n \"relationship\": {\n \"is_representative\": false,\n \"is_owner\": false,\n \"percent_ownership\": \"30\"\n }\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
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))
}require 'uri'
require 'net/http'
url = URI("https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"request_id\": \"35778162074976257\",\n \"customer_id\": \"1234\",\n \"display_name\": \"my test\",\n \"account_holder\": {\n \"entity_country\": \"AF\",\n \"entity_type\": \"BUSINESS\",\n \"entity_name\": \"My Business Ltd\",\n \"entity_id_type\": \"BUSINESS_LICENSE\",\n \"entity_id_number\": \"abcd1234\",\n \"entity_id_expiry\": {\n \"valid_from\": 1763538010509\n },\n \"address\": {\n \"line1\": \"123 Main Street\",\n \"country\": \"AF\"\n },\n \"merchant_category\": \"GENERAL_RETAIL\",\n \"user_agreement\": true,\n \"ubo_list\": [\n {\n \"country\": \"AF\",\n \"full_name\": \"testName778\",\n \"dob\": {\n \"year\": 2026,\n \"month\": 3,\n \"day\": 3\n },\n \"id_type\": \"DRIVING_LICENSE\",\n \"id_number\": \"130\",\n \"id_expiry\": {\n \"valid_from\": 1773135745000,\n \"valid_to\": 1873135745000\n },\n \"relationship\": {\n \"is_representative\": false,\n \"is_owner\": false,\n \"percent_ownership\": \"30\"\n }\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"request_id": "35778162074976257",
"status": "INIT",
"created": "1764139242707",
"display_name": "my test",
"customer_id": "1234",
"account_holder": {
"entity_country": "AF",
"entity_type": "BUSINESS",
"entity_name": "My Business Ltd",
"entity_id_type": "BUSINESS_LICENSE",
"entity_id_number": "abcd1234",
"entity_id_expiry": {
"valid_from": 1763538010509,
"valid_to": null
},
"dob": null,
"business_registration": null,
"address": {
"line1": "123 Main Street",
"country": "AF"
},
"merchant_category": "GENERAL_RETAIL",
"website": null,
"user_agreement": true
},
"metadata": null
}
}Overview
This page documents thePOST /merchant/open/institution/v1/accounts/create endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.
Notes
- Authentication uses the standard GatePay signed headers.
- This dedicated institution endpoint does not use
X-GatePay-On-Behalf-Of. - For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.
Headers
The clientId assigned when the merchant registers an application in the Gate merchant console.
Example:
"4186d0c6-6a35-55a9-8dc6-5312769dbff8"
Millisecond timestamp; the difference from server time must not exceed 30 seconds.
Example:
"1672905655498"
Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.
Example:
"9578"
Request signature. GatePay uses this signature to verify whether the request is valid.
Body
application/json
⌘I