# Parameter Object # Card Info - JSON Key is `cardInfo`, only in Request message, not mandatory

Field	Type	Mandatory	Description	Memo
cardNo	String	Yes	Card No	Mandated for Credit Card payment transaction
password	String	No	Password	Mandated when password is required, apply Financial encryption
valid	String	No	Valid Date	Mandated for Credit Card payment transaction, format : YYMM
track1	String	No	Track 1
track2	String	No	Track 2	Mandated for Credit Card payment transaction, apply financial encryption
track3	String	No	Track 3
cardSn	String	No	IC Serial	Mandated for credit card payment transaction, such as IC card, apply Financial encryption
icData	String	No	IC Data	Mandated for credit card payment transaction, such as IC card, apply Financial encryption
cardType	String	No	Card Type	See details
tc	String	No	Transaction Certificate	Transaction Certificate

**cardNo encryption** - cardNo 3DES Encryption with pinKey，result format is HEX，see：[Encryption Algorithm](https://book.e-buy.com/books/e-buy/page/encryption-algorithm "Encryption Algorithm") **password encryption** - password ANSI X.98 Encryption with pinKey，result format is HEX，see：[Password Encryption](https://book.e-buy.com/books/e-buy/page/password-encryption "Password Encryption") **track1 encryption** - track1 3DES Encryption with pinKey，result format is HEX，see：[Encryption Algorithm](https://book.e-buy.com/books/e-buy/page/encryption-algorithm "Encryption Algorithm") **track2 encryption** - track2 3DES Encryption with pinKey，result format is HEX，see：[Encryption Algorithm](https://book.e-buy.com/books/e-buy/page/encryption-algorithm "Encryption Algorithm") **track3 encryption** - track3 3DES Encryption with pinKey，result format is HEX，see：[Encryption Algorithm](https://book.e-buy.com/books/e-buy/page/encryption-algorithm "Encryption Algorithm") **cardType Details** - 00 magnetic stripe card - 01 IC card - 02 NFC IC card - 03 Manully enter card Number - 04 scan qrcode - 05 other type - 06 collected by Cashier POS - 07 Apple Pay - 08 Samsung Pay - 09 Huawei Pay - 10 Mi Pay # 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
goodsSpec	String	No	Goods Spec	Shows in report or receipt
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](https://book.e-buy.com/link/136#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
memo	String	No	Memo	Once [e-Buy backend](https://book.e-buy.com/link/136#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
voucherId	String	No	Voucher ID	Return when have voucher\_detail

# 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
sectionNo	String	No	Section no	Distribution by financial staff, can be entry into the cash register after matching

- 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
bankTid	String	No	Bank Terminal ID	Responsed when UnionPay with JLCashPay
bankMid	String	No	Bank Merchant ID	Responsed when UnionPay with JLCashPay
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](https://book.e-buy.com/link/136#bkmrk-tlv "Communication protocol commonly used data formats, Comprise 3 parts: "Tag", "Length" & "Value"") 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
memberId	String	Yes	Member ID
memberCode	String	Yes	Member Code
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
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](https://book.e-buy.com/link/136#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/136#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS") > request - 3 paidAmount [e-Buy Backend](https://book.e-buy.com/link/136#bkmrk-e-buy-backend "A group /set of equipment / server to process all the transaction from e-Buy POS") < request - 4 Does not exist in [e-Buy Backend](https://book.e-buy.com/link/136#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/136#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/136#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/136#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/136#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/136#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/136#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 # Activity Product List - JSON Key is`activityProductList`, mandatory when prompt transaction options

Field	Type	Mandatory	Description	Memo
activityProductNo	String	Yes	Activity Product No.
activityProductName	String	Yes	Activity Product Name
command	String	No	responsed commands in menus
showOrder	String	Yes	Show order	Show as A-Z

# Trans Timestamp - JSON Key is `transTimestamp`, mandatory

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Original trace no.
send	String	Yes	Send timestamp	Unix Format,Unit：seconds
recv	String	Yes	Receive timestamp	Unix Format,Unit：seconds

# Trans Info - JSON Key is `transInfo`, mandatory

Field	Type	Mandatory	Description	Memo
action	String	Yes	交易action
traceNo	String	Yes	Cashier terminal trace no.
orderNo	String	Yes	易百系统参考号
transDate	String	Yes	交易时间	格式：yyyyMMddHHmmss
returnCode	String	Yes	Return code	00 represent successful transaction, else represent fail
returnDesc	String	Yes	Return message	Detail explanation / error message per transaction result
paidAmount	String	Yes	交易成功金额
activityProductNo	String	Yes	活动产品编号
activityProductName	String	Yes	活动产品名称	活动名称+产品名称
bank	String	Yes	交易机构标识
cardNo64	String	Yes	卡号或串码
printContent	String	Yes	小票打印数据

# Function Menu - JSON Key is`function`, only in Response message

Field	Type	Mandatory	Description	Memo
iconUrl	String	Yes	icon URL	variable-length field
title	String	Yes	Function Name	variable-length field
action	String	Yes	Function Action	variable-length field
command	String	Yes	Commands in Menus	Such as:04\|00\|Please Swipe card\|1\|08\|00\|Product XXX(M)$HDCP00000000072578\|0\|
childrenFunc	List<[function](https://book.e-buy.com/books/e-buy/page/function-menu)>	No	Nodes in Menus	variable-length field

# Head Picture - JSON Key is `headPicture`, only in Response message

Field	Type	Mandatory	Description	Memo
displayPicUrl	String	Yes	Picture URL in Banner	variable-length field
linkUrl	String	Yes	Link URL	variable-length field

# Package Detail - JSON Key is `packageDetail`, only in Response message

Field	Type	Mandatory	Description	Memo
packId	String	Yes	Package ID	variable-length field
packName	String	Yes	Package Name
goodsInfoList	List<[goodsDetail](https://book.e-buy.com/books/e-buy/page/goods-detail "goodsDetail")>	Yes	Goods Detail List

# Order Info - JSON Key is `orderInfo`, only in Response message, mandatory

Field	Type	Mandatory	Description	Memo
appOrderNo	String	Yes	APP Order No	variable-length field
statusCode	String	Yes	Order Status Code	variable-length field
status	String	Yes	Order Status Desc	Order Status Desc
orderTime	String	Yes	Order Time	Format:HH:mm, shows in Order List
orderCreateTime	String	Yes	Order Create Time	Format:yyyy-MM-dd HH:mm:ss
orderAmount	Price	Yes	Order Amount
rcptName	String	Yes	Receiver
platformName	String	Yes	Tokeout Platform	variable-length field, Such as: Baidu, Meituan, less than 8 characters
packageDetailList	List<[packageDetail](https://book.e-buy.com/books/e-buy/page/package-detail "packageDetail")>	No	Package Detail	Responsed when Order Detail API called

# Voucher Detail - JSON Key为`voucherDetail`, mandatory

Field	Type	Mandatory	Description	Memo
voucherId	String	Yes	Voucher ID
voucherName	String	Yes	Voucher Name	Used for reports, tickets, etc.
voucherType	String	Yes	Voucher Type
voucherAmount	Price	Yes	Price	Unit : dollar
voucherCode	String	Yes	Voucher Code