Skip to main content
POST
List Fee Rules

Overview

This page documents the institution-only API for paginated retrieval of sub-account fee-rule summaries. Full fields, request payloads, and examples are rendered from the OpenAPI definition above.

Notes

  • The list endpoint is intended for operations consoles, monitoring, and bulk reviews.
  • The primary request keys are pageNum and pageSize, while page and page_size remain accepted compatibility aliases.
  • It uses X-GatePay-MerchantId to identify the main-merchant context and does not use X-GatePay-On-Behalf-Of.

Headers

X-GatePay-Certificate-ClientId
string
required

Application ClientId.

X-GatePay-Signature
string
required

HMAC-SHA512 signature generated with the Payment API Secret.

X-GatePay-Timestamp
string
required

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

X-GatePay-Nonce
string
required

Random nonce used for replay protection.

X-GatePay-MerchantId
string
required

Main merchant ID. This header identifies the institution main-merchant context for this fee-setting API set.

Body

application/json
pageNum
integer

Page number. Default: 1.

Example:

1

pageSize
integer

Page size. Default: 20. Maximum: 100.

Example:

20

has_markup
boolean

Filter by whether a markup is configured.

Example:

true

status
enum<string>

Status filter.

Available options:
EFFECTIVE,
PENDING_EFFECTIVE
sub_merchant_id
string

Exact filter for a single sub-account.

Example:

"123456789"

page
integer

Compatibility alias equivalent to pageNum.

Example:

1

page_size
integer

Compatibility alias equivalent to pageSize.

Example:

20

Response

200 - application/json

Successful response.

status
enum<string>

API processing status.

Available options:
SUCCESS,
FAIL
code
string

Business result code.

Example:

"000000"

errorMessage
string

Error message. Empty string on success.

Example:

""

data
object