Skip to main content
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>'
{
  "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 the GET /merchant/open/institution/v1/accounts/query endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

Headers

​
X-GatePay-Certificate-ClientId
string
required

The clientId assigned when the merchant registers an application in the Gate merchant console.

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

​
X-GatePay-Timestamp
string
required

UTC timestamp in milliseconds when the request is generated. GatePay will not process requests where the difference from the receive time exceeds 10 seconds.

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

Random string. Must comply with HTTP header rules; recommended length is within 32 characters, composed of digits and letters.

Example:

"9578"

​
X-GatePay-Signature
string
required

Request signature. GatePay uses this signature to verify whether the request is valid.

Query Parameters

​
request_id
string

Creation request ID.

Example:

"35778162074976257"

​
account_id
string

Sub-account ID.

Response

200 - application/json

Success

​
status
string
​
code
string
​
errorMessage
string
​
data
object