Skip to main content
POST
/
rate
/
commission_rule
/
upgrade
Update Fee Rule
curl --request POST \
  --url https://openplatform.gateapi.io/rate/commission_rule/upgrade \
  --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 '
{
  "r_markup": 0.002,
  "effective_date": "2026-05-01 00:00:00"
}
'
{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "config_id": "cfg_202605010001",
    "previous_config_id": "cfg_existing_xxx",
    "version_no": 2,
    "sub_merchant_id": "123456789",
    "r_markup": 0.002,
    "f_markup": 1,
    "status": "PENDING_EFFECTIVE",
    "effective_date": "2026-05-01 00:00:00",
    "due_date": null,
    "created_at": "2026-04-17T09:00:00Z",
    "updated_at": "2026-04-17T09:00:00Z"
  }
}

​
Overview

This page documents the institution-only API that updates a sub-account fee rule by creating a new version. Full fields, request payloads, and examples are rendered from the OpenAPI definition above.

​
Notes

  • This endpoint creates a new rule version. A successful request does not immediately replace the currently effective rule, but any pending-effective version is invalidated. When the new version becomes effective, it fully replaces the current rule.
  • It uses X-GatePay-MerchantId to identify the main-merchant context and does not use X-GatePay-On-Behalf-Of.
  • The request body uses sub_merchant_id to identify which sub-account rule to update; config_id is no longer used as the update input.

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
​
sub_merchant_id
string
required

Sub-account ID.

Example:

"123456789"

​
r_markup
number
required

New percentage markup. Must not be null; 0 is allowed.

Example:

0.002

​
effective_date
string
required

New version effective time in yyyy-MM-dd HH:mm:ss format; precision must include seconds.

Example:

"2026-05-01 00:00:00"

​
f_markup
number

New fixed markup amount in USDT. Defaults to 0.

Example:

1

​
due_date
string | null

New version expiration time in the same format as effective_date; omit for no expiration.

Example:

null

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