Skip to main content
GET
/
rate
/
commission_rule
Get Fee Rule Configuration Detail
curl --request GET \
  --url https://openplatform.gateapi.io/rate/commission_rule \
  --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>'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "sub_merchant_id": "123456789",
    "has_markup": true,
    "config_id": "cfg_202604150001",
    "r_markup": 0.001,
    "f_markup": 0,
    "status": "EFFECTIVE",
    "effective_date": "2026-04-15 00:00:00",
    "expired_date": null,
    "actual_rate": {
      "r_total": 0.0035,
      "f_total": 1
    },
    "updated_at": "2026-04-15T08:30:00Z"
  }
}

​
Overview

This page documents the institution-only API that returns the effective fee-setting snapshot for a sub-account at a specified time. Full fields, request parameters, and examples are rendered from the OpenAPI definition above.

​
Notes

  • Query the effective configuration for a sub-account at a specified time. If no time is provided, the current effective configuration is returned.
  • It uses X-GatePay-MerchantId to identify the main-merchant context and does not use X-GatePay-On-Behalf-Of.
  • For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

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.

Query Parameters

​
sub_merchant_id
string
required

Sub-account ID.

​
effective_date
string

Query time in YYYY-MM-DD HH:mm:ss format. If omitted, the current effective configuration is returned.

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