Parameter Object
Goods Detail
- JSON Key为
goodsDetail, mandatory
| Field | Type | Mandatory | Description | Memo |
|---|---|---|---|---|
| goodsCategory | String | Yes | Goods Category | |
| goodsId | String | Yes | Goods ID | |
| goodsName | String | Yes | Goods Name | Used for report , receipt, slip printing |
| price | Price | Yes | Price | Unit : dollar |
| quantity | Integer | Yes | Quantity | |
| rebateCode | String | No | Rebate Code | Cashier Terminal has pre-set the discount, mandated |
| activityNo | String | No | Activity No | Once e-Buy backend system confirm transaction success, a transaction activity number will return back |
| memo | String | No | Memo | Once e-Buy backend system confirm transaction success, some information will return such as electronic voucher number |
Fund Channel
- JSON Key is
fundChannel, only in Response message, not mandatory
| Field | Type | Mandatory | Description | Memo |
|---|---|---|---|---|
| channelNo | String | Yes | Channel No | Channel No |
| channelName | String | Yes | Channel Name | Channel Name |
| channelAmount | Price | Yes | Channel Amount | Channel Amount |
- supported fund channel:
| channelNo | channelName | Description |
|---|---|---|
| user_real_money | User paid real money | Example:Alipay balance、Alipay Yuebao、Wechat balance、Debit Card or Credit card etc. |
| user_balance | paid by user balance | Example:Alipay balance、Alipay Yuebao、Wechat balance etc. |
| user_bank_card | paid by user bank card | Example:Debit Card or Credit card |
| user_credit | paid by user e-Wallet credit | Example:Alipay huabei,Jingdong credit |
| user_points | paid by user points | Example:Credit card points,Tmall Points etc. |
| merchant_benefit | the benifit provided by merchant | Example:Merchant discount,Merchant voucher etc. |
| platform_benefit | the benifit provided by enterprise | Example:Payment platform discount, Payment platform voucher etc. |
| ebuy_benefit | the benifit provided by e-Buy | Example:e-Buy discount, e-Buy voucher etc |
Print Detail
- JSON Key is
printDetail, only in Response message, not mandatory
| Field | Type | Mandatory | Description | Memo |
|---|---|---|---|---|
| cardNo64 | String | No | The card number (first 6 digits and last 4 digits | The card number (first 6 digits and last 4 digits) is required to print as part of return message |
| bank | String | No | Credit Card issued organization | The Credit Card issued organization is required to print as part of return message |
| paymentOrderNo | String | No | Payment Order no. | Payment order no. is required to print as part of return message |
| paymentUser | String | No | User account | User account need be printed. |
| pointSale | String | No | Point deducted | Point deducted is required to print as part of return message |
| qrCode1 | String | No | Print QR code 1 | QR code 1 is required to print as part of return message |
| qrCode2 | String | No | Print QR code 2 | QR code 2 is required to print as part of return message |
| qrCode3 | String | No | Print QR code 3 | QR code 3 is required to print as part of return message |
| barCode1 | String | No | Print Bar Code 1 | Bar Code code 1 is required to print as part of return message |
| barCode2 | String | No | Print Bar Code 2 | Bar Code code 2 is required to print as part of return message |
| barCode3 | String | No | Print Bar Code 3 | Bar Code code 3 is required to print as part of return message |
| content | String | No | Print Content | TLV Format,1F=Receipt title,2F=Receipt transtype |
| printMode | String | No | Print Mode | 1=1 Receipt,2=2 Receipts,3=3 Receipts |
Member Detail
- JSON Key is
memberDetail, not mandatory
| Field | Type | Mandatory | Description | Memo |
|---|---|---|---|---|
| memberId | String | Yes | Member ID | |
| memberName | String | Yes | Member Name | |
| memberPhone | String | No | Member Mobile | |
| grade | String | No | Member Grade | |
| status | String | No | Member Status | |
| balance | String | No | Balance | |
| pointBalance | String | No | Point Balance |
Settle Record
- JSON Key is
settleRecord, not mandatory
| Field | Type | Mandatory | Description | Memo |
|---|---|---|---|---|
| activityNo | String | Yes | Activity No | |
| activityName | String | Yes | Activity Name | |
| productName | String | Yes | Product Name | |
| customer | String | Yes | Settle Customer | |
| isRefund | Boolean | Yes | Is Refund | |
| volume | Integer | Yes | Transaction Volume | |
| totalReceiptAmount | Price | Yes | Merchant Receipt Amount | |
| totalAmount | Price | Yes | Total Amount |
Trans Record
- JSON Key is
transRecord, mandatory
| Field | Type | Mandatory | Description | Memo |
|---|---|---|---|---|
| traceNo | String | Yes | Cashier terminal trace no. | |
| paidAmount | String | Yes | Paid Amount | |
| status | String | Yes | Match status | See detail |
status
- 0 Initial
- 1 paidAmount e-Buy Backend = request
- 2 paidAmount e-Buy Backend > request
- 3 paidAmount e-Buy Backend < request
- 4 Does not exist in e-Buy Backend
- 5 Failed in e-Buy Backend
- 6 Reversed in e-Buy Backend
- 7 Rollbacked in e-Buy Backend
- 8 Refunded in e-Buy Backend
- 9 e-Buy Backend process failed
- 10 e-Buy Backend has, but Does not exist in Cashier POS
No Comments