Skip to main content
POST
/
rate
/
commission_rule
/
list
List Fee Rules
curl --request POST \
  --url https://openplatform.gateapi.io/rate/commission_rule/list \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-MerchantId: <x-gatepay-merchantid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "pageNum": 1,
  "pageSize": 20,
  "has_markup": true,
  "status": "EFFECTIVE",
  "sub_merchant_id": "123456789"
}
'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "records": [
      {
        "sub_merchant_id": "123456789",
        "has_markup": true,
        "r_markup": 0.001,
        "f_markup": 0,
        "actual_rate": {
          "r_total": 0.0035,
          "f_total": 1
        },
        "status": "EFFECTIVE",
        "effective_date": "2026-04-17 00:00:00",
        "due_date": null,
        "updated_at": "2026-04-17T08:00:00Z"
      }
    ],
    "total": 48,
    "size": 20,
    "current": 1,
    "pages": 3
  }
}

​
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

UTC timestamp in milliseconds.

​
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