Skip to main content
WEBHOOK

Overview

This page documents webhook fixedAddressRiskWebhook. The full schema, parameters, and examples are rendered from the linked OpenAPI or webhook definition above. When a merchant-bound static collection address is flagged as risky, GatePay sends an asynchronous notification to the callback URL configured for that address. The payload includes bizType (FIXED_ADDRESS_RISK), bizStatus (RISK_ADDRESS), and data (JSON string).

Notes

Trigger scenarios

  • GatePay sends a notification when a merchant-bound static collection address is flagged as risky (is_risk=1)
  • Stop collecting to that address locally after receiving the notification
  • If delivery fails, GatePay retries according to Notifications overview

Message Structure

Parsed data Fields

Callback Example

Body

application/json
bizType
enum<string>

Business type; always FIXED_ADDRESS_RISK.

Available options:
FIXED_ADDRESS_RISK
bizId
string

Business ID (for example a channel and network composite identifier; actual value is as returned).

bizStatus
enum<string>

Business status; always RISK_ADDRESS (risky address).

Available options:
RISK_ADDRESS
data
string

Risk address details as a JSON string; includes customer_name, address, etc. after parsing.

clientId
string

商户 client_id

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.