Webhook Event Notification
When a relevant business event occurs, the system will push an event notification to your configured callback URL.
Header Name Description Content-Type application/json
Field Type Description eventId string Unique event ID (UUID) eventType string Event type, refer to the Event Type List below data string Event data JSON string (serialized data object; parse with JSON.parse before use) sign string Signature used to verify the message source: HmacSHA256(data, secret)
Compute the HmacSHA256 hash of the raw data string using your merchant secret (secret). If the result matches the sign field, the verification passes.
sign = HmacSHA256(data_string, merchant_secret)
Note: data is the raw JSON string representation of the event data object. Both signature verification and parsing must be based on this raw string.
eventType Description card.create Virtual card creation result card.recharge Virtual card recharge result card.withdraw Virtual card withdrawal / refund result card.cancel Virtual card cancellation result card.activation Physical card activation result
Virtual card creation is an asynchronous operation. The creation result is notified via this Webhook.
Field Type Description cardId string Virtual card ID amount number Card issuance amount (in cents, e.g., 1000 = $10.00) orderNo string Merchant custom transaction order number status string Creation result: SUCCESS / FAIL
JSON
{
"eventId": "b2c3d4e5-2222-3333-4444-bbccddeeff00",
"eventType": "card.create",
"data": "{\"cardId\":\"XXXXX\",\"amount\":1000,\"orderNo\":\"XXX\",\"status\":\"SUCCESS\"}",
"sign": "7f4c2d9b1a3e8f0c5XXXc3d9b2a0e5f1c8d3b7a4e2f6c0d9b1a5e3f7"
}Field Type Description cardId string Virtual card ID orderNo string Merchant custom transaction order number amount number Recharge amount for this transaction (in cents, e.g., 1000 = $10.00) status string Recharge result: SUCCESS / FAIL
JSON
{
"eventId": "c3d4e5f6-3333-4444-5555-ccddeeff0011",
"eventType": "card.recharge",
"data": "{\"cardId\":\"XXXXX\",\"orderNo\":\"XXX\",\"amount\":1000,\"status\":\"SUCCESS\"}",
"sign": "2a0e5f1c8d3b7a4e9f6c2XXX8b2a6e0f3c9d1b4a7e2f5c8d0b3a6"
}Field Type Description cardId string Virtual card ID orderNo string Merchant custom transaction order number amount number Withdrawal amount for this transaction (in cents, e.g., 1000 = $10.00) status string Withdrawal result: SUCCESS / FAIL
JSON
{
"eventId": "d4e5f6a7-4444-5555-6666-ddeeff001122",
"eventType": "card.withdraw",
"data": "{\"cardId\":\"XXXX\",\"orderNo\":\"XXXXX\",\"amount\":1000,\"status\":\"SUCCESS\"}",
"sign": "9d1b4a7e2f5c8d0b3a6e1f4c7XXXX4b7a2e5f9c0d3b6a1e4f7c2d5"
}Field Type Description cardId string Virtual card ID orderNo string Merchant custom transaction order number status string Cancellation result: SUCCESS
JSON
{
"eventId": "e5f6a7b8-5555-6666-7777-eeff00112233",
"eventType": "card.cancel",
"data": "{\"cardId\":\"XXXX\",\"orderNo\":\"XXXXX\",\"status\":\"SUCCESS\"}",
"sign": "1e4f7c2d5b0a3e8f1c4d7b2XXXXX4e7f2c5d8b0a3e6f1c4d7b2a5e8"
}
After a physical card is successfully bound, the system automatically completes the PIN setting, activation code retrieval, and activation workflow. The activation result is notified via this Webhook.
Field Type Description cardId string Virtual card ID orderNo string Merchant custom transaction order number status string Activation result: SUCCESS / FAIL
JSON
{
"eventId": "f6a7b8c9-6666-7777-8888-ff0011223344",
"eventType": "card.activation",
"data": "{\"cardId\":\"XXXXX\",\"orderNo\":\"XXXX\",\"status\":\"SUCCESS\"}",
"sign": "3c9d1b4a7e2f5c8d0b3a6e1f4c7d2b5XXXXe5f9c0d3b6a1e4f7c2d"
}
The data field is a JSON-serialized string of the event data object. It must be deserialized (e.g., JSON.parse) before usage upon receipt.
All monetary amounts are uniformly measured in cents (e.g., 1000 = $10.00).
