Skip to main content
GET
Query Static Collection Address List

Overview

This page documents the GET /payment/open/institution/v1/pay/fixedaddress/list endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above. Queries the list of generated and valid static collection addresses.

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-Signature
string
required

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

X-GatePay-Timestamp
string
required

Millisecond timestamp; the difference from server time must not exceed 30 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-On-Behalf-Of
string
required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

Query Parameters

page
integer
required

A non-negative integer starting from 0, indicating the page number

count
integer
required

A positive integer representing the number of entries displayed per page, with a maximum of 100

Response

200 - application/json

Successful response

status
enum<string>

API response result, SUCCESS or FAIL.

Available options:
SUCCESS,
FAIL
code
string

Response error code.

errorMessage
string

Error description.

data
object