Skip to main content
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"
}
'
{
  "status": "success",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "merchantId": "123456789",
    "merchantType": 1,
    "accessMode": 0,
    "orderCurrency": "USDT",
    "orderAmount": 100,
    "orderFee": 2.5
  }
}

​
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

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

Timestamp (milliseconds)

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.

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"

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