Batch Transfer Status Notification

{
  "bizType": "PAY_BATCH",
  "bizId": "79553020665790540",
  "bizStatus": "PAID",
  "data": "{\"batchItemList\":[{\"amount\":\"0.12300000\",\"channel_id\":\"\",\"create_time\":1780017207390,\"currency\":\"USDT\",\"receiver_id\":22112573,\"status\":\"PAID\"}],\"merchant_batch_no\":\"K4t1ijqX1LYRYmlp\"}"
}

{
  "returnCode": "SUCCESS",
  "returnMessage": ""
}

WEBHOOK

batchTransferWebhook

{
  "bizType": "PAY_BATCH",
  "bizId": "79553020665790540",
  "bizStatus": "PAID",
  "data": "{\"batchItemList\":[{\"amount\":\"0.12300000\",\"channel_id\":\"\",\"create_time\":1780017207390,\"currency\":\"USDT\",\"receiver_id\":22112573,\"status\":\"PAID\"}],\"merchant_batch_no\":\"K4t1ijqX1LYRYmlp\"}"
}

{
  "returnCode": "SUCCESS",
  "returnMessage": ""
}

Overview

This page documents webhook batchTransferWebhook. The full schema, parameters, and examples are rendered from the linked OpenAPI or webhook definition above. GatePay sends asynchronous notifications to the merchant callback URL when batch transfer order status changes (bizType is PAY_BATCH).

Notes

Use merchant_batch_no or bizId for idempotency.
Signature verification, retries, parsing data, and the success response are covered in Notifications Overview; see Security and Signature for signing rules.

Trigger Scenarios

When a batch transfer order status changes, GatePay sends a notification to the callback URL configured at merchant registration
If delivery fails, see retry rules in Notifications Overview.

Scope: Batch transfer / batch reward orders (bizType is PAY_BATCH).

Message Structure

Field	Type	Description
`bizType`	string	Always `PAY_BATCH`
`bizId`	string	Batch order ID (may be an empty string; use actual payload)
`bizStatus`	string	Batch order status; see table below
`client_id`	string	Merchant `client_id` that created the order
`data`	string	Business payload as a JSON string

Example Message

{
  "bizType": "PAY_BATCH",
  "bizId": "79553020665790540",
  "bizStatus": "PAID",
  "data": "{\"batchItemList\":[{\"amount\":\"0.12300000\",\"channel_id\":\"\",\"create_time\":1780017207390,\"currency\":\"USDT\",\"receiver_id\":22112573,\"status\":\"PAID\"}],\"merchant_batch_no\":\"K4t1ijqX1LYRYmlp\"}"
}

bizStatus Enumeration

Value	Description
`PAID`	Batch transfer/reward order completed

data Field Reference

Field	Type	Description
`merchant_batch_no`	string	Merchant batch number
`batchItemList`	array	Batch transfer line items

batchItemList Item Fields

Field	Type	Description
`amount`	string	Line item amount
`channel_id`	string	Customer name / channel identifier
`create_time`	int64	Creation time (milliseconds)
`currency`	string	Currency
`receiver_id`	int64	Receiver UID
`status`	string	Line item status, for example `PAID`

Callback Example

Batch transfer completed (`bizStatus=PAID`)

{
  "bizType": "PAY_BATCH",
  "bizId": "79553020665790540",
  "bizStatus": "PAID",
  "data": "{\"batchItemList\":[{\"amount\":\"0.12300000\",\"channel_id\":\"\",\"create_time\":1780017207390,\"currency\":\"USDT\",\"receiver_id\":22112573,\"status\":\"PAID\"}],\"merchant_batch_no\":\"K4t1ijqX1LYRYmlp\"}"
}

Body

application/json

bizType

enum<string>

required

Business type; always PAY_BATCH.

Available options:

PAY_BATCH

bizId

string

required

Batch order ID.

bizStatus

enum<string>

required

Batch order status; commonly PAID when transfer/reward completes.

Available options:

PAID

data

string

required

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

client_id

string

Merchant client_id that created the order.

batchTransferData

object

Parsed batch transfer details from data.

Show child attributes

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.

Fiat Payment Status Notification

Gift Card Payment Status Notification

⌘I

Documentation Index

​Overview

​Notes

​Trigger Scenarios

​Message Structure

​Example Message

​bizStatus Enumeration

​data Field Reference

​batchItemList Item Fields

​Callback Example

​Batch transfer completed (bizStatus=PAID)

Body

Response

Overview

Notes

Trigger Scenarios

Message Structure

Example Message

bizStatus Enumeration

data Field Reference

batchItemList Item Fields

Callback Example

Batch transfer completed (`bizStatus=PAID`)