# Transaction API # Bank Acquiring #### **Transaction Flow** - The requested transaction will firstly invoke [MIS-POS](https://book.e-buy.com/link/124#bkmrk-mis-pos "Installed in merchants in-store POS machine, providing the operation activity to support and exchange function") for Card swape and password input. Once [MIS-POS](https://book.e-buy.com/link/124#bkmrk-mis-pos "Installed in merchants in-store POS machine, providing the operation activity to support and exchange function") confirmed on both inputs, it will send back to [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") server to process. #### **action** - `cardPayment` **Request body,Cashier POS===>[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")**
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](https://book.e-buy.com/link/333#bkmrk-goods-detail "goodsDetail")> | Yes | Goods detail | Mandated on goods detail verification |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Mandated on member payment |
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](https://book.e-buy.com/link/333#bkmrk-goods-detail "goodsDetail")> | No | Paid product detail | Backend response paid product detail |
fundChannel | List<[fundChannel](https://book.e-buy.com/link/333#bkmrk-fund-channel "fundChannel")> | No | Channel of fund | |
printDetail | Object<[printDetail](https://book.e-buy.com/link/333#bkmrk-print-detail "printDetail")> | No | Printing message | Provided if required to print on the receipt |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Member info return message on this transaction |
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](https://book.e-buy.com/link/333#bkmrk-goods-detail "goodsDetail")> | Yes | Goods detail | Mandated on goods detail verification |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Mandated on member payment |
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](https://book.e-buy.com/link/333#bkmrk-goods-detail "goodsDetail")> | No | Paid product detail | Backend response paid product detail |
fundChannel | List<[fundChannel](https://book.e-buy.com/link/333#bkmrk-fund-channel "fundChannel")> | No | Channel of fund | |
printDetail | Object<[printDetail](https://book.e-buy.com/link/333#bkmrk-print-detail "printDetail")> | No | Printing message | Provided if required to print on the receipt |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Member info return message on this transaction |
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](https://book.e-buy.com/link/333#bkmrk-goods-detail "goodsDetail")> | Yes | Goods detail | Mandated on goods detail verification |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Mandated for member payment |
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](https://book.e-buy.com/link/333#bkmrk-goods-detail "goodsDetail")> | No | Paid product detail | Backend response paid product detail |
fundChannel | List<[fundChannel](https://book.e-buy.com/link/333#bkmrk-fund-channel "fundChannel")> | No | Channel of fund | |
printDetail | Object<[printDetail](https://book.e-buy.com/link/333#bkmrk-print-detail "printDetail")> | No | Printing message | Provided if required to print on the receipt |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Member info return message on this transaction |
Field | Type | Mandatory | Description | Memo |
---|---|---|---|---|
traceNo | String | Yes | Cashier trace no. | No repeat |
originalTraceNo | String | Yes | Original Cashier trace no. | 传入需要查询的原交易收银机流水号 |
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](https://book.e-buy.com/link/333#bkmrk-goods-detail "goodsDetail")> | No | Paid product detail | Backend response paid product detail |
fundChannel | List<[fundChannel](https://book.e-buy.com/link/333#bkmrk-fund-channel "fundChannel")> | No | Channel of fund | |
printDetail | Object<[printDetail](https://book.e-buy.com/link/333#bkmrk-print-detail "printDetail")> | No | Printing message | Provided if required to print on the receipt |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Member info return message on this transaction |
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表示中信收单,如果收单撤销是必填的 |
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](https://book.e-buy.com/link/333#bkmrk-fund-channel "fundChannel")> | No | Channel of fund | |
printDetail | Object<[printDetail](https://book.e-buy.com/link/333#bkmrk-print-detail "printDetail")> | No | Printing message | Provided if required to print on the receipt |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Member info return message on this transaction |
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 |
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](https://book.e-buy.com/link/333#bkmrk-fund-channel "fundChannel")> | No | Channel of fund | |
printDetail | Object<[printDetail](https://book.e-buy.com/link/333#bkmrk-print-detail "printDetail")> | No | Printing message | Provided if required to print on the receipt |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Member info return message on this transaction |
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 |
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](https://book.e-buy.com/link/333#bkmrk-fund-channel "fundChannel")> | No | Channel of fund | |
printDetail | Object<[printDetail](https://book.e-buy.com/link/333#bkmrk-print-detail "printDetail")> | No | Printing message | Provided if required to print on the receipt |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Member info return message on this transaction |
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 |
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](https://book.e-buy.com/link/333#bkmrk-fund-channel "fundChannel")> | No | Channel of fund | |
printDetail | Object<[printDetail](https://book.e-buy.com/link/333#bkmrk-print-detail "printDetail")> | No | Printing message | Provided if required to print on the receipt |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Member info return message on this transaction |
Field | Type | Mandatory | Description | Memo |
---|---|---|---|---|
traceNo | String | Yes | Cashier terminal trace no. | No repeat |
qrcode | String | Yes | ecoupon code | ecoupon code for inquiry |
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 |
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](https://book.e-buy.com/link/333#bkmrk-goods-detail "goodsDetail")> | No | Goods detail | Mandated on goods detail verification |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Mandated for member payment |
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](https://book.e-buy.com/link/333#bkmrk-print-detail "printDetail")> | No | Printing message | Provided if required to print on the receipt |
memberDetail | Object<[memberDetail](https://book.e-buy.com/link/333#bkmrk-member-detail "memberDetail")> | No | Member information | Member info return message on this transaction |