Getting Started
Payments
Payouts
Conversion
Gift Cards
Account & Reconciliation
Exchange Rate Query
Institution API
- POSTCreate Sub-Account
- POSTUpdate Sub-Account
- GETQuery Sub-Account
- GETList Sub-Accounts
- POSTCreate Payout (Batch Withdraw)
- POSTPayout Detail
- POSTTransfer (Institution to User)
- GETTransfer Detail (Institution to User)
- POSTCharge (User to Institution)
- GETCharge Detail (User to Institution)
- POSTCallback Notification (Sub-Account Creation Result)
- POSTQuery Account Balance
- GETGet Balance/Fund Flow Bill
- POSTCheckout Order
- POSTAddress Order
- POSTWeb / QR-Code Orders
- POSTQuery Order Details
- POSTCancel Order
- POSTCreate Refund
- GETRefund Detail
- GETQuery Supported Networks and Currencies
- POSTCreate static collection address
- GETList static collection addresses
- GETGet static collection address detail
- GETQuery static collection code bill list
- POSTCreate EVM static collection address
- DELDelete static collection address
- POSTCreate Convert
- GETQuery Available Convert Currencies
- GETQuery Available Convert Pairs
- POSTConvert Preview
- GETQuery Convert Order
{
"bizType": "PAY",
"bizId": "1647557960944",
"bizStatus": "PAY_SUCCESS",
"data": "{\"merchantTradeNo\":\"gateio_withdraw6331782520222\",\"productType\":\"NFT\",\"productName\":\"ka\",\"tradeType\":\"APP\",\"goodsName\":\"ka\",\"terminalType\":\"APP\",\"currency\":\"USDT\",\"totalFee\":\"1.2\",\"orderAmount\":\"1.2\",\"createTime\":1664123708000,\"transactionId\":\"24344545\",\"channelId\":\"123456\"}"
}{
"returnCode": "SUCCESS",
"returnMessage": null
}Order status change callback notification
When the status of the prepaid order changes, such as expiration of the order due to exhaustion of payment time or successful payment of the order, the GatePay background will send a notification to the merchant to the notification address, which is the callback url provided by the merchant at registration.
If the notification fails to be sent to the merchant due to a network issue or other unknown reasons, GatePay background will resend it every 3 seconds, 10 times at most until it is sent successfully. If it still does not work, the merchant can query the status of the prepaid order by querying API.
{
"bizType": "PAY",
"bizId": "1647557960944",
"bizStatus": "PAY_SUCCESS",
"data": "{\"merchantTradeNo\":\"gateio_withdraw6331782520222\",\"productType\":\"NFT\",\"productName\":\"ka\",\"tradeType\":\"APP\",\"goodsName\":\"ka\",\"terminalType\":\"APP\",\"currency\":\"USDT\",\"totalFee\":\"1.2\",\"orderAmount\":\"1.2\",\"createTime\":1664123708000,\"transactionId\":\"24344545\",\"channelId\":\"123456\"}"
}{
"returnCode": "SUCCESS",
"returnMessage": null
}Body
The callback notification structure for GatePay order status updates.
The type of the business, must be "PAY".
PAY The ID of the prepayment.
Order status, which can be "PAY_SUCCESS" for payment success, "PAY_CLOSE" for order closed, or "PAY_ERROR" for abnormal scenarios callback.
PAY_SUCCESS, PAY_CLOSE, PAY_ERROR The JSON format string of the order data type object. Refer to PayOrderData.
"{\"merchantTradeNo\":\"gateio_withdraw6331782520222\",\"goodsName\":\"ka\",\"terminalType\":\"APP\",\"currency\":\"USDT\",\"orderAmount\":\"1.2\"}"
Order data object (parsed structure of the data field).
Show child attributes
Show child attributes