v1

latestOpenAPI 3.1.0MIT2026-07-211412.6 KB

Estimate Merchant Fees

Estimates transaction fee, revenue share, and settlement amount based on merchant information and order parameters. Gate Pay merchants only.

post/payClearing/clearing/previewMerchantFee

Headers

X-GatePay-Certificate-ClientIdstring required

Example:mZ96D37oKk-HrWJc

Merchant ID

X-GatePay-Signaturestring required

Example:601d560c54d53412aca5901256f101e7078b5779f61f30bedfe9a5f0b92f049589952a151ea477371e4a99ac0e1c3cc8dec62654b3c6a1794ef981efe19232bc

Signature

X-GatePay-Timestampstring required

Example:1726027137585

Timestamp (milliseconds)

X-GatePay-Noncestring required

Example:2290830087

Nonce

X-GatePay-Sub-MerchantIdstring

Example:2124674730

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

Request body

orderCurrencystring required

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

accessMode0 | 1 required

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

scenario0 required

Transaction type (Scenario): 0=Collection

orderAmountstring decimal required

Order amount, must be greater than or equal to 0

orderType0 | 1 | 2 | 3 | 4

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.

Example request

{
  "orderCurrency": "USDT",
  "orderAmount": "100.00"
}

Response

Estimation successful

status'success' | 'error'

Response status: success/error

codestring

Response code, 000000 indicates success

errorMessagestring

Error message, empty on success

Example response

{
  "status": "success",
  "code": "000000",
  "data": {
    "merchantId": "123456789",
    "merchantType": 1,
    "orderCurrency": "USDT",
    "orderAmount": 100,
    "orderFee": 2.5,
    "settleAmount": 97.5
  }
}

All 1 operations