Query Sub-Account
curl --request GET \
--url https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/query \
--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>'import requests
url = "https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/query"
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>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
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>'
}
};
fetch('https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/query', 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/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.get("https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/query")
.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>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/query"
req, _ := http.NewRequest("GET", url, nil)
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>")
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/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.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>'
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"request_id": "35778162074976257",
"account_id": "2124538349",
"customer_id": "1234",
"display_name": "new name",
"status": "ACTIVE",
"created": 1763469689743,
"updated": 1764141615061,
"account_holder": {
"entity_country": "AF",
"entity_type": "BUSINESS",
"entity_name": null,
"entity_id_type": "BUSINESS_LICENSE",
"entity_id_number": "abcd1234",
"entity_id_expiry": {
"valid_from": 1763538010509,
"valid_to": null
},
"dob": null,
"business_registration": null,
"address": null,
"merchant_category": "GENERAL_RETAIL",
"website": null,
"user_agreement": true
},
"metadata": null
}
}Accounts
Query Sub-account Detail
Query sub-account details.
GET
/
merchant
/
open
/
institution
/
v1
/
accounts
/
query
Query Sub-Account
curl --request GET \
--url https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/query \
--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>'import requests
url = "https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/query"
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>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
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>'
}
};
fetch('https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/query', 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/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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.get("https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/query")
.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>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/query"
req, _ := http.NewRequest("GET", url, nil)
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>")
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/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.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>'
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"request_id": "35778162074976257",
"account_id": "2124538349",
"customer_id": "1234",
"display_name": "new name",
"status": "ACTIVE",
"created": 1763469689743,
"updated": 1764141615061,
"account_holder": {
"entity_country": "AF",
"entity_type": "BUSINESS",
"entity_name": null,
"entity_id_type": "BUSINESS_LICENSE",
"entity_id_number": "abcd1234",
"entity_id_expiry": {
"valid_from": 1763538010509,
"valid_to": null
},
"dob": null,
"business_registration": null,
"address": null,
"merchant_category": "GENERAL_RETAIL",
"website": null,
"user_agreement": true
},
"metadata": null
}
}Overview
This page documents theGET /merchant/open/institution/v1/accounts/query 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.
Query Parameters
Creation request ID.
Example:
"35778162074976257"
Sub-account ID.
⌘I

