Transaction API

• Bank Acquiring
• Card Redemption
• Qrcode Sale
• Trans Inquiry
• Trans Void(card)
• Trans Void(qrcode)
• Trans Refund(card)
• Trans Refund(qrcode)
• Ecoupon Inquiry
• Point Accumulating

Bank Acquiring

Transaction Flow

• The requested transaction will firstly invoke MIS-POS for Card swape and password input. Once MIS-POS confirmed on both inputs, it will send back to e-Buy backend server to process.

action

• cardPayment

Request body，Cashier POS===>e-Buy Backend

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
totalAmount	Price	Yes	Total transaction amount	Unit : Dollar
undiscountAmount	Price	Yes	undiscountable Amount	Unit : Dollar
acquirer	String	Yes	Acquirer Bank	Example：citicCashpay
goodsDetail	List<goodsDetail>	Yes	Goods detail	Mandated on goods detail verification
memberDetail	Object<memberDetail>	No	Member information	Mandated on member payment

Request body example

{
    "traceNo": "99000009100010101732123",
    "totalAmount": 40.8,
    "undiscountAmount": 0,
    "acquirer": "citicCashpay",
    "goodsDetail": [
        {
            "goodsCategory": "001",
            "goodsId": "P00001",
            "goodsName": "牙膏",
            "price": 8,
            "quantity": 2,
            "rebateCode": "000"
        },
        {
            "goodsCategory": "101",
            "goodsId": "P00002",
            "goodsName": "洗发水",
            "price": 24.8,
            "quantity": 1,
            "rebateCode": "000"
        }
    ],
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Response body，e-Buy Backend===>Cashier POS

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
orderNo	String	Yes	Order No. from e-Buy	易百生成
transDate	String	Yes	Transaction time	Format：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	Price	Yes	Total amount paid	Face Value. Unit : Dollar
receiptAmount	Price	No	Merchant actual received amount	Net Value. Unit : Dollar
invoiceAmount	Price	No	Merchant invoice amount	Unit : Dollar
exchangeRate	Number(8,6)	No	Exchange Rate	The rate of conversion the currency given in the request to CNY.
currency	String	No	Currency	For example: CNY
discountCode	String	No	Discount Code	assigned by Cashier POS,用于入账计折扣类型，如：2016120101|20.00表示支付20元
discountNum	Number	No	numbers of discountCode	用于入账计折扣类型的数量
tenderCode	String	No	Tender Code	assigned by Cashier POS,用于入账计支付方式，如：2016120101|20.00表示支付20元
activityProductNo	String	No	Activity Product no.
activityProductName	String	No	Activity Product name
needSameCard	Boolean	No	Required same card payment	Such as discount upon amount reached, same credit card must be used for the payment
goodsDetail	List<goodsDetail>	No	Paid product detail	Backend response paid product detail
fundChannel	List<fundChannel>	No	Channel of fund
printDetail	Object<printDetail>	No	Printing message	Provided if required to print on the receipt
memberDetail	Object<memberDetail>	No	Member information	Member info return message on this transaction

Response body example

{
    "traceNo": "99000009100010101732123",
    "orderNo": "171698602301",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "paidAmount": 40.8,
    "receiptAmount": 40.8,
    "invoiceAmount": 40.8,
    "exchangeRate": 6.0939,
    "currency": "CNY",
    "discountCode": "0001",
    "discountNum": 20,
    "tenderCode": "8001",
    "activityProductNo": "2016123101",
    "activityProductName": "中信365权益",
    "needSameCard": true,
    "goodsDetail": [
        {
            "goodsCategory": "001",
            "goodsId": "P00001",
            "goodsName": "牙膏",
            "price": 8,
            "quantity": 2,
            "rebateCode": "000",
            "activityNo": "2016123101",
            "memo": "100123456789"
        },
        {
            "goodsCategory": "101",
            "goodsId": "P00002",
            "goodsName": "洗发水",
            "price": 24.8,
            "quantity": 1,
            "rebateCode": "000",
            "activityNo": "2016123101",
            "memo": "100123456789"
        }
    ],
    "fundChannel": [
        {
            "channelNo": "001",
            "channelName": "用户实付现金",
            "channelAmount": "20.8"
        },
        {
            "channelNo": "002",
            "channelName": "用户积分支付",
            "channelAmount": "20"
        }
    ],
    "printDetail": {
        "cardNo64": "622562****8888",
        "bank": "中信银行",
        "paymentOrderNo": "201612315689412157458787",
        "pointSale": "20000",
        "qrCode1": "htt://www.xxx.com/url",
        "qrCode2": "",
        "qrCode3": "",
        "barCode1": "12345679",
        "barCode2": "",
        "barCode3": ""
    },
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Card Redemption

Usage

• Bank loyalty point redemption
• Bank Loyalty point redemption + Cash payment
• Bank privilege verification
• Bank privilege verification + Cash Payment
• Prepay Card payment
• Member Card payment

Transaction Flow

• The requested transaction will will firstly invoke MIS-POS for Card swape and password input. Once MIS-POS confirmed on both inputs, it will send back to e-Buy backend server to process.

action

• cardRedemption

Request body，Cashier POS===>e-Buy Backend

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat，建议yyyyMMddHHmmss+10位流水号
totalAmount	Price	Yes	Total transaction amount	Unit : Dollar
undiscountAmount	Price	Yes	undiscountable Amount	Unit : Dollar
goodsDetail	List<goodsDetail>	Yes	Goods detail	Mandated on goods detail verification
memberDetail	Object<memberDetail>	No	Member information	Mandated on member payment

Request body example

{
    "traceNo": "99000009100010101732123",
    "totalAmount": 40.8,
    "undiscountAmount": 0,
    "goodsDetail": [
        {
            "goodsCategory": "001",
            "goodsId": "P00001",
            "goodsName": "牙膏",
            "price": 8,
            "quantity": 2,
            "rebateCode": "000"
        },
        {
            "goodsCategory": "101",
            "goodsId": "P00002",
            "goodsName": "洗发水",
            "price": 24.8,
            "quantity": 1,
            "rebateCode": "000"
        }
    ],
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Response body，e-Buy Backend===>Cashier POS

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
orderNo	String	Yes	Order No. from e-Buy	易百生成
transDate	String	Yes	Transaction time	Format：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	Price	Yes	Total amount paid	Face Value. Unit : Dollar
receiptAmount	Price	No	Merchant actual received amount	Net Value. Unit : Dollar
invoiceAmount	Price	No	Merchant invoice amount	Unit : Dollar
exchangeRate	Number(8,6)	No	Exchange Rate	The rate of conversion the currency given in the request to CNY.
currency	String	No	Currency	For example: CNY
discountCode	String	No	Discount Code	assigned by Cashier POS
discountNum	Number	No	numbers of discountCode	用于入账计折扣类型的数量
tenderCode	String	No	Tender Code	assigned by Cashier POS,用于入账计支付方式，如：2016120101|20.00表示支付20元
activityProductNo	String	No	Activity Product no.
activityProductName	String	No	Activity Product name
needSameCard	Boolean	No	Required same card payment	Such as discount upon amount reached, same credit card must be used for the payment
goodsDetail	List<goodsDetail>	No	Paid product detail	Backend response paid product detail
fundChannel	List<fundChannel>	No	Channel of fund
printDetail	Object<printDetail>	No	Printing message	Provided if required to print on the receipt
memberDetail	Object<memberDetail>	No	Member information	Member info return message on this transaction

Response body example

{
    "traceNo": "99000009100010101732123",
    "orderNo": "171698602301",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "paidAmount": 40.8,
    "receiptAmount": 40.8,
    "invoiceAmount": 40.8,
    "exchangeRate": 6.0939,
    "currency": "CNY",
    "discountCode": "0001",
    "discountNum": 20,
    "tenderCode": "8001",
    "activityProductNo": "2016123101",
    "activityProductName": "中信365权益",
    "needSameCard": true,
    "goodsDetail": [
        {
            "goodsCategory": "001",
            "goodsId": "P00001",
            "goodsName": "牙膏",
            "price": 8,
            "quantity": 2,
            "rebateCode": "000",
            "activityNo": "2016123101",
            "memo": "100123456789"
        },
        {
            "goodsCategory": "101",
            "goodsId": "P00002",
            "goodsName": "洗发水",
            "price": 24.8,
            "quantity": 1,
            "rebateCode": "000",
            "activityNo": "2016123101",
            "memo": "100123456789"
        }
    ],
    "fundChannel": [
        {
            "channelNo": "001",
            "channelName": "用户实付现金",
            "channelAmount": "20.8"
        },
        {
            "channelNo": "002",
            "channelName": "用户积分支付",
            "channelAmount": "20"
        }
    ],
    "printDetail": {
        "cardNo64": "622562****8888",
        "bank": "中信银行",
        "paymentOrderNo": "201612315689412157458787",
        "pointSale": "20000",
        "qrCode1": "htt://www.xxx.com/url",
        "qrCode2": "",
        "qrCode3": "",
        "barCode1": "12345679",
        "barCode2": "",
        "barCode3": ""
    },
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Qrcode Sale

Usage

• Alipay
• Wechat Payment
• QR-Code Payment from Bank
• QR-Code point redeem from Bank
• QR-Code Payment from China UnionPay
• Baidu Payment
• Bestpay
• Other QR-Code Payment
• Product coupon/cash coupon/discount coupon/Buy M Get N Free coupon /Deduct coupon
• Take out or Self booking order

Transaction Flow

• The transaction process will collect QR code message thru scanning or direct input through keypad, and it will send to e-Buy backend server after collection to further process.

action

• qrcodeSale

Request body，Cashier POS===>e-Buy Backend

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
totalAmount	Price	Yes	Total transaction amount	Unit : Dollar
undiscountAmount	Price	Yes	Undiscountable Amount	Unit : Dollar
qrcode	String	Yes	QR-Code	串号、一维码或二维码内容
goodsDetail	List<goodsDetail>	Yes	Goods detail	Mandated on goods detail verification
memberDetail	Object<memberDetail>	No	Member information	Mandated for member payment

Request body example

{
    "traceNo": "99000009100010101732123",
    "totalAmount": 40.8,
    "undiscountAmount": 0,
    "qrcode": "280123121234567890",
    "goodsDetail": [
        {
            "goodsCategory": "001",
            "goodsId": "P00001",
            "goodsName": "牙膏",
            "price": 8,
            "quantity": 2,
            "rebateCode": "000"
        },
        {
            "goodsCategory": "101",
            "goodsId": "P00002",
            "goodsName": "洗发水",
            "price": 24.8,
            "quantity": 1,
            "rebateCode": "000"
        }
    ],
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Response body，e-Buy Backend===>Cashier POS

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
orderNo	String	Yes	Order No. from e-Buy	made by Ebuy
transDate	String	Yes	Transaction time	Format：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	Price	Yes	Total amount paid	Face Value. Unit : Dollar
receiptAmount	Price	No	Merchant actual received amount	Net Value. Unit : Dollar
invoiceAmount	Price	No	Merchant invoice amount	Unit : Dollar
exchangeRate	Number(8,6)	No	Exchange Rate	The rate of conversion the currency given in the request to CNY.
currency	String	No	Currency	For example: CNY
discountCode	String	No	Discount Code	assigned by Cashier POS
discountNum	Number	No	numbers of discountCode	用于入账计折扣类型的数量
tenderCode	String	No	Tender Code	assigned by Cashier POS,record payment method，like：2016120101|20.00 is payment 20yuan
activityProductNo	String	No	Activity Product no.
activityProductName	String	No	Activity Product name
goodsDetail	List<goodsDetail>	No	Paid product detail	Backend response paid product detail
fundChannel	List<fundChannel>	No	Channel of fund
printDetail	Object<printDetail>	No	Printing message	Provided if required to print on the receipt
memberDetail	Object<memberDetail>	No	Member information	Member info return message on this transaction

Response body example

{
    "traceNo": "99000009100010101732123",
    "orderNo": "171698602301",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "paidAmount": 40.8,
    "receiptAmount": 40.8,
    "invoiceAmount": 40.8,
    "exchangeRate": 6.0939,
    "currency": "CNY",
    "discountCode": "0001",
    "discountNum": 20,
    "tenderCode": "8001",
    "activityProductNo": "2016123102",
    "activityProductName": "支付宝支付",
    "goodsDetail": [
        {
            "goodsCategory": "001",
            "goodsId": "P00001",
            "goodsName": "牙膏",
            "price": 8,
            "quantity": 2,
            "rebateCode": "000",
            "activityNo": "2016123101",
            "memo": "100123456789"
        },
        {
            "goodsCategory": "101",
            "goodsId": "P00002",
            "goodsName": "洗发水",
            "price": 24.8,
            "quantity": 1,
            "rebateCode": "000",
            "activityNo": "2016123101",
            "memo": "100123456789"
        }
    ],
    "fundChannel": [
        {
            "channelNo": "001",
            "channelName": "用户实付现金",
            "channelAmount": "20.8"
        },
        {
            "channelNo": "002",
            "channelName": "用户积分支付",
            "channelAmount": "20"
        }
    ],
    "printDetail": {
        "cardNo64": "622562****8888",
        "bank": "中国银行",
        "paymentOrderNo": "201612315689412157458787",
        "paymentUser": "139****@163.com",
        "pointSale": "20000",
        "qrCode1": "htt://www.xxx.com/url",
        "qrCode2": "",
        "qrCode3": "",
        "barCode1": "12345679",
        "barCode2": "",
        "barCode3": ""
    },
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Trans Inquiry

Usage

• Invoke this API to inquiry last transaction result when it is timed out.

action

• inquiry

Request body，Cashier POS===>e-Buy Backend

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier trace no.	No repeat
originalTraceNo	String	Yes	Original Cashier trace no.	传入需要查询的原交易收银机流水号

Request body example

{
    "traceNo": "99000009100010101732123",
    "originalTraceNo": "99000009100010101732124"
}

Response body，e-Buy Backend===>Cashier POS

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
orderNo	String	Yes	Order No. from e-Buy	Unit：Dollar
transDate	String	Yes	Transaction time	Format：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	Price	Yes	Total amount paid	Face Value. Unit : Dollar
receiptAmount	Price	No	Merchant actual received amount	Net Value. Unit : Dollar
invoiceAmount	Price	No	Merchant invoice amount	Unit : Dollar
exchangeRate	Number(8,6)	No	Exchange Rate	The rate of conversion the currency given in the request to CNY.
currency	String	No	Currency	For example: CNY
discountCode	String	No	Discount Code	assigned by Cashier POS，用于入账计折扣类型，如：2016120102|10.00表示折扣10元
discountNum	Number	No	numbers of discountCode	用于入账计折扣类型的数量
tenderCode	String	No	Tender Code	assigned by Cashier POS，用于入账计支付方式，如：2016120101|20.00表示支付20元
activityProductNo	String	No	Activity Product no.
activityProductName	String	No	Activity Product name
needSameCard	Boolean	No	Required same card payment	Such as discount upon amount reached, same credit card must be used for the payment
goodsDetail	List<goodsDetail>	No	Paid product detail	Backend response paid product detail
fundChannel	List<fundChannel>	No	Channel of fund
printDetail	Object<printDetail>	No	Printing message	Provided if required to print on the receipt
memberDetail	Object<memberDetail>	No	Member information	Member info return message on this transaction

Response body example

{
    "traceNo": "99000009100010101732123",
    "orderNo": "171698602301",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "paidAmount": 40.8,
    "receiptAmount": 40.8,
    "invoiceAmount": 40.8,
    "exchangeRate": 6.0939,
    "currency": "CNY",
    "discountCode": "0001",
    "discountNum": 20,
    "tenderCode": "8001",
    "activityProductNo": "2016123102",
    "activityProductName": "支付宝支付",
    "needSameCard": true,
    "goodsDetail": [
        {
            "goodsCategory": "001",
            "goodsId": "P00001",
            "goodsName": "牙膏",
            "price": 8,
            "quantity": 2,
            "rebateCode": "000",
            "activityNo": "2016123101",
            "memo": "100123456789"
        },
        {
            "goodsCategory": "101",
            "goodsId": "P00002",
            "goodsName": "洗发水",
            "price": 24.8,
            "quantity": 1,
            "rebateCode": "000",
            "activityNo": "2016123101",
            "memo": "100123456789"
        }
    ],
    "fundChannel": [
        {
            "channelNo": "001",
            "channelName": "用户实付现金",
            "channelAmount": "20.8"
        },
        {
            "channelNo": "002",
            "channelName": "用户积分支付",
            "channelAmount": "20"
        }
    ],
    "printDetail": {
        "cardNo64": "622562****8888",
        "bank": "中国银行",
        "paymentOrderNo": "201612315689412157458787",
        "pointSale": "20000",
        "qrCode1": "htt://www.api-location-url.com/url",
        "qrCode2": "",
        "qrCode3": "",
        "barCode1": "12345679",
        "barCode2": "",
        "barCode3": ""
    },
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Transaction support inquiry

• cardSale
• qrcodeSale

Trans Void(card)

Usage

• Invoke this API to reverse a transaction that dedicated by originalTraceNo.

Transaction Flow

• The requested transaction will send to e-Buy backend server, it will firstly invoke MIS-POS for Card swape and password input. Once MIS-POS confirmed on both inputs, it will send back to e-Buy backend server to process.

action

• voidCardSale

Request body，Cashier POS===>e-Buy Backend

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
originalTraceNo	String	Yes	last Cashier terminal trace no.	Cashier terminal trace no. in last transaction
acquirer	String	No	Acquirer Bank	Example：citicCashpay表示中信收单，如果收单撤销是必填的

Request body example

{
    "traceNo": "99000009100010101732123",
    "originalTraceNo": "99000009100010101732124",
    "acquirer": "citicCashpay"
}

Response body，e-Buy Backend===>Cashier POS

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
orderNo	String	Yes	Order No. from e-Buy
transDate	String	Yes	Transaction time	Format：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
discountCode	String	No	Discount Code	assigned by Cashier POS
tenderCode	String	No	Tender Code	assigned by Cashier POS,record payment method，like：2016120101|20.00 is payment 20yuan
fundChannel	List<fundChannel>	No	Channel of fund
printDetail	Object<printDetail>	No	Printing message	Provided if required to print on the receipt
memberDetail	Object<memberDetail>	No	Member information	Member info return message on this transaction

Response body example

{
    "traceNo": "99000009100010101732123",
    "orderNo": "171698602301",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "discountCode": "0001",
    "tenderCode": "8001",
    "fundChannel": [
        {
            "channelNo": "001",
            "channelName": "用户实付现金",
            "channelAmount": "20.8"
        },
        {
            "channelNo": "002",
            "channelName": "用户积分支付",
            "channelAmount": "20"
        }
    ],
    "printDetail": {
        "cardNo64": "622562****8888",
        "bank": "中信银行",
        "paymentOrderNo": "201612315689412157458787",
        "pointSale": "20000",
        "qrCode1": "htt://www.api-location-url.com/url",
        "qrCode2": "",
        "qrCode3": "",
        "barCode1": "12345679",
        "barCode2": "",
        "barCode3": ""
    },
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Transaction support void

• cardPayment
• cardRedemption

Trans Void(qrcode)

Usage

• Invoke this API to reverse a transaction that dedicated by originalTraceNo.

action

• voidQrcodeSale

Request body，Cashier POS===>e-Buy Backend

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
originalTraceNo	String	Yes	last Cashier terminal trace no.	Cashier terminal trace no. in last transaction

Request body example

{
    "traceNo": "99000009100010101732123",
    "originalTraceNo": "99000009100010101732124"
}

Response body，e-Buy Backend===>Cashier POS

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
orderNo	String	Yes	Order No. from e-Buy
transDate	String	Yes	Transaction time	Format：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
discountCode	String	No	Discount Code	assigned by Cashier POS
tenderCode	String	No	Tender Code	assigned by Cashier POS,record payment method，like：2016120101|20.00 is payment 20yuan
fundChannel	List<fundChannel>	No	Channel of fund
printDetail	Object<printDetail>	No	Printing message	Provided if required to print on the receipt
memberDetail	Object<memberDetail>	No	Member information	Member info return message on this transaction

Response body example

{
    "traceNo": "99000009100010101732123",
    "orderNo": "171698602301",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "discountCode": "0001",
    "tenderCode": "8001",
    "fundChannel": [
        {
            "channelNo": "001",
            "channelName": "用户实付现金",
            "channelAmount": "20.8"
        },
        {
            "channelNo": "002",
            "channelName": "用户积分支付",
            "channelAmount": "20"
        }
    ],
    "printDetail": {
        "cardNo64": "622562****8888",
        "bank": "中信银行",
        "paymentOrderNo": "201612315689412157458787",
        "pointSale": "20000",
        "qrCode1": "htt://www.api-location-url.com/url",
        "qrCode2": "",
        "qrCode3": "",
        "barCode1": "12345679",
        "barCode2": "",
        "barCode3": ""
    },
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Transaction support void

• qrcodeSale

Trans Refund(card)

Usage

• Invoke this API to refund a transaction that dedicated by originalTraceNo.

Transaction Flow

• The requested transaction will firstly invoke MIS-POS for Card swape and password input. Once MIS-POS confirmed on both inputs, it will send back to e-Buy backend server to process.

action

• refundCardSale

Request body，Cashier POS===>e-Buy Backend

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
originalTraceNo	String	Yes	last Cashier terminal trace no.	Cashier terminal trace no. in last transaction
refundAmount	Price	Yes	Refund Amount	Unit：Dollar
acquirer	String	No	Acquirer Bank	Example：citicCashpay

Request body example

{
    "traceNo": "99000009100010101732123",
    "originalTraceNo": "99000009100010101732124",
    "refundAmount": 40.8,
    "acquirer": "citicCashpay"
}

Response body，e-Buy Backend===>Cashier POS

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
orderNo	String	Yes	Order No. from e-Buy
transDate	String	Yes	Transaction time	Format：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
refundAmount	Price	Yes	Refunded Amount	Unit：Dollar
discountCode	String	No	Discount Code	assigned by Cashier POS
tenderCode	String	No	Tender Code	assigned by Cashier POS,record payment method，like：2016120101|20.00 is payment 20yuan
fundChannel	List<fundChannel>	No	Channel of fund
printDetail	Object<printDetail>	No	Printing message	Provided if required to print on the receipt
memberDetail	Object<memberDetail>	No	Member information	Member info return message on this transaction

Response body example

{
    "traceNo": "99000009100010101732123",
    "orderNo": "171698602301",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "discountCode": "0001",
    "tenderCode": "8001",
    "refundAmount": 40.8,
    "fundChannel": [
        {
            "channelNo": "001",
            "channelName": "用户实付现金",
            "channelAmount": "20.8"
        },
        {
            "channelNo": "002",
            "channelName": "用户积分支付",
            "channelAmount": "20"
        }
    ],
    "printDetail": {
        "cardNo64": "622562****8888",
        "bank": "中信银行",
        "paymentOrderNo": "201612315689412157458787",
        "pointSale": "20000",
        "qrCode1": "htt://www.api-location-url.com/url",
        "qrCode2": "",
        "qrCode3": "",
        "barCode1": "12345679",
        "barCode2": "",
        "barCode3": ""
    },
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Transaction support refund

• cardPayment
• CardRedemption

Trans Refund(qrcode)

Usage

• Invoke this API to refund a transaction that dedicated by originalTraceNo.

action

• refundQrcodeSale

Request body，Cashier POS===>e-Buy Backend

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
originalTraceNo	String	Yes	last Cashier terminal trace no.	Cashier terminal trace no. in last transaction
refundAmount	Price	Yes	Refund Amount	Unit：Dollar

Request body example

{
    "traceNo": "99000009100010101732123",
    "originalTraceNo": "99000009100010101732124",
    "refundAmount": 40.8
}

Response body，e-Buy Backend===>Cashier POS

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
orderNo	String	Yes	Order No. from e-Buy
transDate	String	Yes	Transaction time	Format：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
refundAmount	Price	Yes	Refunded Amount	Unit：Dollar
discountCode	String	No	Discount Code	assigned by Cashier POS
tenderCode	String	No	Tender Code	assigned by Cashier POS,record payment method，like：2016120101|20.00 is payment 20yuan
fundChannel	List<fundChannel>	No	Channel of fund
printDetail	Object<printDetail>	No	Printing message	Provided if required to print on the receipt
memberDetail	Object<memberDetail>	No	Member information	Member info return message on this transaction

Response body example

{
    "traceNo": "99000009100010101732123",
    "orderNo": "171698602301",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "refundAmount": 40.8,
    "discountCode": "0001",
    "tenderCode": "8001",
    "fundChannel": [
        {
            "channelNo": "001",
            "channelName": "用户实付现金",
            "channelAmount": "20.8"
        },
        {
            "channelNo": "002",
            "channelName": "用户积分支付",
            "channelAmount": "20"
        }
    ],
    "printDetail": {
        "cardNo64": "622562****8888",
        "bank": "中信银行",
        "paymentOrderNo": "201612315689412157458787",
        "pointSale": "20000",
        "qrCode1": "htt://www.api-location-url.com/url",
        "qrCode2": "",
        "qrCode3": "",
        "barCode1": "12345679",
        "barCode2": "",
        "barCode3": ""
    },
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Transaction support refund

• qrcodeSale

Ecoupon Inquiry

Usage

• Inquiry product detail \ balance \ activity of this coupon, support e-Buy Ecoupon and thirdparty ecoupon.

Transaction Flow

• The transaction process will collect QR code message thru scanning or direct input through keypad, and it will send to e-Buy backend server after collection to further process.

action

• ecouponInquiry

Request body，Cashier POS===>e-Buy Backend

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
qrcode	String	Yes	ecoupon code	ecoupon code for inquiry

Request body example

{
    "traceNo": "99000009100010101732123",
    "qrcode": "HDCP00000000001235"
}

Response body，e-Buy Backend===>Cashier POS

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
orderNo	String	Yes	Order No. from e-Buy	Unit : dollar
transDate	String	Yes	Transaction time	Format：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
canPayAmount	Price	Yes	Balance of this coupon	Unit : dollar
activityProductNo	String	No	Activity Product no.	The activity Product no. this coupon belongs to
activityProductName	String	No	Activity Product name	The activity Product name this coupon belongs to

Response body example

{
    "traceNo": "99000009100010101732123",
    "orderNo": "171698602301",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "canPayAmount": 40.8,
    "activityProductNo": "2016123101",
    "activityProductName": "中信365权益"
}

Point Accumulating

Usage

• Points accumulating

action

• accumulating

Request body，Cashier POS===>e-Buy Backend

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
totalAmount	Price	Yes	Total transaction amount	Unit : Dollar
undiscountAmount	Price	No	Undiscountable Amount	Unit : Dollar
activityNo	String	No	Activity NO	收银机集点时填写,后台集点不填
points	Integer	No	Points	收银机集点时填写,后台集点不填
goodsDetail	List<goodsDetail>	No	Goods detail	Mandated on goods detail verification
memberDetail	Object<memberDetail>	No	Member information	Mandated for member payment

Request body example

{
    "traceNo": "99000009100010101732123",
    "totalAmount": 40.8,
    "undiscountAmount": 0,
    "activityNo": "2016121901",
    "points": 100,
    "goodsDetail": [
        {
            "goodsCategory": "001",
            "goodsId": "P00001",
            "goodsName": "牙膏",
            "price": 8,
            "quantity": 2,
            "rebateCode": "000"
        },
        {
            "goodsCategory": "101",
            "goodsId": "P00002",
            "goodsName": "洗发水",
            "price": 24.8,
            "quantity": 1,
            "rebateCode": "000"
        }
    ],
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}

Response body，e-Buy Backend===>Cashier POS

Field	Type	Mandatory	Description	Memo
traceNo	String	Yes	Cashier terminal trace no.	No repeat
orderNo	String	Yes	Order No. from e-Buy	易百生成
transDate	String	Yes	Transaction time	Format：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
activityProductNo	String	No	Activity Product no.
activityProductName	String	No	Activity Product name
printDetail	Object<printDetail>	No	Printing message	Provided if required to print on the receipt
memberDetail	Object<memberDetail>	No	Member information	Member info return message on this transaction

Response body example

{
    "traceNo": "99000009100010101732123",
    "orderNo": "171698602301",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "activityProductNo": "2016123102",
    "activityProductName": "圣诞集点活动",
    "printDetail": {
        "cardNo64": "622562****8888",
        "bank": "中国银行",
        "paymentOrderNo": "201612315689412157458787",
        "pointSale": "20000",
        "qrCode1": "htt://www.xxx.com/url",
        "qrCode2": "",
        "qrCode3": "",
        "barCode1": "12345679",
        "barCode2": "",
        "barCode3": ""
    },
    "memberDetail": {
        "memberId": "M000001545",
        "memberName": "TONY",
        "grade": "1",
        "status": "1",
        "balance": 1000.00,
        "pointBalance": 30000
    }
}