Gate Payment Status Notification

{
  "bizType": "PAY",
  "bizId": "79553572569350157",
  "bizStatus": "PAY_SUCCESS",
  "data": "{\"channelId\":\"\",\"createTime\":1780037371613,\"currency\":\"USDT\",\"doneAmountOnChain\":\"0\",\"goodsName\":\"KM/ORDER-63FDE37F - PUBG Mobile UC Global ( Special Offer ) - PUBG 1800 UC x 1\",\"merchantTradeNo\":\"6a1936fb6ac6f72b7a817576\",\"orderAmount\":\"21.88\",\"payerId\":16839589,\"productName\":\"KM/ORDER-63FDE37F - PUBG Mobile UC Global ( Special Offer ) - PUBG 1800 UC x 1\",\"productType\":\"\",\"terminalType\":\"WEB\",\"tradeType\":\"WEB\",\"waitAmountOnChain\":\"0\"}"
}

{
  "returnCode": "SUCCESS",
  "returnMessage": ""
}

WEBHOOK

gatePaymentWebhook

{
  "bizType": "PAY",
  "bizId": "79553572569350157",
  "bizStatus": "PAY_SUCCESS",
  "data": "{\"channelId\":\"\",\"createTime\":1780037371613,\"currency\":\"USDT\",\"doneAmountOnChain\":\"0\",\"goodsName\":\"KM/ORDER-63FDE37F - PUBG Mobile UC Global ( Special Offer ) - PUBG 1800 UC x 1\",\"merchantTradeNo\":\"6a1936fb6ac6f72b7a817576\",\"orderAmount\":\"21.88\",\"payerId\":16839589,\"productName\":\"KM/ORDER-63FDE37F - PUBG Mobile UC Global ( Special Offer ) - PUBG 1800 UC x 1\",\"productType\":\"\",\"terminalType\":\"WEB\",\"tradeType\":\"WEB\",\"waitAmountOnChain\":\"0\"}"
}

{
  "returnCode": "SUCCESS",
  "returnMessage": ""
}

Overview

This page documents webhook gatePaymentWebhook. The full schema, parameters, and examples are rendered from the linked OpenAPI or webhook definition above. GatePay sends asynchronous notifications to the merchant callback URL when Gate payment order status changes (bizType is PAY).

Notes

Use merchantTradeNo or bizId for idempotency.
Signature verification, retries, parsing data, and the success response are covered in Notifications Overview; see Security and Signature for signing rules.

Trigger Scenarios

When the order status changes (payment success, payment timeout, cancellation, closure, and similar events), GatePay sends a notification to the callback URL configured at merchant registration
If delivery fails, see retry rules in Notifications Overview.

Scope: Orders placed through hosted checkout, web or in-app launch, and similar flows where the user pays with a Gate payment account (bizType is PAY). See Payments for integration guidance.

Message Structure

Field	Type	Description
`bizType`	string	Always `PAY`
`bizId`	string	Prepaid order ID
`bizStatus`	string	Order status; see table below
`client_id`	string	Merchant `client_id` that created the order (may be omitted in some callbacks; use actual payload)
`data`	string	Order payload as a JSON string

Example Message

{
  "bizType": "PAY",
  "bizId": "79553572569350157",
  "bizStatus": "PAY_SUCCESS",
  "data": "{\"channelId\":\"\",\"createTime\":1780037371613,\"currency\":\"USDT\",\"doneAmountOnChain\":\"0\",\"goodsName\":\"KM/ORDER-63FDE37F - PUBG Mobile UC Global ( Special Offer ) - PUBG 1800 UC x 1\",\"merchantTradeNo\":\"6a1936fb6ac6f72b7a817576\",\"orderAmount\":\"21.88\",\"payerId\":16839589,\"productName\":\"KM/ORDER-63FDE37F - PUBG Mobile UC Global ( Special Offer ) - PUBG 1800 UC x 1\",\"productType\":\"\",\"terminalType\":\"WEB\",\"tradeType\":\"WEB\",\"waitAmountOnChain\":\"0\"}"
}

bizStatus Enumeration

Value	Description
`PAY_SUCCESS`	Payment succeeded
`PAY_ERROR`	Payment error
`PAY_CLOSE`	Order closed by merchant or timed out

data Field Reference

Field	Type	Description
`merchantTradeNo`	string	Merchant trade number
`productType`	string	`goodsType` at order creation
`productName`	string	`goodsName` at order creation
`tradeType`	string	`terminalType` at order creation
`goodsName`	string	Goods name
`terminalType`	string	Terminal type
`currency`	string	Order currency
`orderAmount`	string	Order amount (payment amount when Gate Pay succeeds)
`totalFee`	string	Order amount (may appear together with `orderAmount`)
`expectCurrency`	string	Merchant expected settlement currency
`actualCurrency`	string	Actual settlement currency
`actualAmount`	string	Amount in `actualCurrency`
`payerId`	int64	Payer UID
`createTime`	int64	Order creation time (milliseconds)
`transactionId`	string	Platform transaction ID (may be omitted in some callbacks)
`channelId`	string	Customer name / channel identifier
`doneAmountOnChain`	string	On-chain confirmed amount
`waitAmountOnChain`	string	On-chain amount awaiting confirmation

Callback Example

Payment success (`bizStatus=PAY_SUCCESS`)

{
  "bizType": "PAY",
  "bizId": "79553572569350157",
  "bizStatus": "PAY_SUCCESS",
  "data": "{\"channelId\":\"\",\"createTime\":1780037371613,\"currency\":\"USDT\",\"doneAmountOnChain\":\"0\",\"goodsName\":\"KM/ORDER-63FDE37F - PUBG Mobile UC Global ( Special Offer ) - PUBG 1800 UC x 1\",\"merchantTradeNo\":\"6a1936fb6ac6f72b7a817576\",\"orderAmount\":\"21.88\",\"payerId\":16839589,\"productName\":\"KM/ORDER-63FDE37F - PUBG Mobile UC Global ( Special Offer ) - PUBG 1800 UC x 1\",\"productType\":\"\",\"terminalType\":\"WEB\",\"tradeType\":\"WEB\",\"waitAmountOnChain\":\"0\"}"
}

Order closed (`bizStatus=PAY_CLOSE`)

{
  "bizType": "PAY",
  "bizId": "79553572569350157",
  "bizStatus": "PAY_CLOSE",
  "data": "{\"channelId\":\"\",\"createTime\":1780037371613,\"currency\":\"USDT\",\"doneAmountOnChain\":\"0\",\"goodsName\":\"KM/ORDER-63FDE37F\",\"merchantTradeNo\":\"6a1936fb6ac6f72b7a817576\",\"orderAmount\":\"21.88\",\"payerId\":0,\"productName\":\"KM/ORDER-63FDE37F\",\"productType\":\"\",\"terminalType\":\"WEB\",\"tradeType\":\"WEB\",\"waitAmountOnChain\":\"0\"}"
}

Payment error (`bizStatus=PAY_ERROR`)

{
  "bizType": "PAY",
  "bizId": "79553572569350157",
  "bizStatus": "PAY_ERROR",
  "data": "{\"channelId\":\"\",\"createTime\":1780037371613,\"currency\":\"USDT\",\"doneAmountOnChain\":\"0\",\"goodsName\":\"KM/ORDER-63FDE37F\",\"merchantTradeNo\":\"6a1936fb6ac6f72b7a817576\",\"orderAmount\":\"21.88\",\"payerId\":16839589,\"productName\":\"KM/ORDER-63FDE37F\",\"productType\":\"\",\"terminalType\":\"WEB\",\"tradeType\":\"WEB\",\"waitAmountOnChain\":\"0\"}"
}

Body

application/json

bizType

enum<string>

required

Business type; always PAY (non-address payment order status change).

Available options:

PAY

bizId

string

required

Prepaid order ID.

bizStatus

enum<string>

required

Order status: PAY_SUCCESS payment succeeded; PAY_CLOSE timed out or closed; PAY_ERROR payment error.

Available options:

PAY_SUCCESS,

PAY_ERROR,

PAY_CLOSE

data

string

required

Order data as a JSON string; parsed structure see gatePaymentData.

client_id

string

Merchant client_id that created the order.

gatePaymentData

object

Parsed order details from data. For non-address payments, use orderAmount to determine the paid amount.

Show child attributes

description

any

Response

200 - application/json

HTTP 200 indicates the merchant successfully received the notification.

Response body returned by the merchant after receiving the notification.

returnCode

string

required

Return status code; SUCCESS indicates success.

returnMessage

string | null

Return message; may be empty on success.

Fixed Address Payment Status Notification

Fiat Payment Status Notification

⌘I

Documentation Index

​Overview

​Notes

​Trigger Scenarios

​Message Structure

​Example Message

​bizStatus Enumeration

​data Field Reference

​Callback Example

​Payment success (bizStatus=PAY_SUCCESS)

​Order closed (bizStatus=PAY_CLOSE)

​Payment error (bizStatus=PAY_ERROR)

Body

Response

Overview

Notes

Trigger Scenarios

Message Structure

Example Message

bizStatus Enumeration

data Field Reference

Callback Example

Payment success (`bizStatus=PAY_SUCCESS`)

Order closed (`bizStatus=PAY_CLOSE`)

Payment error (`bizStatus=PAY_ERROR`)