Webhook

Please provide the callback address from the merchant. Notification will be made after configuration in the merchant backend.

When the transaction has the final result, through webhook configuration, the development platform will send a transaction notification to the merchant. When the acceptance is unsuccessful or the sending fails, the transaction will be sent 7 times with a time interval of1m,5m,20m,1h,12h,24h.

Notification Template

Headers

Name
Value
describtion

Content-Type

application/json

Content Type

X-WSB-CATEGORY

${X-WSB-CATEGORY}

Business identifiers for different notification types

X-WSB-SIGNATURE

${signature}

signature

X-WSB-REQUEST-ID

${requestId}

A unique ID for each request

Card transaction notification

X-WSB-CATEGORY=card_transaction

Request Params

Click on the returned object Card Transaction records Interface to view the response data

Request Example

{
    "orderNo": "1852379830190366720",
    "merchantOrderNo": "T1852379826671345664",
    "cardNo": "23424290324234454242",
    "currency": "USD",
    "amount": "15",
    "fee": "0",
    "receivedAmount": "0",
    "receivedCurrency": "USD",
    "type": "create",
    "status": "success",
    "remark": null,
    "transactionTime": 1730476742000
}

Response

When the return structure is as shown below, the callback notification is successful

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": null
}

Card Authorization Transaction Notification

X-WSB-CATEGORY=card_auth_transaction The same transaction serial number may be pushed multiple times.

  1. The status may flow. For example, when type=auth, the first push status=authorized (authorized), after the authorization is successfully received, the status=succeed or other status will be pushed again.

  2. The settlement amount and other information will be pushed, and the amount may change. For example, crossBoardFee and settleAmount will change from 0 to a value.

Request Params

Click on the returned object Card Authorization Transaction Interface to view the response data

Response Example

{
    "cardNo": "1242352328671924231",
    "tradeNo": "trans1232435363435463432",
    "originTradeNo": null,
    "currency": "CNY",
    "amount": "16.96",
    "authorizedAmount": "2.45",
    "authorizedCurrency": "USD",
    "fee": "0.5",
    "feeCurrency": "USD",
    "crossBoardFee": "0",
    "crossBoardFeeCurrency": null,
    "settleAmount": 0,
    "settleCurrency": null,
    "settleDate": null,
    "merchantName": "ALP*Mr Rice 1223",
    "type": "auth",
    "typeStr": "授权",
    "status": "authorized",
    "statusStr": "已授权",
    "transactionTime": 1729422898000,
    "description": "Auth"
}

Response

When the returned structure is as shown below, the callback notification is successful

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": null
}

Card Authorization Fee Transaction Notification

X-WSB-CATEGORY=card_fee_patch

Request Params

Click on the returned object Card Authorization Fee Transaction Interface to view the response data

Request Example

{
    "cardNo": "1242352328671924231",
    "tradeNo": "CAF1232435363435463432",
    "originTradeNo": "trans1232435363435463432",
    "currency": "USD",
    "amount": "0.5",
    "type": "card_patch_fee",
    "deductionSourceFunds": "wallet",
    "status": "success",
    "statusStr": "Success",
    "transactionTime": 1729422898000
}

Response

If the returned structure is as shown below, the callback notification is successful.

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": null
}

Card 3ds Transaction Notification

X-WSB-CATEGORY=card_3ds

Request Params

Param
Type
Required
Remark

cardNo

String

true

Bank Card ID

tradeNo

String

true

Transaction serial num

originTradeNo

String

false

Origin Transaction serial num

currency

String

true

currency

amount

BigDecimal

true

amount

merchantName

String

true

Merchant Name (Transaction Scenario)

values

String

true

value. The merchant's public key is encrypted and returned, and the merchant's private key decrypt.

type

String

true

Type

third_3ds_otp: 3ds otp;

auth_url: Transaction authorization response url activation_code：Activation code (physical card)

description

String

false

Transaction Description

transactionTime

Long

true

Transaction time. Millisecond timestamp

expirationTime

Long

false

ExpirationTime time. Millisecond timestamp

Request Example

Example Response

{
    "cardNo": "1242352328671924231",
    "tradeNo": "trans1232435363435463432",
    "originTradeNo": null,
    "currency": "CNY",
    "amount": "16.96",
    "merchantName": "ULTRA MOBILE",
    "values": "ajfon34nNOIN24nafaiw4onnfn0iw32ngfn0IF0Q34NFQFOFAW", //Plain text example: 204566
    "type": "third_3ds_otp",
    "transactionTime": 1729422898000,
    "description": null
}

If the returned structure is as shown below, the callback notification is successful.

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": null
}

Card Holder Notification

X-WSB-CATEGORY=card_holder

Request Params

Param
Type
Required
Remark

holderId

Long

true

Holder ID

merchantOrderNo

String

false

Merchant order number

cardTypeId

Long

true

Card Type ID

email

String

true

email

firstName

String

true

firstName

lastName

String

true

lastName

status

String

true

pass_audit: pass reject: reject

respMsg

String

false

remark

Example Response

{
    "holderId": 123456,
    "cardTypeId": 111016,
    "email": "test@test.com",
    "firstName": "first",
    "lastName": "last",
    "status": "reject",
    "respMsg": "邮箱错误"
}

If the returned structure is as shown below, the callback notification is successful.

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": null
}

Physical card event notification

X-WSB-CATEGORY=physical_card

Request Params

{
    "merchantOrderNo": "35nigjaongaognaeorig", //Merchant order number
    "cardNo": "jojaga3-35mg-35saga-3535dfg", //Card ID
    "type": "card_activated", //Type
    "status": "success", //Status. wait_process  processing  success  fail
    "remark": null
}

Response

If the returned structure is as shown below, the callback notification is successful.

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": null
}

Work event notification

X-WSB-CATEGORY=work

Request Params

{
  "merchantOrderNo": "13243897979979797999008085",
  "orderNo": "WORK-202508071953472304731676672",
  "title": "ApplePay",
  "target": "5533700042831234",
  "content": "Active",
  "tradeType": "CARD_ACTIVE",
  "tradeStatus": "processing", //wait_process; processing; success; fail
  "remark": null,
  "createTime": 1754607865000,
  "updateTime": 1754648044000
}

Response

If the returned structure is as shown below, the callback notification is successful.

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": null
}

PreviousCardholder Management

Last updated