Payout
Reward Distribution Notification
After all sub-orders in a reward distribution batch are paid successfully, GatePay sends a webhook with bizType PAY_BATCH.
Verify the signature and return {"returnCode":"SUCCESS","returnMessage":""} after successful processing. On delivery failure, GatePay retries at the intervals documented in Notifications Overview.
WEBHOOK
Overview
This page documents asynchronous order-status notifications for reward distribution, corresponding towebhook batchTransferWebhook.
GatePay sends this notification to the merchant callback URL after all sub-orders in the batch are paid successfully.
The notification uses the standard notification envelope:
bizTypeis alwaysPAY_BATCHbizIdis the batch order IDbizStatusis the batch order status; it isPAIDwhen the payout succeedsdatais a JSON string
Notes
- Signature verification, retries, and success response: Notifications Overview.
- Signing rules: Security and Signature.
- Prefer idempotency on
merchant_batch_no+reward_id. - If a notification is delayed, call Merchant batch transfer order query for reconciliation.
Trigger scenarios
Reward-distribution notifications are sent only when the entire batch is paid successfully. In this case,bizStatus and each sub-order status are PAID.
Message structure
Example message
data fields
After parsing data, the object fields are:
batchItemList item fields
Callback example
Reward distribution batch success
Integration tips
- Verify the signature before parsing the body.
- Deserialize
dataas JSON, then readmerchant_batch_noandbatchItemList. - Identify the batch with
merchant_batch_noand each reward withreward_id. - Treat each item’s
statusas the actual payout result. - After successful handling, return HTTP 200 with the standard success body:
Body
application/json
Business type; always PAY_BATCH.
Available options:
PAY_BATCH Batch order ID.
Batch order status; PAID when the payout succeeds.
Available options:
PAID Business data as a JSON string; parsed structure see batchTransferData.
Parsed reward distribution details from data.
Response
200 - application/json
HTTP 200 indicates the merchant successfully received the notification.