API Introduction

Invoke Method

Content Description
Protocal HTTP/HTTPS
HTTP Method POST (application/json)
Message Type JSON
Charset UTF-8
Signature Algorithm MD5

Message Structure

Request and response message are both use following structure

No. Parameter Format Reference Description Memo
1 action String inquiry Transaction Type The specific interfaces with detail description
2 deviceNo String POS01 Cashier Terminal No. To identify the Cashier Terminal used in this transaction
3 shopNo String CN123456 Shop No. To identify the merchant / shop in this transaction
4 brand String 663 Brand No. To identify the Brand used in this transaction, allocated by e-Buy
5 body String BASE64 Message Detail The specific interfaces with detail description

example

0x00 0xE7{"action":"inquiry","deviceNo":"POS01","shopNo":"CN123456","brand":"663","body":"ewogICAgICAgICAidHJhY2VObyI6ICI5OTAwMDAwOTEwMDAxMDEwMTczMjEyMyIsCiAgICAgICAgICJvcmlnaW5hbFRyYWNlTm8iOiAiOTkwMDAwMDkxMDAwMTAxMDE3MzIxMjQiCiAgICAgfQ=="}

Parameter Object

Goods Detail

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

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
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

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

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

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

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