GAgate

List Sub-Accounts

Changed on

Paginated list of sub-accounts.

get/merchant/open/institution/v1/accounts/list

Request

  • Base URL
    https://openplatform.gateapi.io
  • URL
    https://openplatform.gateapi.io/merchant/open/institution/v1/accounts/list
  • Auth
    none declared. Required headers: X-GatePay-Certificate-ClientId, X-GatePay-Timestamp, X-GatePay-Nonce, X-GatePay-Signature

Query parameters

status'ACTIVE'

Status: created - ACTIVE.

request_idstring
Example:35778162074976257

Creation request ID.

customer_idstring

Customer ID on the platform side.

created_gteinteger

Creation time (ms) ≥.

created_lteinteger

Creation time (ms) ≤.

limitinteger
Example:20

Page size, default 20, max 200.

cursorinteger
Example:1

Cursor (page number), starting from 1.

Headers

X-GatePay-Certificate-ClientIdstring required
Example:4186d0c6-6a35-55a9-8dc6-5312769dbff8

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

X-GatePay-Timestampstring required
Example:1672905655498

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Noncestring required
Example:9578

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

X-GatePay-Signaturestring required

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

Response

Success

statusstring
codestring
errorMessagestring

Changes

  • 62d31c7e909aRevision changes
    • warning

      added the new ACTIVE enum value to the /// response property for the response status

    • warning

      added the new FAIL enum value to the /// response property for the response status

    • warning

      added the new INIT enum value to the /// response property for the response status

    • warning

      added the new NONE enum value to the /// response property for the response status

    • warning

      added the new PENDING enum value to the /// response property for the response status

    • warning

      added the new RISK_SUSPEND enum value to the /// response property for the response status