Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
This document describes the webhook notification system for recurring payments (subscriptions), including token creation, subscription status changes, and billing result notifications.
| Field | Description |
|---|---|
notify_type | Notification type: subscription. |
subscription_id | Subscription identifier. |
state | Current state, such as ACTIVE, COMPLETED, or INCOMPLETE. |
sysdtm | System timestamp. |
{
"state": "COMPLETED",
"sysdtm": "2024-04-24 15:19:39",
"notify_type": "subscription",
"subscription_id": "sub_e51bb914919*****f6b0fe36d"
}
| Field | Description |
|---|---|
notify_type | Value: subscription_payment. |
subscription_id | Subscription ID. |
subscription_order_id | Format: sub_ord_{subscription_id}_{0001}. |
respcd | Response code. 0000 indicates success. |
respmsg | Response message. |
syssn | System transaction ID. |
txdtm | Transaction timestamp. |
txamt | Transaction amount. |
txcurrcd | Currency. |
customer_id | Customer ID. |
product_id | Product ID or IDs. |
cardcd | Masked card number. |
card_scheme | Card scheme, when present. |
current_iteration | Billing iteration number. |
{
"txcurrcd": "HKD",
"reason": "AUTHORISED",
"subscription_order_id": "sub_ord_a360f06eb*****ad6aff24c3a",
"product_id": "prod_8c838c17ddb043b9***11f1a85c30",
"txdtm": "2024-04-24 15:19:37",
"txamt": "300",
"card_scheme": "VISA_DEBIT-SSL",
"syssn": "20240424180500020000015704",
"respcd": "0000",
"subscription_id": "sub_e51bb914919***31d800f6b0fe36d",
"customer_id": "cust_a9c0bcf2717f4***786a10e5f8f2",
"notify_type": "subscription_payment",
"current_iteration": "1"
}
Was this page helpful?