Skip to main content
WEBHOOK
fixedAddressRiskWebhook
{
  "bizType": "FIXED_ADDRESS_RISK",
  "bizId": "79547404996050989",
  "bizStatus": "RISK_ADDRESS",
  "clientId": "RLSfEKlmvLXYyAVX",
  "data": "{\"customer_name\":\"5418020260513\",\"address\":\"TT91qAWcHf2xRcev5U3DiQRQ5v3GKxt89E\"}"
}
{
  "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 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

FieldTypeDescription
bizTypestringAlways FIXED_ADDRESS_RISK
bizIdstringBusiness ID
bizStatusstringAlways RISK_ADDRESS
clientIdstringMerchant client_id
datastringRisk address details as a JSON string

​
Parsed data Fields

FieldTypeDescription
customer_namestringCustomer name / channel identifier
addressstringCollection address flagged as risky

​
Callback Example

{
  "bizType": "FIXED_ADDRESS_RISK",
  "bizId": "79547404996050989",
  "bizStatus": "RISK_ADDRESS",
  "clientId": "RLSfEKlmvLXYyAVX",
  "data": "{\"customer_name\":\"5418020260513\",\"address\":\"TT91qAWcHf2xRcev5U3DiQRQ5v3GKxt89E\"}"
}

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.