Card

1.Push events

EventRepeatDescribe
CC_CONSUMEyescard consume
CC_REFUNDyescard refund
CC_WITHDRAW_CASHyesCard withdrawal
CC_REDEEMyesCard redemption
CC_RECHARGEyesCard recharge/mortgage
3DS_OTPyes3D Secure Verification Code
3DS_CONFIRMyes3DS Confirmation Code
CR_RECHARGEyesNotification of successful submission of card recharge application
CA_APPLYyesCard application submission successful notification
NE_VERIFYyesVerification notification
KS_KYCyesKYC Verification
CSC_STATUS_CHANGEyesCard status change
MF_MATERIAL_FLOWyesCard delivery logistics notice
CS_APPROVEDyesCard activation success notification

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 ID
cardNumberStringtrueCard number
orderNoStringtrueOrder Number
customerNoStringtrueCustomer number
typeinttrueTransaction type (1=recharge/mortgage, 2=consumption, 3=refund, 4=withdrawal, 5=redemption, 6=management fee)
statusinttrueTransaction status (1=successful, 2=failed, 3=processing, 4=credited, 5=not credited, 6=payment failed, 7=canceled)
amountBigDecimaltrueTransaction amount
directioninttrueIncome and expenditure direction
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

2.2. 3DS Data Webhook Format

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

2.3. 3DS Confirm Data Webhook Format

ParameterTypeRequiredDescribe
cardIdStringtrueCard ID
cardNumberStringtrueCard number
customerNoStringtrueCustomer number
validateCodeStringtrue3DS Confirm validate code
merchantsStringtrueMerchant Name
transactionTimeLongtrueTrading hours
amountBigDecimaltrueTransaction amount
transactionCurrencyStringtrueTrading currency

2.4. Card application submission successful notification push format

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

ParameterTypeRequiredDescribe
cardIdStringtrueCard 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 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 no
documentTypeStringyesdocument type (1:id card 2:passport 3:living)
statusStringyesstatus(1:pass 2:refuse 3:procesing 4:none) Only push 1, 2 final status

2.9. Card status change notification push format

ParameterTypeRequiredDescribe
cardIdStringyescard id
cardNumberStringyescard number
statusStringyesstatus (1=Normal, 2=To be activated, 3=Frozen, 4=Locked card, 5=Destroyed, 6=Under application, 7=Activating, 8=Locking card, 9=Unlocking, 10=Destroying,13=Rejected,14=Cancelled,15=Replacing,16=Replaced) Only push 1:Normal 2:To be activated 3:Frozen 4:Locked 5:Destroyed 13:Rejected 14:Cancelled final status
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 ID

2.11. Format of push notification for successful card activation

ParameterTypeRequiredDescribe
orderNoStringyesOrder number
cardIdStringyesCard ID
cardNumberStringyesCard number
customerNoStringyesCustomer number
cardStatusIntegeryesCard status