Consumption record callback

Brief Description

Card transaction webhook configuration and usage:

  • Please contact staff to configure your Webhook Endpoint Url on the backend The URL must be HTTPS
  • When there are card transactions such as purchases/refunds/chargebacks the corresponding transaction messages will be pushed to your Webhook Endpoint Url
  • Upon receiving the Webhook message if you return HTTP CODE 200 it signifies successful receipt of the webhook message otherwise it will retry

Return Parameters Description

Parameter

Type

Description

eventType

string

Webhook event type

eventId

string

Webhook event ID

webhookSubscribeId

string

Webhook subscription ID

+data

object

Returned event object data

└transactionId

string

Unique transaction ID for each transaction

└userId

string

User ID

└cardId

string

Virtual card ID

└cardCustomerId

string

Custom customer ID

└cardNumber

string

Card number

└cardSeqNo

string

Card sequence number

└desp

string

Transaction description information

└reason

string

Chargeback reason

└preAuthAmount

integer

Pre-authorization amount (may differ from final transaction amount)

└preAuthCurrency

string

Pre-authorization currency USD

└preAuthTime

timestamp

Pre-authorization time

└transactionAmount

integer

Transaction amount

└transactionCurrency

string

Transaction currency USD

└transactionTime

timestamp

Transaction time

└status

string

Transaction status:
PENDING: Transaction authorization pending
EXPIRED: Authorization expired
REVERSED: Authorization reversed (eg refund for pre-authorized card)
DECLINED: Chargeback
COMPLETE: Transaction completed
REFUND: Transaction refunded

└gmtCreate

timestamp

Record creation time

└gmtModified

integer

Record update time

Return Examples

  • PENDING Example

{
eventType: TRANSACTION
eventId: ev_xxxxxxxxxxxxxxxxxxxxx
webhookSubscribeId: wsb_xxxxxxxxxxxxxxxxxxx
data: {
transactionId: t_xxxxxxxxxxxxx
userId: u_xxxxxxxxxxx
cardId: c_xxxxxxxxxxx
cardCustomerId:
cardNumber: 556735XXXXXX0737
cardSeqNo: CXXXXXXX
desp: FACEBK UYFYREF3S2 fbme/ads IRL
reason: null
preAuthAmount: -1992
preAuthCurrency: USD
preAuthTime: 1652262674000
transactionAmount: null
transactionCurrency: null
transactionTime: null
status: PENDING
gmtCreate: 1652262674000
gmtModified: 1652262674000
}
}

  • EXPIRED Example

{
eventType: TRANSACTION
eventId: ev_xxxxxxxxxxxxxxxxxxxxx
webhookSubscribeId: wsb_xxxxxxxxxxxxxxxxxxx
data: {
transactionId: t_xxxxxxxxxxxxx
userId: u_xxxxxxxxxxx
cardId: c_xxxxxxxxxxx
cardCustomerId:
cardNumber: 556735XXXXXX0737
cardSeqNo: CXXXXXXX
desp: FACEBK UYFYREF3S2 fbme/ads IRL
reason: null
preAuthAmount: -1992
preAuthCurrency: USD
preAuthTime: 1652262674000
transactionAmount: null
transactionCurrency: null
transactionTime: null
status: EXPIRED
gmtCreate: 1652262674000
gmtModified: 1655562674000
}
}

  • REVERSED Example

{
eventType: TRANSACTION
eventId: ev_xxxxxxxxxxxxxxxxxxxxx
webhookSubscribeId: wsb_xxxxxxxxxxxxxxxxxxx
data: {
transactionId: t_xxxxxxxxxxxxx
userId: u_xxxxxxxxxxx
cardId: c_xxxxxxxxxxx
cardCustomerId:
cardNumber: 556735XXXXXX0737
cardSeqNo: CXXXXXXX
desp: FACEBK UYFYREF3S2 fbme/ads IRL
reason: null
preAuthAmount: -1992
preAuthCurrency: USD