Preview Merchant Fee

Estimate Merchant Fees

curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/institution/payClearing/clearing/previewMerchantFee \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "orderCurrency": "USDT",
  "accessMode": 0,
  "scenario": 0,
  "orderAmount": "100.00"
}
'

import requests

url = "https://openplatform.gateapi.io/payment/open/institution/payClearing/clearing/previewMerchantFee"

payload = {
    "orderCurrency": "USDT",
    "accessMode": 0,
    "scenario": 0,
    "orderAmount": "100.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-On-Behalf-Of": "<x-gatepay-on-behalf-of>",
    "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-On-Behalf-Of': '<x-gatepay-on-behalf-of>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({orderCurrency: 'USDT', accessMode: 0, scenario: 0, orderAmount: '100.00'})
};

fetch('https://openplatform.gateapi.io/payment/open/institution/payClearing/clearing/previewMerchantFee', 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/payment/open/institution/payClearing/clearing/previewMerchantFee",
  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([
    'orderCurrency' => 'USDT',
    'accessMode' => 0,
    'scenario' => 0,
    'orderAmount' => '100.00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
    "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/payment/open/institution/payClearing/clearing/previewMerchantFee")
  .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-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderCurrency\": \"USDT\",\n  \"accessMode\": 0,\n  \"scenario\": 0,\n  \"orderAmount\": \"100.00\"\n}")
  .asString();

package main

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

func main() {

	url := "https://openplatform.gateapi.io/payment/open/institution/payClearing/clearing/previewMerchantFee"

	payload := strings.NewReader("{\n  \"orderCurrency\": \"USDT\",\n  \"accessMode\": 0,\n  \"scenario\": 0,\n  \"orderAmount\": \"100.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-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
	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/payment/open/institution/payClearing/clearing/previewMerchantFee")

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-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderCurrency\": \"USDT\",\n  \"accessMode\": 0,\n  \"scenario\": 0,\n  \"orderAmount\": \"100.00\"\n}"

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

{
  "status": "success",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "merchantId": "123456789",
    "merchantType": 1,
    "accessMode": 0,
    "orderCurrency": "USDT",
    "orderAmount": 100,
    "orderFee": 2.5,
    "institutionFeeAmount": 2.5,
    "settleAmount": 95
  }
}

POST

payment

open

institution

payClearing

clearing

previewMerchantFee

Estimate Merchant Fees

curl --request POST \
  --url https://openplatform.gateapi.io/payment/open/institution/payClearing/clearing/previewMerchantFee \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "orderCurrency": "USDT",
  "accessMode": 0,
  "scenario": 0,
  "orderAmount": "100.00"
}
'

import requests

url = "https://openplatform.gateapi.io/payment/open/institution/payClearing/clearing/previewMerchantFee"

payload = {
    "orderCurrency": "USDT",
    "accessMode": 0,
    "scenario": 0,
    "orderAmount": "100.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-On-Behalf-Of": "<x-gatepay-on-behalf-of>",
    "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-On-Behalf-Of': '<x-gatepay-on-behalf-of>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({orderCurrency: 'USDT', accessMode: 0, scenario: 0, orderAmount: '100.00'})
};

fetch('https://openplatform.gateapi.io/payment/open/institution/payClearing/clearing/previewMerchantFee', 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/payment/open/institution/payClearing/clearing/previewMerchantFee",
  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([
    'orderCurrency' => 'USDT',
    'accessMode' => 0,
    'scenario' => 0,
    'orderAmount' => '100.00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
    "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/payment/open/institution/payClearing/clearing/previewMerchantFee")
  .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-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderCurrency\": \"USDT\",\n  \"accessMode\": 0,\n  \"scenario\": 0,\n  \"orderAmount\": \"100.00\"\n}")
  .asString();

package main

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

func main() {

	url := "https://openplatform.gateapi.io/payment/open/institution/payClearing/clearing/previewMerchantFee"

	payload := strings.NewReader("{\n  \"orderCurrency\": \"USDT\",\n  \"accessMode\": 0,\n  \"scenario\": 0,\n  \"orderAmount\": \"100.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-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
	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/payment/open/institution/payClearing/clearing/previewMerchantFee")

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-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderCurrency\": \"USDT\",\n  \"accessMode\": 0,\n  \"scenario\": 0,\n  \"orderAmount\": \"100.00\"\n}"

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

{
  "status": "success",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "merchantId": "123456789",
    "merchantType": 1,
    "accessMode": 0,
    "orderCurrency": "USDT",
    "orderAmount": 100,
    "orderFee": 2.5,
    "institutionFeeAmount": 2.5,
    "settleAmount": 95
  }
}

Overview

This page documents the POST /payment/open/institution/payClearing/clearing/previewMerchantFee endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

Notes

Authentication uses the standard GatePay signed headers.
This page documents the institutional path version of the same endpoint.
Optional orderType and X-GatePay-Sub-MerchantId support revenue share preview.
Response adds institutionFeeAmount and settleAmount.
For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

Headers

X-GatePay-Certificate-ClientId

string

required

Merchant ID

Example:

"mZ96D37oKk-HrWJc"

X-GatePay-Signature

string

required

Signature

Example:

"601d560c54d53412aca5901256f101e7078b5779f61f30bedfe9a5f0b92f049589952a151ea477371e4a99ac0e1c3cc8dec62654b3c6a1794ef981efe19232bc"

X-GatePay-Timestamp

string

required

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

Example:

"1726027137585"

X-GatePay-Nonce

string

required

Nonce

Example:

"2290830087"

X-GatePay-On-Behalf-Of

string

required

Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.

X-GatePay-Sub-MerchantId

string

Sub-merchant UID for institution sub-account. Optional; revenue share (markup) is calculated only when this header is provided.

Example:

"2124674730"

Body

application/json

Estimate merchant fee request parameters

orderCurrency

string

required

Order currency, e.g., USDT, USDC, etc.

Example:

"USDT"

accessMode

enum<integer>

required

Integration mode: 0=Gate Pay, 1=Web3 payment

Available options:

0,

1

Example:

0

scenario

enum<integer>

required

Transaction type (Scenario): 0=Collection

Available options:

0

Example:

0

orderAmount

string<decimal>

required

Order amount, must be greater than or equal to 0

Example:

"100.00"

orderType

enum<integer>

Order type. Optional values: 0-address payment, 1-checkout payment, 2-static QR code, 3-invoicing payment, 4-AI payment. If omitted, fallback rate applies.

Available options:

0,

1,

2,

3,

4

Example:

0

Response

Estimation successful

status

enum<string>

Response status: success/error

Available options:

success,

error

Example:

"success"

code

string

Response code, 000000 indicates success

Example:

"000000"

errorMessage

string

Error message, empty on success

Example:

""

data

object

Show child attributes

⌘I

Common

Balance

Institution

Payment

OTC

Convert

Payout

Gift Card

Subscription

Reconciliation

Notifications

Overview

Notes

Headers

Body

Response

​Overview

​Notes

Headers

Body

Response

Overview

Notes