Common
- Merchant Access
- Security and Signature
- Notifications
- POSTSub-account Callback
- HOOKOrder Status Callback
- HOOKUnresolved Payment Notification
- HOOKOTC Callback Webhook
- HOOKWithdrawal Callback
- HOOKSubscription Order Status Update Notification
- HOOKPayment Deduction Notification
- HOOKOrder Status Callback
- HOOKUnresolved Payment Notification
- HOOKOTC Callback Webhook
- HOOKWithdrawal Callback
- HOOKSubscription Order Status Update Notification
- HOOKPayment Deduction Notification
- Error Codes
- Best Practices
- Supported Currencies
- Institution Headers
Balance
Institution
Payment
OTC
Convert
Payout
Gift Card
Subscription
{
"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 Callback
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
}Documentation Index
Fetch the complete documentation index at: https://docs.gate.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
This page documentswebhook payOrderWebhook. The full schema, parameters, and examples are rendered from the linked OpenAPI or webhook definition above.
Notes
- This page describes a callback payload sent by GatePay, not a merchant-initiated request.
- Verify the signature first, then apply idempotent processing before updating business state.
- For callback guidance organized by business flow, read this page together with the Notification guide.
- For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.
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