# Parameter Object

### Goods Detail

- JSON Key为`goodsDetail`, mandatory

<table id="bkmrk-field-type-mandatory"><thead><tr><th style="width: 115px;">Field</th><th style="width: 70px;">Type</th><th style="width: 90px;">Mandatory</th><th style="width: 120px;">Description</th><th style="width: 413px;">Memo</th></tr></thead><tbody><tr><td style="width: 115px;">goodsCategory</td><td style="width: 70px;">String</td><td style="width: 90px;">Yes</td><td style="width: 120px;">Goods Category</td><td style="width: 413px;"> </td></tr><tr><td style="width: 115px;">goodsId</td><td style="width: 70px;">String</td><td style="width: 90px;">Yes</td><td style="width: 120px;">Goods ID</td><td style="width: 413px;"> </td></tr><tr><td style="width: 115px;">goodsName</td><td style="width: 70px;">String</td><td style="width: 90px;">Yes</td><td style="width: 120px;">Goods Name</td><td style="width: 413px;">Used for report , receipt, slip printing</td></tr><tr><td style="width: 115px;">price</td><td style="width: 70px;">Price</td><td style="width: 90px;">Yes</td><td style="width: 120px;">Price</td><td style="width: 413px;">Unit : dollar</td></tr><tr><td style="width: 115px;">quantity</td><td style="width: 70px;">Integer</td><td style="width: 90px;">Yes</td><td style="width: 120px;">Quantity</td><td style="width: 413px;"> </td></tr><tr><td style="width: 115px;">rebateCode</td><td style="width: 70px;">String</td><td style="width: 90px;">No</td><td style="width: 120px;">Rebate Code</td><td style="width: 413px;">Cashier Terminal has pre-set the discount, mandated</td></tr><tr><td style="width: 115px;">activityNo</td><td style="width: 70px;">String</td><td style="width: 90px;">No</td><td style="width: 120px;">Activity No</td><td style="width: 413px;">Once [e-Buy backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS") system confirm transaction success, a transaction activity number will return back</td></tr><tr><td style="width: 115px;">memo</td><td style="width: 70px;">String</td><td style="width: 90px;">No</td><td style="width: 120px;">Memo</td><td style="width: 413px;">Once [e-Buy backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS") system confirm transaction success, some information will return such as electronic voucher number</td></tr></tbody></table>

### Fund Channel

- JSON Key is `fundChannel`, only in Response message, not mandatory

<table id="bkmrk-field-type-mandatory-0" style="width: 542px;"><thead><tr><th style="width: 122px;">Field</th><th style="width: 60px;">Type</th><th style="width: 96px;">Mandatory</th><th style="width: 129px;">Description</th><th style="width: 135px;">Memo</th></tr></thead><tbody><tr><td style="width: 122px;">channelNo</td><td style="width: 60px;">String</td><td style="width: 96px;">Yes</td><td style="width: 129px;">Channel No</td><td style="width: 135px;">Channel No</td></tr><tr><td style="width: 122px;">channelName</td><td style="width: 60px;">String</td><td style="width: 96px;">Yes</td><td style="width: 129px;">Channel Name</td><td style="width: 135px;">Channel Name</td></tr><tr><td style="width: 122px;">channelAmount</td><td style="width: 60px;">Price</td><td style="width: 96px;">Yes</td><td style="width: 129px;">Channel Amount</td><td style="width: 135px;">Channel Amount</td></tr></tbody></table>

- supported fund channel：

<table id="bkmrk-channelno-channelnam"><thead><tr><th style="width: 125px;">channelNo</th><th style="width: 233px;">channelName</th><th style="width: 451px;">Description</th></tr></thead><tbody><tr><td style="width: 125px;">user\_real\_money</td><td style="width: 233px;">User paid real money</td><td style="width: 451px;">Example：Alipay balance、Alipay Yuebao、Wechat balance、Debit Card or Credit card etc.</td></tr><tr><td style="width: 125px;">user\_balance</td><td style="width: 233px;">paid by user balance</td><td style="width: 451px;">Example：Alipay balance、Alipay Yuebao、Wechat balance etc.</td></tr><tr><td style="width: 125px;">user\_bank\_card</td><td style="width: 233px;">paid by user bank card</td><td style="width: 451px;">Example：Debit Card or Credit card</td></tr><tr><td style="width: 125px;">user\_credit</td><td style="width: 233px;">paid by user e-Wallet credit</td><td style="width: 451px;">Example：Alipay huabei，Jingdong credit</td></tr><tr><td style="width: 125px;">user\_points</td><td style="width: 233px;">paid by user points</td><td style="width: 451px;">Example：Credit card points，Tmall Points etc.</td></tr><tr><td style="width: 125px;">merchant\_benefit</td><td style="width: 233px;">the benifit provided by merchant</td><td style="width: 451px;">Example：Merchant discount，Merchant voucher etc.</td></tr><tr><td style="width: 125px;">platform\_benefit</td><td style="width: 233px;">the benifit provided by enterprise</td><td style="width: 451px;">Example：Payment platform discount, Payment platform voucher etc.</td></tr><tr><td style="width: 125px;">ebuy\_benefit</td><td style="width: 233px;">the benifit provided by e-Buy</td><td style="width: 451px;">Example：e-Buy discount, e-Buy voucher etc</td></tr></tbody></table>

### Print Detail

- JSON Key is `printDetail`, only in Response message, not mandatory

<table id="bkmrk-field-type-mandatory-1" style="height: 450px;"><thead><tr style="height: 45px;"><th style="height: 45px; width: 129px;">Field</th><th style="height: 45px; width: 59px;">Type</th><th style="height: 45px; width: 58px;">Mandatory</th><th style="height: 45px; width: 170px;">Description</th><th style="height: 45px; width: 382px;">Memo</th></tr></thead><tbody><tr style="height: 45px;"><td style="height: 45px; width: 129px;">cardNo64</td><td style="height: 45px; width: 59px;">String</td><td style="height: 45px; width: 58px;">No</td><td style="height: 45px; width: 170px;">The card number (first 6 digits and last 4 digits</td><td style="height: 45px; width: 382px;">The card number (first 6 digits and last 4 digits) is required to print as part of return message</td></tr><tr style="height: 45px;"><td style="height: 45px; width: 129px;">bank</td><td style="height: 45px; width: 59px;">String</td><td style="height: 45px; width: 58px;">No</td><td style="height: 45px; width: 170px;">Credit Card issued organization</td><td style="height: 45px; width: 382px;">The Credit Card issued organization is required to print as part of return message</td></tr><tr style="height: 45px;"><td style="height: 45px; width: 129px;">paymentOrderNo</td><td style="height: 45px; width: 59px;">String</td><td style="height: 45px; width: 58px;">No</td><td style="height: 45px; width: 170px;">Payment Order no.</td><td style="height: 45px; width: 382px;">Payment order no. is required to print as part of return message</td></tr><tr style="height: 17px;"><td style="height: 17px; width: 129px;">paymentUser</td><td style="height: 17px; width: 59px;">String</td><td style="height: 17px; width: 58px;">No</td><td style="height: 17px; width: 170px;">User account</td><td style="height: 17px; width: 382px;">User account need be printed.</td></tr><tr style="height: 27px;"><td style="height: 27px; width: 129px;">pointSale</td><td style="height: 27px; width: 59px;">String</td><td style="height: 27px; width: 58px;">No</td><td style="height: 27px; width: 170px;">Point deducted</td><td style="height: 27px; width: 382px;">Point deducted is required to print as part of return message</td></tr><tr style="height: 16px;"><td style="height: 16px; width: 129px;">qrCode1</td><td style="height: 16px; width: 59px;">String</td><td style="height: 16px; width: 58px;">No</td><td style="height: 16px; width: 170px;">Print QR code 1</td><td style="height: 16px; width: 382px;">QR code 1 is required to print as part of return message</td></tr><tr style="height: 16px;"><td style="height: 16px; width: 129px;">qrCode2</td><td style="height: 16px; width: 59px;">String</td><td style="height: 16px; width: 58px;">No</td><td style="height: 16px; width: 170px;">Print QR code 2</td><td style="height: 16px; width: 382px;">QR code 2 is required to print as part of return message</td></tr><tr style="height: 18px;"><td style="height: 18px; width: 129px;">qrCode3</td><td style="height: 18px; width: 59px;">String</td><td style="height: 18px; width: 58px;">No</td><td style="height: 18px; width: 170px;">Print QR code 3</td><td style="height: 18px; width: 382px;">QR code 3 is required to print as part of return message</td></tr><tr style="height: 45px;"><td style="height: 45px; width: 129px;">barCode1</td><td style="height: 45px; width: 59px;">String</td><td style="height: 45px; width: 58px;">No</td><td style="height: 45px; width: 170px;">Print Bar Code 1</td><td style="height: 45px; width: 382px;">Bar Code code 1 is required to print as part of return message</td></tr><tr style="height: 45px;"><td style="height: 45px; width: 129px;">barCode2</td><td style="height: 45px; width: 59px;">String</td><td style="height: 45px; width: 58px;">No</td><td style="height: 45px; width: 170px;">Print Bar Code 2</td><td style="height: 45px; width: 382px;">Bar Code code 2 is required to print as part of return message</td></tr><tr style="height: 45px;"><td style="height: 45px; width: 129px;">barCode3</td><td style="height: 45px; width: 59px;">String</td><td style="height: 45px; width: 58px;">No</td><td style="height: 45px; width: 170px;">Print Bar Code 3</td><td style="height: 45px; width: 382px;">Bar Code code 3 is required to print as part of return message</td></tr><tr style="height: 16px;"><td style="height: 16px; width: 129px;">content</td><td style="height: 16px; width: 59px;">String</td><td style="height: 16px; width: 58px;">No</td><td style="height: 16px; width: 170px;">Print Content</td><td style="height: 16px; width: 382px;">[TLV](https://book.e-buy.com/link/124#bkmrk-tlv "Communication protocol commonly used data formats, Comprise 3 parts: "Tag", "Length" & "Value"") Format，1F=Receipt title，2F=Receipt transtype</td></tr><tr style="height: 25px;"><td style="height: 25px; width: 129px;">printMode</td><td style="height: 25px; width: 59px;">String</td><td style="height: 25px; width: 58px;">No</td><td style="height: 25px; width: 170px;">Print Mode</td><td style="height: 25px; width: 382px;">1=1 Receipt，2=2 Receipts，3=3 Receipts</td></tr></tbody></table>

### Member Detail

- JSON Key is `memberDetail`, not mandatory

<table id="bkmrk-field-type-mandatory-2"><thead><tr><th>Field</th><th>Type</th><th>Mandatory</th><th>Description</th><th>Memo</th></tr></thead><tbody><tr><td>memberId</td><td>String</td><td>Yes</td><td>Member ID</td><td> </td></tr><tr><td>memberName</td><td>String</td><td>Yes</td><td>Member Name</td><td> </td></tr><tr><td>memberPhone</td><td>String</td><td>No</td><td>Member Mobile</td><td> </td></tr><tr><td>grade</td><td>String</td><td>No</td><td>Member Grade</td><td> </td></tr><tr><td>status</td><td>String</td><td>No</td><td>Member Status</td><td> </td></tr><tr><td>balance</td><td>String</td><td>No</td><td>Balance</td><td> </td></tr><tr><td>pointBalance</td><td>String</td><td>No</td><td>Point Balance</td></tr></tbody></table>

### Settle Record

- JSON Key is `settleRecord`, not mandatory

<table id="bkmrk-field-type-mandatory-3"><thead><tr><th>Field</th><th>Type</th><th>Mandatory</th><th>Description</th><th>Memo</th></tr></thead><tbody><tr><td>activityNo</td><td>String</td><td>Yes</td><td>Activity No</td><td> </td></tr><tr><td>activityName</td><td>String</td><td>Yes</td><td>Activity Name</td><td> </td></tr><tr><td>productName</td><td>String</td><td>Yes</td><td>Product Name</td><td> </td></tr><tr><td>customer</td><td>String</td><td>Yes</td><td>Settle Customer</td><td> </td></tr><tr><td>isRefund</td><td>Boolean</td><td>Yes</td><td>Is Refund</td><td> </td></tr><tr><td>volume</td><td>Integer</td><td>Yes</td><td>Transaction Volume</td><td> </td></tr><tr><td>totalReceiptAmount</td><td>Price</td><td>Yes</td><td>Merchant Receipt Amount</td><td> </td></tr><tr><td>totalAmount</td><td>Price</td><td>Yes</td><td>Total Amount</td></tr></tbody></table>

### Trans Record

- JSON Key is `transRecord`, mandatory

<table id="bkmrk-field-type-mandatory-4"><thead><tr><th>Field</th><th>Type</th><th>Mandatory</th><th>Description</th><th>Memo</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>Yes</td><td>Cashier terminal trace no.</td><td> </td></tr><tr><td>paidAmount</td><td>String</td><td>Yes</td><td>Paid Amount</td><td> </td></tr><tr><td>status</td><td>String</td><td>Yes</td><td>Match status</td><td>See detail</td></tr></tbody></table>

**status**

- 0 Initial
- 1 paidAmount [e-Buy Backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS") = request
- 2 paidAmount [e-Buy Backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS") &gt; request
- 3 paidAmount [e-Buy Backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS") &lt; request
- 4 Does not exist in [e-Buy Backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS")
- 5 Failed in [e-Buy Backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS")
- 6 Reversed in [e-Buy Backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS")
- 7 Rollbacked in [e-Buy Backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS")
- 8 Refunded in [e-Buy Backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS")
- 9 [e-Buy Backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS") process failed
- 10 [e-Buy Backend](https://book.e-buy.com/link/124#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS") has, but Does not exist in Cashier POS