Card

1.Push events

EventRepeatDescribe
CC_CONSUMEyescard consume
CC_REFUNDyescard refund
CC_WITHDRAW_CASHyesCard withdrawal
CC_REDEEMyesCard redemption
CC_RECHARGEyesCard recharge/collateral(Notification after successful recharge/collateral using API recharge card)
3DS_OTPyes3D Secure Verification Code
3DS_CONFIRMyes3DS Confirmation Code
CR_RECHARGEyesNotification of successful submission of card recharge application(Used only in IFrame scenarios)
CA_APPLYyesCard application submission successful notification
NE_VERIFYyesVerification notification
KS_KYCyesKYC Verification(Notification of approval or rejection after submitting KYC certification)
CSC_STATUS_CHANGEyesCard status change(Notifications when card status changes, such as notifications when activating, locking, or unlocking a card using the API)
MF_MATERIAL_FLOWyesCard delivery logistics notice(Notification after successful card delivery)
CS_APPROVEDyesCard activation success notification(Notification after successful card registration submission and registration. Each card will only be notified once.)
CE_EVENTCard event notification (triggered when card is frozen or unfrozen)

2.Global push format

ParameterTypeRequiredDescribe
eventStringtrueEvent name
traceStringtrueLink ID, the same link ID for the same transaction
orderNoStringtrueOrder number, globally unique
timestampLongtruePush timestamp (milliseconds)
detailObjectThe format of push content varies depending on the event

2.1.Card transaction push format

Including card consumption, card refund, card withdrawal, card redemption, card recharge/mortgage

ParameterTypeRequiredDescribe
cardIdStringtrueCard unique ID
cardNumberStringtrueCard number
orderNoStringtrueOrder Number
customerNoStringtrueCustomer number
typeinttrueTransaction type (1=Recharge/Collateral, 2=consumption, 3=refund, 4=Cash Withdrawal, 5=redemption, 6=management fee)
statusinttrueTransaction status (1=Success, 2=Failed, 3=Processing, 4=Posted, 5=Unposted, 7=Canceled)
amountBigDecimaltrueTransaction amount
directioninttrueIncome and expenditure direction(1=Income, 2=Expenditure)
merchantNameStringfalseMerchant name
currencyStringtrueTransaction currency
transactionAtLongtrueTransaction time
transactionIdStringtrueTransaction ID,The TransactionID of the same transaction is consistent
originalAmountBigDecimalfalseOriginal transaction amount
originalCurrencyStringfalseOriginal transaction currency
reasonStringfalseCause of failure
feeBigDecimalfalseTransaction fees
thirdOrderNoStringfalseThird party order number (valid for card recharge/mortgage)
merchantMccStringfalseMCC
merchantCategoryStringfalseMerchant category
merchantCountryStringfalseMerchant country

2.2. 3DS OTP Data Webhook Format

ParameterTypeRequiredDescribe
cardIdStringtrueCard unique ID
cardNumberStringtrueCard number
customerNoStringtrueCustomer number
3dsCodeStringtrue3DS Code
orderNoStringtrueOrder Number

2.3. 3DS Confirm Data Webhook Format

ParameterTypeRequiredDescribe
cardIdStringtrueCard unique ID
cardNumberStringtrueCard number
customerNoStringtrueCustomer number
typeStringtrue3DS confirmation type (code / link)
validateCodeStringfalse3DS verification code, valid when type=code
urlStringfalse3DS confirms link, valid when type=link
merchantsStringtrueMerchant Name
transactionTimeLongtrueTrading hours
amountBigDecimaltrueTransaction amount
transactionCurrencyStringtrueTrading currency

2.4. Card application submission successful notification push format(Used only in IFrame scenarios)

ParameterTypeRequiredDescribe
cardIdStringtrueCard ID
orderNoStringtrueOrder Number
customerNoStringtrueCustomer number
amountBigDecimaltrueActual payment amount
statusIntegertruePayment Status (1: Paid 2: Pending Payment)
subscribeAtLongtrueSubscribe time

2.5. Push notification format for successful recharge application submission(Used only in IFrame scenarios)

ParameterTypeRequiredDescribe
cardIdStringtrueCard unique ID
orderNoStringtrueOrder Number
customerNoStringtrueCustomer number
cardNumberStringtrueCard Number
amountBigDecimaltrueActual payment amount
statusIntegertruePayment Status (8: Pending Payment)
subscribeAtLongtrueSubscribe time

2.6. Verification notification push format

ParameterTypeRequiredDescribe
cardIdStringtrueCard unique ID
orderNoStringtrueOrder Number
codeStringtrueVerification Code
cardNumberStringtrueCard Number
typeStringtrueType (see 2.7 Verification Notification Type)
customerNoStringtrueCustomer Number

2.7. Verification notification type

ParameterDescribe
3DS_CONFIRM_LINK3DS Confirmation Link
3DS_VERIFICATION_CODE3D Secure Verification Code
CARD_ACTIVATIONCard Activation
LOCK_UNLOCK_CARDCard lock/unlock
TX_WDR_PWD_MODIFYModify transaction (cash withdrawal) password
TX_WDR_PWD_SETSet transaction (cash withdrawal) password
CAT_CARDView Card

2.8. Kyc notification push format

ParameterTypeRequiredDescribe
customerNoStringyesCustomer
documentTypeStringyesnumberDocument type (1:Id Card 2.Passport 3.Selfie)
statusStringyesStatus(1=Approved,2=Rejected,3=Pending,4=Unverified) Only push 1, 2 final status

2.9. Card status change notification push format

ParameterTypeRequiredDescribe
cardIdStringyesCard unique ID
cardNumberStringyesCard number
statusStringyesStatus (1=Normal, 2=Pending Activation, 3=Frozen, 4=Locked, 5=Deactivated, 6=Applying, 7=Activating, 8=Locking, 9=Unlocking, 10=Deactivating,13=Rejected,14=Cancelled,15=Replacing,16=Replaced).Only push change data with statuses 1, 2, 3, 4, 5, 13, and 14
orderNoStringyesOrder no
customerNoStringyesCustomer no

2.10. Card delivery logistics notification push format

ParameterTypeRequiredDescribe
dispatchTimeStringyesDelivery time
logisticsOrderNoStringyesLogistics tracking number
logisticsCompanyNameStringyesLogistics Company Name
recipientAddressStringyesShipping address
logisticsImageStringyesLogistics photos
cardIdStringyesCard unique ID

2.11. Format of push notification for successful card activation

ParameterTypeRequiredDescribe
orderNoStringyesOrder number
cardIdStringyesCard unique ID
cardNumberStringyesCard number
customerNoStringyesCustomer number
cardStatusIntegeryesCard status(1=Normal)

2.12. Card event notification push format

ParameterTypeRequiredDescribe
cardIdStringyesCard unique ID
eventStringyesEvent type (Frozen/Unfrozen)