Skip to main content
WEBHOOK

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

Example Message

bizType Enumeration

For risky address notifications (FIXED_ADDRESS_RISK), see Fixed Address Risk Notification.

bizStatus Enumeration

data Field Reference

Parsed data fields:

Callback Example

Payment success (bizStatus=PAY_SUCCESS)

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.

Available options:
PAY_SUCCESS
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.