Skip to main content
WEBHOOK
fixedAddressPaymentWebhook
{
  "bizType": "PAY_FIXED_ADDRESS",
  "bizId": "79553757252681728",
  "bizStatus": "PAY_SUCCESS",
  "data": "{\"address\":\"THGthEF4kxhk6STPSUsQcYsUk3FiHX6FKR\",\"amount\":\"498.7\",\"chain\":\"TRX\",\"channel_id\":\"1956171254260887553\",\"createTime\":1780037680066,\"currency\":\"USDT\",\"fromAddress\":\"TNXoiAJ3dct8Fjg4M9fkLFh9S2v9TXc32G\",\"orderAmount\":\"498.7\",\"transactionId\":\"79553757252681730\",\"transactionTime\":1780037680066,\"txHash\":\"6711f98a10b9efdcfd35a281fd53554736e100441902ef1d24ee2fb5bb75f15a\"}"
}
{
  "returnCode": "SUCCESS",
  "returnMessage": ""
}

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 documents webhook fixedAddressPaymentWebhook. The full schema, parameters, and examples are rendered from the linked OpenAPI or webhook definition above. GatePay sends asynchronous notifications to the address callback URL when funds are credited to a static collection address (bizType is PAY_FIXED_ADDRESS).

​
Notes

​
Trigger Scenarios

  • When the merchant-bound collection address receives funds, and the collection network and received currency are within the merchant’s revenue scope

​
Message Structure

FieldTypeDescription
bizTypestringMessage type; always PAY_FIXED_ADDRESS
bizIdstringOrder ID
bizStatusstringBusiness status; see table below
datastringBill details as a JSON string

​
Example Message

{
  "bizType": "PAY_FIXED_ADDRESS",
  "bizId": "79553757252681728",
  "bizStatus": "PAY_SUCCESS",
  "data": "{\"address\":\"THGthEF4kxhk6STPSUsQcYsUk3FiHX6FKR\",\"amount\":\"498.7\",\"chain\":\"TRX\",\"channel_id\":\"1956171254260887553\",\"createTime\":1780037680066,\"currency\":\"USDT\",\"fromAddress\":\"TNXoiAJ3dct8Fjg4M9fkLFh9S2v9TXc32G\",\"orderAmount\":\"498.7\",\"transactionId\":\"79553757252681730\",\"transactionTime\":1780037680066,\"txHash\":\"6711f98a10b9efdcfd35a281fd53554736e100441902ef1d24ee2fb5bb75f15a\"}"
}

​
bizType Enumeration

ValueDescription
PAY_FIXED_ADDRESSStatic collection address payment notification
For risky address notifications (FIXED_ADDRESS_RISK), see Fixed Address Risk Notification.

​
bizStatus Enumeration

ValueDescription
PAY_SUCCESSPayment successful and funds credited
PAY_BLOCKFunds received by Gate but held due to risk; not credited

​
data Field Reference

Parsed data fields:
FieldTypeDescription
channel_idstringCustomer name / channel identifier (snake_case; use actual payload)
currencystringBill currency
orderAmountstringBill amount
createTimeint64Bill creation time (milliseconds)
transactionIdstringTransaction ID
transactionTimeint64Bill settlement time (milliseconds)
chainstringBlockchain network
addressstringCollection address
amountstringCredited amount
fromAddressstringPayer address
txHashstringOn-chain transaction hash

​
Callback Example

​
Payment success (bizStatus=PAY_SUCCESS)

{
  "bizType": "PAY_FIXED_ADDRESS",
  "bizId": "79553757252681728",
  "bizStatus": "PAY_SUCCESS",
  "data": "{\"address\":\"THGthEF4kxhk6STPSUsQcYsUk3FiHX6FKR\",\"amount\":\"498.7\",\"chain\":\"TRX\",\"channel_id\":\"1956171254260887553\",\"createTime\":1780037680066,\"currency\":\"USDT\",\"fromAddress\":\"TNXoiAJ3dct8Fjg4M9fkLFh9S2v9TXc32G\",\"orderAmount\":\"498.7\",\"transactionId\":\"79553757252681730\",\"transactionTime\":1780037680066,\"txHash\":\"6711f98a10b9efdcfd35a281fd53554736e100441902ef1d24ee2fb5bb75f15a\"}"
}

​
Risk block (bizStatus=PAY_BLOCK)

When Gate receives funds but blocks crediting due to risk control: 
{
  "bizType": "PAY_FIXED_ADDRESS",
  "bizId": "79553757252681729",
  "bizStatus": "PAY_BLOCK",
  "data": "{\"address\":\"THGthEF4kxhk6STPSUsQcYsUk3FiHX6FKR\",\"amount\":\"498.7\",\"chain\":\"TRX\",\"channel_id\":\"1956171254260887553\",\"createTime\":1780037680066,\"currency\":\"USDT\",\"fromAddress\":\"TNXoiAJ3dct8Fjg4M9fkLFh9S2v9TXc32G\",\"orderAmount\":\"498.7\",\"transactionId\":\"79553757252681731\",\"transactionTime\":1780037680066,\"txHash\":\"6711f98a10b9efdcfd35a281fd53554736e100441902ef1d24ee2fb5bb75f15a\"}"
}
For static collection address APIs, see static collection address.

Body

application/json
​
bizType
enum<string>
required

Business type; always PAY_FIXED_ADDRESS.

Available options:
PAY_FIXED_ADDRESS
​
bizId
string
required

Order ID.

​
bizStatus
enum<string>
required

Business status: PAY_SUCCESS payment successful and credited; PAY_BLOCK funds received by Gate but held due to risk and not credited.

Available options:
PAY_SUCCESS,
PAY_BLOCK
​
data
string
required

Business data as a JSON string; parsed structure see fixedAddressPaymentData.

​
fixedAddressPaymentData
object

Parsed bill details from data.

​
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.