Skip to main content
GET
/
merchant
/
open
/
institution
/
v1
/
accounts
/
list
List Sub-Accounts
curl --request GET \
  --url https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/list \
  --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": {
    "accounts": [
      {
        "request_id": "35778162074976257",
        "account_id": "2124543768",
        "customer_id": "1234",
        "display_name": "my test",
        "status": "ACTIVE",
        "created": 1764139266551
      }
    ],
    "has_more": false
  }
}

​
Overview

This page documents the GET /merchant/open/institution/v1/accounts/list 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

​
status
enum<string>

Status: created - ACTIVE.

Available options:
ACTIVE
​
request_id
string

Creation request ID.

Example:

"35778162074976257"

​
customer_id
string

Customer ID on the platform side.

​
created_gte
integer<int64>

Creation time (ms) ≥.

​
created_lte
integer<int64>

Creation time (ms) ≤.

​
limit
integer
default:20

Page size, default 20, max 200.

Required range: x <= 200
Example:

20

​
cursor
integer

Cursor (page number), starting from 1.

Example:

1

Response

200 - application/json

Success

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