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"
}
'

import requests

url = "https://openplatform.gateapi.io/rate/commission_rule/upgrade"

payload = {
    "r_markup": 0.002,
    "effective_date": "2026-05-01 00:00:00"
}
headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "X-GatePay-MerchantId": "<x-gatepay-merchantid>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'X-GatePay-MerchantId': '<x-gatepay-merchantid>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({r_markup: 0.002, effective_date: '2026-05-01 00:00:00'})
};

fetch('https://openplatform.gateapi.io/rate/commission_rule/upgrade', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/rate/commission_rule/upgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'r_markup' => 0.002,
    'effective_date' => '2026-05-01 00:00:00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-MerchantId: <x-gatepay-merchantid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/rate/commission_rule/upgrade")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("X-GatePay-MerchantId", "<x-gatepay-merchantid>")
  .header("Content-Type", "application/json")
  .body("{\n  \"r_markup\": 0.002,\n  \"effective_date\": \"2026-05-01 00:00:00\"\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/rate/commission_rule/upgrade"

	payload := strings.NewReader("{\n  \"r_markup\": 0.002,\n  \"effective_date\": \"2026-05-01 00:00:00\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("X-GatePay-MerchantId", "<x-gatepay-merchantid>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/rate/commission_rule/upgrade")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-MerchantId"] = '<x-gatepay-merchantid>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"r_markup\": 0.002,\n  \"effective_date\": \"2026-05-01 00:00:00\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  }
}

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"
}
'

import requests

url = "https://openplatform.gateapi.io/rate/commission_rule/upgrade"

payload = {
    "r_markup": 0.002,
    "effective_date": "2026-05-01 00:00:00"
}
headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "X-GatePay-MerchantId": "<x-gatepay-merchantid>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'X-GatePay-MerchantId': '<x-gatepay-merchantid>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({r_markup: 0.002, effective_date: '2026-05-01 00:00:00'})
};

fetch('https://openplatform.gateapi.io/rate/commission_rule/upgrade', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/rate/commission_rule/upgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'r_markup' => 0.002,
    'effective_date' => '2026-05-01 00:00:00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-MerchantId: <x-gatepay-merchantid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/rate/commission_rule/upgrade")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("X-GatePay-MerchantId", "<x-gatepay-merchantid>")
  .header("Content-Type", "application/json")
  .body("{\n  \"r_markup\": 0.002,\n  \"effective_date\": \"2026-05-01 00:00:00\"\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/rate/commission_rule/upgrade"

	payload := strings.NewReader("{\n  \"r_markup\": 0.002,\n  \"effective_date\": \"2026-05-01 00:00:00\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("X-GatePay-MerchantId", "<x-gatepay-merchantid>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/rate/commission_rule/upgrade")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["X-GatePay-MerchantId"] = '<x-gatepay-merchantid>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"r_markup\": 0.002,\n  \"effective_date\": \"2026-05-01 00:00:00\"\n}"

response = http.request(request)
puts response.read_body

{
  "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

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

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

Show child attributes

⌘I

Common

Balance

Institution

Payment

OTC

Convert

Payout

Gift Card

Subscription

Reconciliation

Notifications

Update Fee Rule

Overview

Notes

Headers

Body

Response

​Overview

​Notes

Headers

Body

Response

Overview

Notes