Management API

Daily Summary

Usage

action

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

Field Type Mandatory Description Memo
traceNo String Yes Cashier terminal trace no. No repeat

Request body example

{
    "traceNo": "99000009100010101732123"
}

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

Field Type Mandatory Description Memo
traceNo String Yes Cashier terminal trace no. No repeat
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
settleRecord List<settleRecord> Yes Settle Record  
beginDate String Yes Settle start Format:yyyyMMddHHmmss
endDate String Yes Settle end Format:yyyyMMddHHmmss
volume Integer Yes Transaction Volume Sum of volume in settleRecord
totalReceiptAmount Price Yes Merchant Receipt Amount Sum of totalReceiptAmount in settleRecord
totalAmount Price Yes Total Amount Sum of totalAmount in settleRecord

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

action

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

Field Type Mandatory Description Memo
traceNo String Yes Cashier terminal trace No. No repeat allowed
transCount Integer Yes Upload size Should equals to size of transRecord list
beginTime String Yes Begin Time Format:yyyyMMddHHmmss
endTime String Yes End Time Format:yyyyMMddHHmmss
transRecord List<transRecord> Yes Transaction records Maximum:5000

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===>Cashier POS

Field Type Mandatory Description Memo
traceNo String Yes Cashier terminal trace No. No repeat allowed
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
transRecord List<transRecord> Yes Transaction records after match Maximum:5000

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