Webhook APIs
Webhook Get Started
1 minutes, 2 minutes, 4 minutes, 8 minutes, 16 minutes
.Register a new webhook
setWebhookUrl
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | url | String | Y | Address for notification |
Request Body Example
{
"url":"https://notify.receive/api"
}
Request Message Example
{
"head": {
"apiCode": "setWebhookUrl",
"sysId": "202402271432298822660001",
"requestNo": "202412241536050554232157",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | encrypt | String | Y | Return values: SUCCESS FAILED |
2 | url | String | Y | Address for notification |
Request Message Example
{
"encrypt":"SUCCESS",
"url":"https://notify.receive/api"
}
Request Message Example
{
"head": {
"apiCode": "setWebhookUrl",
"sysId": "202402271432298822660001",
"requestNo": "202412241536050554232157",
"version": "1.0",
"code": "SUCCESS",
"detail": "SUCCESS",
"sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***",
"keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***"
},
"body":{
"encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
}
}
Query webhook
getWebhookUrl
Request Body Example
{
}
Request Message Example
{
"head": {
"apiCode": "getWebhookUrl",
"sysId": "202402271432298822660001",
"requestNo": "202412241536050554232157",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | encrypt | String | Y | Return values: SUCCESS FAILED |
2 | url | String | Y | Address for notification |
Request Message Example
{
"encrypt":"SUCCESS",
"url":"https://notify.receive/api"
}
Request Message Example
{
"head": {
"apiCode": "getWebhookUrl",
"sysId": "202402271432298822660001",
"requestNo": "202412241536050554232157",
"version": "1.0",
"code": "SUCCESS",
"detail": "SUCCESS",
"sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***",
"keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***"
},
"body":{
"encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
}
}
Delete webhook
deleteWebhookUrl
Request Body Example
{
}
Request Message Example
{
"head": {
"apiCode": "deleteWebhookUrl",
"sysId": "202402271432298822660001",
"requestNo": "202412241536050554232157",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | encrypt | String | Y | Return values: SUCCESS FAILED |
Request Message Example
{
"encrypt":"SUCCESS"
}
Request Message Example
{
"head": {
"apiCode": "deleteWebhookUrl",
"sysId": "202402271432298822660001",
"requestNo": "202412241536050554232157",
"version": "1.0",
"code": "SUCCESS",
"detail": "SUCCESS",
"sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***",
"keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***"
},
"body":{
"encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
}
}
Notify Details
1.TRANSACTION_VERIFICATION_CODE
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | cardID | String | Y | Card ID |
2 | time | String | Y | yyyy-MM-dd HH:mm:ss |
3 | code | String | Y | Transaction verification code |
{
"cardID":"19181",
"time":"2024-11-29 02:42:12",
"code":"549811"
}
{
"head":"",
"body":
{"encrypt":"SUCCESS"}
}
2.CARD_RECHARGE_RESULT
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | cardID | String | Y | Card ID |
2 | time | String | Y | yyyy-MM-dd HH:mm:ss |
3 | currency | String | Y | Recharge currency |
4 | amount | Double | Y | Recharge amount |
5 | status | String | Y | Result: SUCCESS / FAILED |
6 | transactionId | String | Y | Transaction ID |
7 | sendCurrency | String | Y | Card Currency |
8 | sendAmount | Double | Y | Actual Amount to Card |
{
"cardID":"19181",
"time":"2024-11-29 02:42:12",
"currency":"USD",
"amount":275.60,
"status":"SUCCESS",
"transactionId":"20241128102008673655",
"sendCurrency":"HKD",
"sendAmount":2147.76
}
{
"head":"",
"body":
{"encrypt":"SUCCESS "}
}
3.CARD_3DS_AUTH_RESULT
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | cardID | String | Y | Card ID |
2 | time | String | Y | yyyy-MM-dd HH:mm:ss |
3 | authId | String | Y | Auth Id |
4 | authResult | String | Y | Refer to Appendix Part 7 |
{
"cardID":"19181",
"time":"2024-11-29 02:42:12",
"authId":"CT3DSA1508634777354273",
"authResult":"AUTHORIZATION_CANCELED"
}
{
"head":"",
"body":
{"encrypt":"SUCCESS "}
}
4.USER_KYC_STATUS_CHANGE
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | String | Y | user submitted KYC email address | |
2 | time | String | Y | yyyy-MM-dd HH:mm:ss |
3 | status | String | Y | Refer to Appendix Part 6 |
4 | reason | String | Y | Reasons for KYC rejection |
{
"email":"1234@gmail.com",
"time":"2024-11-24 17:57:41",
"status":"PASSED",
"reason":""
}
{
"head":"",
"body":
{"encrypt":"SUCCESS "}
}
5.CARD_STATUS_CHANGE
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | cardID | String | Y | Card ID |
2 | status | String | Y | Refer to Appendix Part 2 |
3 | reason | String | Y |
{
"cardID":"19181",
"status":"ACTIVE",
"reason":""
}
{
"head":"",
"body":
{"encrypt":"SUCCESS "}
}
6.TRANSACTION_CREATED
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | cardID | String | Y | Card ID |
2 | transactionId | String | Y | Transaction ID |
3 | transactionTime | String | Y | yyyy-MM-dd HH:mm:ss |
4 | cardCurrency | String | Y | Card currency type |
5 | cardCurrencyAmt | Double | Y | Card currency trans Amount |
6 | transCurrency | String | Y | Transaction currency type |
7 | transCurrencyAmt | Double | Y | Transaction currency trans Amount |
8 | transStatus | String | Y | Transaction status |
9 | transType | String | Y | Transaction type |
10 | merchantName | String | Y | Merchant name |
11 | fee | Double | Y | Fee Amount |
12 | feeCurrency | String | Y | Fee currency |
13 | refundCurrency | String | C | Refund currency |
14 | refundAmount | Double | C | Refund amount |
15 | subList | List | C | Data collection |
subList[0].cardID | String | C | Card ID | |
subList[0].transactionId | String | C | Transaction ID | |
subList[0].transactionTime | String | C | yyyy-MM-dd HH:mm:ss | |
subList[0].cardCurrency | String | C | Card currency type | |
subList[0].cardCurrencyAmt | Double | C | Card currency trans Amount | |
subList[0].transCurrency | String | C | Transaction currency type | |
subList[0].transCurrencyAmt | Double | C | Transaction currency trans Amount | |
subList[0].feeCurrency | String | C | Currency of the transaction fee | |
subList[0].fee | Double | C | Transaction fee |
{
"cardCurrencyAmt": 359.71,
"fee": -9.74,
"feeCurrency": "HKD",
"transactionTime": "2025-03-24 21:37:12",
"transCurrency": "MYR",
"transactionId": "K202503123345",
"merchantName": "Shell",
"cardCurrency": "HKD",
"transType": "AUTH",
"cardID": "K-123456",
"refundCurrency": "HKD",
"transCurrencyAmt": 200,
"transStatus": "APPROVED",
"refundAmount": 185.86,
"subList": [
{
"transactionType": "AUTH",
"cardCurrency": "HKD",
"transactionCurrency": "MYR",
"transactionStatus": "CONFIRM",
"cardId": "K-123456",
"transactionAmount": 200,
"fee": 458,
"feeCurrency": "HKD",
"transactionDate": "2025-03-24 21:37:12",
"cardTransactionAmount": 359.71,
"transactionId": "K202503123345",
"transactionIdSub": "2025032421314789"
},
{
"transactionType": "CLEARING",
"cardCurrency": "HKD",
"transactionCurrency": "MYR",
"transactionStatus": "APPROVED",
"cardId": "K-123456",
"transactionAmount": 97.09,
"fee": 458,
"feeCurrency": "HKD",
"transactionDate": "2025-03-26 19:36:44",
"cardTransactionAmount": 173.85,
"transactionId": "K202503123345",
"transactionIdSub": "2025032421314790"
}
]
}
{
"head":"",
"body":
{"encrypt":"SUCCESS "}
}
7.CARD_ACTIVATION_CODE
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | cardNo | String | Y | Card number |
2 | activationCode | String | Y | activation code, can only be obtained once |
{
"cardNo":"4937240800070604",
"activationCode":"70795665"
}
{
"head":"",
"body":
{"encrypt":"SUCCESS "}
}
8.CARD_CLOSE_RESULT
No | Field | Type | Required | Notes |
---|---|---|---|---|
1 | cardID | String | Y | Card ID |
2 | closeStatus | String | Y | status(SUCCESS/FAILED) |
3 | transactionId | String | Y | Transaction ID |
4 | receiveAmount | Double | Y | Amount(default USD) |
{
"cardNo":"4937240800070604",
"closeStatus":"SUCCESS",
"transactionId":"1233456",
"receiveAmount":100
}
{
"head":"",
"body":
{"encrypt":"SUCCESS "}
}
Modified at 2025-06-13 08:45:22