Gift Card Payment Status Notification

Overview

This page documents webhook giftCardPaymentWebhook. 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 gift-card payment order status changes (bizType is PAY_GIFT_BATCH).

Notes

Use externalId 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 gift-card payment 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 gift-card payment orders (bizType is PAY_GIFT_BATCH). For gift-card integration, see Gift Card.

Message Structure

Field	Type	Description
`bizType`	string	Always `PAY_GIFT_BATCH`
`bizId`	string	Batch gift-card order ID (may be an empty string; use actual payload)
`bizStatus`	string	Batch gift-card 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_GIFT_BATCH",
  "bizId": "",
  "bizStatus": "PAID",
  "data": "{\"batchItemList\":[],\"externalId\":\"\"}"
}

bizStatus Enumeration

Value	Description
`PAID`	Batch gift-card payment/issuance completed

data Field Reference

Field	Type	Description
`externalId`	string	Merchant external order ID
`batchItemList`	array	Batch gift-card 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 gift-card payment completed (`bizStatus=PAID`)

{
  "bizType": "PAY_GIFT_BATCH",
  "bizId": "",
  "bizStatus": "PAID",
  "data": "{\"batchItemList\":[],\"externalId\":\"\"}"
}

Batch gift-card payment completed (with batchItemList)

{
  "bizType": "PAY_GIFT_BATCH",
  "bizId": "79553020665790541",
  "bizStatus": "PAID",
  "data": "{\"batchItemList\":[{\"amount\":\"10.00\",\"channel_id\":\"\",\"create_time\":1780017207390,\"currency\":\"USDT\",\"receiver_id\":22112573,\"status\":\"PAID\"}],\"externalId\":\"gift-order-20260329\"}"
}

Body

application/json

bizType

enum<string>

required

Business type; always PAY_GIFT_BATCH.

Available options:

PAY_GIFT_BATCH

bizId

string

required

Batch gift-card order ID.

bizStatus

enum<string>

required

Batch gift-card order status; commonly PAID when payment/issuance completes.

Available options:

PAID

data

string

required

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

client_id

string

Merchant client_id that created the order.

giftCardPaymentData

object

Parsed batch gift-card payment 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.

Documentation Index

​Overview

​Notes

​Trigger Scenarios

​Message Structure

​Example Message

​bizStatus Enumeration

​data Field Reference

​batchItemList Item Fields

​Callback Example

​Batch gift-card payment completed (bizStatus=PAID)

​Batch gift-card payment completed (with batchItemList)

Body

Response

Overview

Notes

Trigger Scenarios

Message Structure

Example Message

bizStatus Enumeration

data Field Reference

batchItemList Item Fields

Callback Example

Batch gift-card payment completed (`bizStatus=PAID`)

Batch gift-card payment completed (with batchItemList)