# 1.1 Online Service Address

https://openplatform.gateapi.io

# 1.2 Configure New Applet

• Log into the merchant backend at https://www.gate.com/zh/merchant#/get-started
• Fill in basic information to apply for merchant status
• Go to the application configuration page to configure a new application
• View the list of configured applications to obtain the application ClientId

# 1.3 Generate Payment Key

• Go to the developer page to generate the "Payment API Key," used for signing and verifying the payment interface
• Go to the developer page to generate the "Authorization Key," used for signing and verifying the authorization interface

# 1.4 Key Parameters

• Payment API Key, used for request signing
• ClientId, used for identity verification, along with the payment API key for signature verification

# 2.1 Protocol Rules

# 2.1.1 API Interface Rules

All interface responses return in JSON format

To ensure that requests received by the GatePay API come from authorized third-party platforms, GatePay API will check the required fields in the HTTP request headers for signature validation.

# 2.2.1 New Version Protocol Header

In the new protocol header, the signature is calculated using the key generated in the merchant backend.

# 2.3 Interface Signature

# 2.3.1 Signature Specification

Constructing the signature string:

We expect the technical developers of merchants to construct the signature string according to the rules specified in this document. GatePay will use the same method to construct the signature string. If the merchant constructs the signature string incorrectly, the signature verification will fail. Below is the specific format of the signature string.

Each line is a parameter, ending with \n (newline character, ASCII code 0x0A). If the parameter itself ends with \n, an additional \n is required.

request timestamp\nrequest random string\nrequest body\n

Signature algorithm examples are shown on the right.

# 3.1 Place Withdrawal Order

• Data Type: JSON （content-type：application/json）

• Request Method: POST

• Path: /v1/pay/withdraw

• erification Method: Signature verification

• Request Body Content:

  Field Name	Type	Required	Description
  batch_id	string	Yes	A unique ID generated by the merchant, composed of uppercase and lowercase letters, numbers, and underscores, max length 32 characters.
  withdraw_list	array object	Yes	Details of each withdrawal sub-order
  channel_id	string	No	Client Name.

  Fields in the withdraw_list:

  Field Name	Type	Required	Description
  merchant_withdraw_id	string	Yes	Unique ID for the sub-order generated by the merchant, composed of uppercase and lowercase letters, numbers, and underscores, max length 32 characters.
  amount	string	Yes	Withdrawal amount for each transaction, precision max length 6 digits; exceeding 6 digits will be truncated.
  currency	string	Yes	Currency for withdrawal
  chain	string	Yes	Network chain
  address	string	Yes	Withdrawal address
  memo	string	Yes	Remarks for a transfer, etc.; required for transfers on certain networks. Filling it out when it's not required may result in failure, max length 128 characters

Response Body Content:

• Data Type: JSON （content-type：application/json）
• Request Method: POST
• Path: /v1/pay/withdraw/query
• Verification Method: Signature verification
• Request Body Content:

• Response Body Content:

# withdraw_list list details

# Main order details:

Request Example:

curl --location 'https://openplatform.gateapi.io/v1/pay/withdraw/query' \
--header 'X-GatePay-Certificate-ClientId: mZ96D37oKk-HrWJc' \
--header 'Content-Type: application/json' \
--header 'X-GatePay-Timestamp: 1726027137585' \
--header 'X-GatePay-Nonce: 2290830087' \
--header 'X-GatePay-Signature: 601d560c54d53412aca5901256f101e7078b5779f61f30bedfe9a5f0b92f049589952a151ea477371e4a99ac0e1c3cc8dec62654b3c6a1794ef981efe19232bc' \
--data '{
    "batch_id":"237394559478075555",
    "detail_status":"ALL"
}'

Response Example:

{
    "status": "SUCCESS",
    "code": "000000",
    "errorMessage": "",
    "data": {
        "batch_id": "237394559478075350",
        "merchant_id": 10002,
        "client_id": "mZ96D37oKk-HrWJc",
        "status": "FAIL",
        "create_time": 1726055849126,
        "channel_id": "123456",
        "withdraw_list": [
            {
                "id": 35,
                "batch_id": "237394559478075350",
                "merchant_id": 10002,
                "suborder_id": "268830764354768896",
                "chain": "ETH",
                "address": "0x1234567890abcdef",
                "currency": "USDT",
                "amount": "1",
                "fee": "0",
                "tx_id": "",
                "timestamp": 0,
                "memo": "Payment for services-1",
                "status": "FAIL",
                "merchant_withdraw_id": "M137394559478075550",
                "err_msg": "unexpected http code error",
                "client_id": "mZ96D37oKk-HrWJc",
                "create_time": 1726055848856,
                "update_time": 1726055856011,
                "channel_id": "123456",
                "fee_type": 1,
                "done_amount": "1"
            },
            {
                "id": 36,
                "batch_id": "237394559478075350",
                "merchant_id": 10002,
                "suborder_id": "268830764354768897",
                "chain": "ETH",
                "address": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
                "currency": "USDT",
                "amount": "0.001",
                "fee": "0",
                "tx_id": "",
                "timestamp": 0,
                "memo": "Payment for services-1",
                "status": "FAIL",
                "merchant_withdraw_id": "M137394559478075551",
                "err_msg": "unexpected http code error",
                "client_id": "mZ96D37oKk-HrWJc",
                "create_time": 1726055848856,
                "update_time": 1726055856010,
                "channel_id": "123456",
                "fee_type": 1,
                "done_amount": "0.001"
            }
        ]
    }
}

If batch_id does not exist, return empty:

{
    "status": "SUCCESS",
    "code": "000000",
    "errorMessage": "",
    "data": {
        "batch_id": "237394559478075358",
        "merchant_id": 0,
        "client_id": "",
        "status": "",
        "create_time": 0,
        "withdraw_list": []
    }
}

• Data Type: JSON (content-type: application/json)

• Request Method: GET

• Path: /v1/pay/wallet/currency_chains

• Authentication: Signature Verification

• Request Body:

  Field Name	Type	Required	Description
  currency	string	Yes	Specify currency name

• Response Format:

  Status Code 200

• Data Type: JSON (content-type: application/json)

• Request Method: GET

• Path: /v1/pay/wallet/total_balance

• Authentication: Signature Verification

• Request Body:

  Field Name	Type	Required	Description
  currency	string	Yes	Specify currency name

• Response Format:

  Status Code 200

• Data Type: JSON (content-type: application/json)

• Request Method: GET

• Path: /v1/pay/wallet/withdraw_status

• Authentication: Signature Verification

• Request Body:

  Field Name	Type	Required	Description
  currency	string	Yes	Specify currency name

• Response Format:

  Status Code 200

No handling fees are charged for withdrawals to a Gate addresss, whereas handling fees apply when withdrawingto a non-Gate address.

• When you call the "Withdrawal Status Query" interface, it retturns the handling fees required by the supported chains for the coin. Choose the chain you need.
• Pay attention to the two parameters below:

• [withdraw_fix_on_chains] refers to the fixed handling fee.
• [withdraw_percent_on_chains] refers to the percentage-based handling fee (When you withdraw certain special coins, the fee is calculated as the withdrawal quantity rmultiplied by the percentage).

• Withdrawal Handling Fee = Fixed Handling Fee + Fee Percentage >Withdrawal Quantity
• At present, most common chains only charge a fixed handling feewhich is updated hourly.
• Call the interface to check the handling fee every time you make awithdrawal. The handling fee is updated hourly.

• Data Type: JSON (content-type: application/json)
• Request Method: GET
• Path: /v1/pay/wallet/withdrawals
• Authentication: Signature Verification
• Request Parameters:

Query time range cannot exceed 30 days

Detailed description:

• Response Format:

Status Code 200

Withdrawal order callback notification fields:

# 3.7.1 Callback

# Main Order

# Suborder