Auto-deduct Voucher
This page discuss the extended information for auto-deduct voucher scenarios, please also check the base API.
Order Status
Notification can start from any status below and status can be skipped if necessary, but not in reverse. |
Order Status | Description | Card Wallet Display |
| When the voucher is issued. | Issue voucher in Card Wallet.
|
Below is the extra fields of this scenario, please also check the base API fields. |
Request parameters
tradeNo string
The transaction number provided by Alipay.
amount object
The original amount of this order.
payAmount object
The actual amount user paid for this order.
extInfo object REQUIRED
Response parameters
result Result REQUIRED
A metadata object indicates the result of the request.
orderId string REQUIRED
The order ID from AlipayHK
orderStatus string REQUIRED
Refer 'Order Status' tab above.
distributeResult Array<OrderDataDistributeInfo> REQUIRED
Business result
API Explorer
Request
Case
Gift Card
Request Body
Response
Response Body
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | success | success |
| PARAM_ILLEGAL | F | Request is invalid, usually missing parameters. | |
| ORDER_STATUS_INVALID | F | The order status is illegal. The status is not matched or the state machine does not support changes to this status | |
| UNKNOWN_EXCEPTION | U | Unknown error. Merchants can try later first & contact with AlipayHK | |
| UN_SUPPORT_BUSINESS | F | The service is not supported. eg: The merchant is not onboard & the API is offline |