# Management API



# Daily Summary

#### **Usage**

- Invoke this API to summarize success transactions between current and last summary.

#### **action**

- `summary`

**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")**

<table id="bkmrk-field-type-mandatory"><thead><tr><th>Field</th><th>Type</th><th>Mandatory</th><th>Description</th><th>Memo</th></tr></thead><tbody><tr><td>traceNo</td><td>String</td><td>Yes</td><td>Cashier terminal trace no.</td><td>No repeat</td></tr></tbody></table>

#### **Request body example**

```
{
    "traceNo": "99000009100010101732123"
}

```

**Response body，[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")===&gt;Cashier POS**

<table id="bkmrk-field-type-mandatory-0" style="height: 381px;"><thead><tr style="height: 45px;"><th style="width: 143.969px; height: 45px;">Field</th><th style="width: 145px; height: 45px;">Type</th><th style="width: 58px; height: 45px;">Mandatory</th><th style="width: 178px; height: 45px;">Description</th><th style="width: 284.016px; height: 45px;">Memo</th></tr></thead><tbody><tr style="height: 29px;"><td style="width: 143.969px; height: 29px;">traceNo</td><td style="width: 145px; height: 29px;">String</td><td style="width: 58px; height: 29px;">Yes</td><td style="width: 178px; height: 29px;">Cashier terminal trace no.</td><td style="width: 284.016px; height: 29px;">No repeat</td></tr><tr style="height: 29px;"><td style="width: 143.969px; height: 29px;">transDate</td><td style="width: 145px; height: 29px;">String</td><td style="width: 58px; height: 29px;">Yes</td><td style="width: 178px; height: 29px;">Transaction time</td><td style="width: 284.016px; height: 29px;">Format：yyyyMMddHHmmss</td></tr><tr style="height: 45px;"><td style="width: 143.969px; height: 45px;">returnCode</td><td style="width: 145px; height: 45px;">String</td><td style="width: 58px; height: 45px;">Yes</td><td style="width: 178px; height: 45px;">Return code</td><td style="width: 284.016px; height: 45px;">00 represent successful transaction, else represent fail</td></tr><tr style="height: 45px;"><td style="width: 143.969px; height: 45px;">returnDesc</td><td style="width: 145px; height: 45px;">String</td><td style="width: 58px; height: 45px;">Yes</td><td style="width: 178px; height: 45px;">Return message</td><td style="width: 284.016px; height: 45px;">Detail explanation / error message per transaction result</td></tr><tr style="height: 27px;"><td style="width: 143.969px; height: 27px;">settleRecord</td><td style="width: 145px; height: 27px;">List&lt;[settleRecord](https://book.e-buy.com/link/333#bkmrk-settle-record "settleRecord")&gt;</td><td style="width: 58px; height: 27px;">Yes</td><td style="width: 178px; height: 27px;">Settle Record</td><td style="width: 284.016px; height: 27px;"> </td></tr><tr style="height: 29px;"><td style="width: 143.969px; height: 29px;">beginDate</td><td style="width: 145px; height: 29px;">String</td><td style="width: 58px; height: 29px;">Yes</td><td style="width: 178px; height: 29px;">Settle start</td><td style="width: 284.016px; height: 29px;">Format：yyyyMMddHHmmss</td></tr><tr style="height: 29px;"><td style="width: 143.969px; height: 29px;">endDate</td><td style="width: 145px; height: 29px;">String</td><td style="width: 58px; height: 29px;">Yes</td><td style="width: 178px; height: 29px;">Settle end</td><td style="width: 284.016px; height: 29px;">Format：yyyyMMddHHmmss</td></tr><tr style="height: 29px;"><td style="width: 143.969px; height: 29px;">volume</td><td style="width: 145px; height: 29px;">Integer</td><td style="width: 58px; height: 29px;">Yes</td><td style="width: 178px; height: 29px;">Transaction Volume</td><td style="width: 284.016px; height: 29px;">Sum of volume in settleRecord</td></tr><tr style="height: 45px;"><td style="width: 143.969px; height: 45px;">totalReceiptAmount</td><td style="width: 145px; height: 45px;">Price</td><td style="width: 58px; height: 45px;">Yes</td><td style="width: 178px; height: 45px;">Merchant Receipt Amount</td><td style="width: 284.016px; height: 45px;">Sum of totalReceiptAmount in settleRecord</td></tr><tr style="height: 29px;"><td style="width: 143.969px; height: 29px;">totalAmount</td><td style="width: 145px; height: 29px;">Price</td><td style="width: 58px; height: 29px;">Yes</td><td style="width: 178px; height: 29px;">Total Amount</td><td style="width: 284.016px; height: 29px;">Sum of totalAmount in settleRecord</td></tr></tbody></table>

#### **Response body example**

```
{
    "traceNo": "99000009100010101732123",
    "transDate": "20161231102201",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "settleRecord": [
        {
            "activityNo": "2016101201",
            "activityName": "浦发银行积分兑换",
            "productName": "大杯",
            "customer": "浦发银行",
            "isRefund": false,
            "volume": 130,
            "totalReceiptAmount": "2082.10",
            "totalAmount": "2082.10"
        },
        {
            "activityNo": "2016120301",
            "activityName": "支付宝",
            "productName": "全场产品",
            "customer": "易百支付",
            "isRefund": false,
            "volume": 100,
            "totalReceiptAmount": "234.10",
            "totalAmount": "234.10"
        }
    ],
    "beginDate": "20161029113602",
    "endDate": "20161030113602",
    "volume": 230,
    "totalReceiptAmount": 1900,
    "totalAmount": 2000,
}
```

# Batch Upload

#### **Usage**

- Batch upload transaction records 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"), and will be matched and return.Only support the transactions within 7 Days.

#### **action**

- `batchUpload`

**Request body，Cashier POS===&gt;[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")**

<table id="bkmrk-field-type-mandatory" style="width: 797px; height: 168px;"><thead><tr style="height: 29px;"><th style="width: 99px; height: 29px;">Field</th><th style="width: 147px; height: 29px;">Type</th><th style="width: 101px; height: 29px;">Mandatory</th><th style="width: 186px; height: 29px;">Description</th><th style="width: 264px; height: 29px;">Memo</th></tr></thead><tbody><tr style="height: 29px;"><td style="width: 99px; height: 29px;">traceNo</td><td style="width: 147px; height: 29px;">String</td><td style="width: 101px; height: 29px;">Yes</td><td style="width: 186px; height: 29px;">Cashier terminal trace No.</td><td style="width: 264px; height: 29px;">No repeat allowed</td></tr><tr style="height: 29px;"><td style="width: 99px; height: 29px;">transCount</td><td style="width: 147px; height: 29px;">Integer</td><td style="width: 101px; height: 29px;">Yes</td><td style="width: 186px; height: 29px;">Upload size</td><td style="width: 264px; height: 29px;">Should equals to size of transRecord list</td></tr><tr style="height: 29px;"><td style="width: 99px; height: 29px;">beginTime</td><td style="width: 147px; height: 29px;">String</td><td style="width: 101px; height: 29px;">Yes</td><td style="width: 186px; height: 29px;">Begin Time</td><td style="width: 264px; height: 29px;">Format：yyyyMMddHHmmss</td></tr><tr style="height: 29px;"><td style="width: 99px; height: 29px;">endTime</td><td style="width: 147px; height: 29px;">String</td><td style="width: 101px; height: 29px;">Yes</td><td style="width: 186px; height: 29px;">End Time</td><td style="width: 264px; height: 29px;">Format：yyyyMMddHHmmss</td></tr><tr style="height: 23px;"><td style="width: 99px; height: 23px;">transRecord</td><td style="width: 147px; height: 23px;">List&lt;[transRecord](https://book.e-buy.com/link/333#bkmrk-trans-record "transRecord")&gt;</td><td style="width: 101px; height: 23px;">Yes</td><td style="width: 186px; height: 23px;">Transaction records</td><td style="width: 264px; height: 23px;">Maximum：5000</td></tr></tbody></table>

#### **Request body example**

```
{
    "traceNo": "99000009100010101732123",
    "transCount": 3,
    "beginTime": "20161231102201",
    "endTime": "20161231102230",
    "transRecord": [
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 100.00,
          "status": 0
      },
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 200.00,
          "status": 0
      },
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 300.00,
          "status": 0
      }
    ]
}

```

**Response body，[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")===&gt;Cashier POS**

<table id="bkmrk-field-type-mandatory-0" style="height: 188px;"><thead><tr style="height: 45px;"><th style="height: 24px; width: 100px;">Field</th><th style="height: 24px; width: 86px;">Type</th><th style="height: 24px; width: 91px;">Mandatory</th><th style="height: 24px; width: 181px;">Description</th><th style="height: 24px; width: 349px;">Memo</th></tr></thead><tbody><tr style="height: 29px;"><td style="height: 29px; width: 100px;">traceNo</td><td style="height: 29px; width: 86px;">String</td><td style="height: 29px; width: 91px;">Yes</td><td style="height: 29px; width: 181px;">Cashier terminal trace No.</td><td style="height: 29px; width: 349px;">No repeat allowed</td></tr><tr style="height: 29px;"><td style="height: 29px; width: 100px;">transDate</td><td style="height: 29px; width: 86px;">String</td><td style="height: 29px; width: 91px;">Yes</td><td style="height: 29px; width: 181px;">Transaction time</td><td style="height: 29px; width: 349px;">Format：yyyyMMddHHmmss</td></tr><tr style="height: 45px;"><td style="height: 12px; width: 100px;">returnCode</td><td style="height: 12px; width: 86px;">String</td><td style="height: 12px; width: 91px;">Yes</td><td style="height: 12px; width: 181px;">Return code</td><td style="height: 12px; width: 349px;">00 represent successful transaction, else represent fail</td></tr><tr style="height: 45px;"><td style="height: 37px; width: 100px;">returnDesc</td><td style="height: 37px; width: 86px;">String</td><td style="height: 37px; width: 91px;">Yes</td><td style="height: 37px; width: 181px;">Return message</td><td style="height: 37px; width: 349px;">Detail explanation / error message per transaction result</td></tr><tr style="height: 57px;"><td style="height: 57px; width: 100px;">transRecord</td><td style="height: 57px; width: 86px;">List&lt;[transRecord](https://book.e-buy.com/link/333#bkmrk-trans-record "transRecord")&gt;</td><td style="height: 57px; width: 91px;">Yes</td><td style="height: 57px; width: 181px;">Transaction records after match</td><td style="height: 57px; width: 349px;">Maximum：5000</td></tr></tbody></table>

#### **Response body example**

```
{
    "traceNo": "99000009100010101732123",
    "transDate": "20161231120533",
    "returnCode": "00",
    "returnDesc": "SUCCESS",
    "transRecord": [
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 100.00,
          "status": 1
      },
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 200.00,
          "status": 2
      },
      {
          "traceNo": "99000009100010101732123",
          "paidAmount": 300.00,
          "status": 3
      }
    ]
}
```