Skip to main content

Parameter Object

Goods Detail

  • JSON Key为goodsDetail, mandatory
FieldTypeMandatoryDescriptionMemo
goodsCategoryStringYesGoods Category 
goodsIdStringYesGoods ID 
goodsNameStringYesGoods NameUsed for report , receipt, slip printing
pricePriceYesPriceUnit : dollar
quantityIntegerYesQuantity 
rebateCodeStringNoRebate CodeCashier Terminal has pre-set the discount, mandated
activityNoStringNoActivity NoOnce e-Buy backend system confirm transaction success, a transaction activity number will return back
memoStringNoMemoOnce 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
FieldTypeMandatoryDescriptionMemo
channelNoStringYesChannel NoChannel No
channelNameStringYesChannel NameChannel Name
channelAmountPriceYesChannel AmountChannel Amount
  • supported fund channel:
channelNochannelNameDescription
user_real_moneyUser paid real moneyExample:Alipay balance、Alipay Yuebao、Wechat balance、Debit Card or Credit card etc.
user_balancepaid by user balanceExample:Alipay balance、Alipay Yuebao、Wechat balance etc.
user_bank_cardpaid by user bank cardExample:Debit Card or Credit card
user_creditpaid by user e-Wallet creditExample:Alipay huabei,Jingdong credit
user_pointspaid by user pointsExample:Credit card points,Tmall Points etc.
merchant_benefitthe benifit provided by merchantExample:Merchant discount,Merchant voucher etc.
platform_benefitthe benifit provided by enterpriseExample:Payment platform discount, Payment platform voucher etc.
ebuy_benefitthe benifit provided by e-BuyExample:e-Buy discount, e-Buy voucher etc

Print Detail

  • JSON Key is printDetail, only in Response message, not mandatory
FieldTypeMandatoryDescriptionMemo
cardNo64StringNoThe card number (first 6 digits and last 4 digitsThe card number (first 6 digits and last 4 digits) is required to print as part of return message
bankStringNoCredit Card issued organizationThe Credit Card issued organization is required to print as part of return message
paymentOrderNoStringNoPayment Order no.Payment order no. is required to print as part of return message
paymentUserStringNoUser accountUser account need be printed.
pointSaleStringNoPoint deductedPoint deducted is required to print as part of return message
qrCode1StringNoPrint QR code 1QR code 1 is required to print as part of return message
qrCode2StringNoPrint QR code 2QR code 2 is required to print as part of return message
qrCode3StringNoPrint QR code 3QR code 3 is required to print as part of return message
barCode1StringNoPrint Bar Code 1Bar Code code 1 is required to print as part of return message
barCode2StringNoPrint Bar Code 2Bar Code code 2 is required to print as part of return message
barCode3StringNoPrint Bar Code 3Bar Code code 3 is required to print as part of return message
contentStringNoPrint ContentTLV Format,1F=Receipt title,2F=Receipt transtype
printModeStringNoPrint Mode1=1 Receipt,2=2 Receipts,3=3 Receipts

Member Detail

  • JSON Key is memberDetail, not mandatory
FieldTypeMandatoryDescriptionMemo
memberIdStringYesMember ID 
memberNameStringYesMember Name 
memberPhoneStringNoMember Mobile 
gradeStringNoMember Grade 
statusStringNoMember Status 
balanceStringNoBalance 
pointBalanceStringNoPoint Balance

Settle Record

  • JSON Key is settleRecord, not mandatory
FieldTypeMandatoryDescriptionMemo
activityNoStringYesActivity No 
activityNameStringYesActivity Name 
productNameStringYesProduct Name 
customerStringYesSettle Customer 
isRefundBooleanYesIs Refund 
volumeIntegerYesTransaction Volume 
totalReceiptAmountPriceYesMerchant Receipt Amount 
totalAmountPriceYesTotal Amount

Trans Record

  • JSON Key is transRecord, mandatory
FieldTypeMandatoryDescriptionMemo
traceNoStringYesCashier terminal trace no. 
paidAmountStringYesPaid Amount 
statusStringYesMatch statusSee detail

status