交易类接口
电子券核销/二维码被扫
接口用途
接口地址
请求参数
字段 |
类型 |
是否必填 |
字段意义 |
备注 |
---|
traceNo |
String |
是 |
app流水号 |
不允许重复 |
totalAmount |
Price |
是 |
交易总金额 |
单位:元 |
qrcode |
String |
是 |
二维码内容 |
二维码内容 |
请求报文举例
{
"traceNo": "990000091000101620150201",
"totalAmount": 40.8,
"qrcode": "280123121234567890"
}
返回参数
字段 |
类型 |
是否必填 |
字段意义 |
备注 |
---|
traceNo |
String |
是 |
收银机流水号 |
不允许重复 |
orderNo |
String |
是 |
交易订单号 |
易百系统参考号 |
transDate |
String |
是 |
交易时间 |
格式为:yyyyMMddHHmmss |
returnCode |
String |
是 |
返回码 |
00表示交易成功,其他表示失败 |
returnDesc |
String |
是 |
返回信息 |
交易结果描述或错误原因 |
paidAmount |
Price |
是 |
支付成功总金额 |
单位:元 |
receiptAmount |
Price |
否 |
商户实收金额 |
单位:元 |
invoiceAmount |
Price |
否 |
商户开票金额 |
单位:元 |
canPayAmount |
Price |
是 |
电子券面值 |
单位:元 |
exchangeRate |
Number(8,6) |
否 |
汇率 |
1外币等于多少人民币 |
currency |
String |
否 |
货币类型 |
例如:CNY |
activityProductNo |
String |
否 |
活动产品编号 |
|
activityProductName |
String |
否 |
活动产品名称 |
|
voucherDetail |
List<voucherDetail> |
否 |
优惠券信息 |
返回本次交易的优惠券信息 |
返回报文举例
{
"extendsData":{
},
"returnCode":"00",
"remainTimes":0,
"invoiceAmount":1000,
"receiptAmount":1000,
"activityProductNo":"00000000507096",
"transDate":"20190909150302",
"activityProductName":"ビックカメラ1000円分クーポン券",
"orderNo":"181481000584",
"voucherDetail":[
{
"voucherCode":"10010596750080404109"
}
],
"canPayAmount":1000,
"paidAmount":1000,
"traceNo":"794_40392571_1568008981496",
"uuid":"c8c668e356b441ccbd6e253d1992eae3",
"returnDesc":"SUCCESS",
"step":"01",
"rpcContext":"10.255.3.71:46120-->10.255.3.71:30032"
}
查询交易结果
接口用途
接口地址
请求参数
字段 |
类型 |
是否必填 |
字段意义 |
备注 |
---|
traceNo |
String |
是 |
app流水号 |
不允许重复 |
originalTraceNo |
String |
是 |
原app流水号 |
请求报文举例
{
"traceNo": "APPTEST9100010101732123012",
"originalTraceNo": "APPTEST9100010101732123018"
}
返回参数
字段 |
类型 |
是否必填 |
字段意义 |
备注 |
---|
traceNo |
String |
是 |
收银机流水号 |
不允许重复 |
orderNo |
String |
是 |
交易订单号 |
易百系统参考号 |
transDate |
String |
是 |
交易时间 |
格式为:yyyyMMddHHmmss |
returnCode |
String |
是 |
返回码 |
00表示交易成功,其他表示失败 |
returnDesc |
String |
是 |
返回信息 |
交易结果描述或错误原因 |
paidAmount |
Price |
是 |
支付成功总金额 |
单位:元 |
receiptAmount |
Price |
否 |
商户实收金额 |
单位:元 |
invoiceAmount |
Price |
否 |
商户开票金额 |
单位:元 |
canPayAmount |
Price |
是 |
电子券面值 |
单位:元 |
exchangeRate |
Number(8,6) |
否 |
汇率 |
1外币等于多少人民币 |
currency |
String |
否 |
货币类型 |
例如:CNY |
activityProductNo |
String |
否 |
活动产品编号 |
|
activityProductName |
String |
否 |
活动产品名称 |
|
voucherDetail |
List<voucherDetail> |
否 |
优惠券信息 |
返回本次交易的优惠券信息 |
返回报文举例
{
"extendsData":{
},
"returnCode":"00",
"remainTimes":0,
"invoiceAmount":1000,
"receiptAmount":1000,
"activityProductNo":"00000000507096",
"transDate":"20190909150302",
"activityProductName":"ビックカメラ1000円分クーポン券",
"orderNo":"181481000584",
"voucherDetail":[
{
"voucherCode":"10010596750080404109"
}
],
"canPayAmount":1000,
"paidAmount":1000,
"traceNo":"794_40392571_1568008981496",
"uuid":"c8c668e356b441ccbd6e253d1992eae3",
"returnDesc":"SUCCESS",
"step":"01",
"rpcContext":"10.255.3.71:46120-->10.255.3.71:30032"
}
撤销
接口用途
- 撤销原交易(上送交易时间且不为当日时会自动调用业务主机退款接口)
接口地址
请求参数
字段 |
类型 |
是否必填 |
字段意义 |
备注 |
---|
traceNo |
String |
是 |
app流水号 |
不允许重复 |
originalTraceNo |
String |
是 |
原app流水号 |
请求报文举例
{
"traceNo": "APPTEST9100010101732123012",
"originalTraceNo": "APPTEST9100010101732123018"
}
返回参数
字段 |
类型 |
是否必填 |
字段意义 |
备注 |
---|
traceNo |
String |
是 |
收银机流水号 |
不允许重复 |
orderNo |
String |
是 |
交易订单号 |
易百系统参考号 |
transDate |
String |
是 |
交易时间 |
格式为:yyyyMMddHHmmss |
returnCode |
String |
是 |
返回码 |
00表示交易成功,其他表示失败 |
returnDesc |
String |
是 |
返回信息 |
交易结果描述或错误原因 |
paidAmount |
Price |
是 |
支付成功总金额 |
单位:元 |
receiptAmount |
Price |
否 |
商户实收金额 |
单位:元 |
invoiceAmount |
Price |
否 |
商户开票金额 |
单位:元 |
exchangeRate |
Number(8,6) |
否 |
汇率 |
1外币等于多少人民币 |
currency |
String |
否 |
货币类型 |
例如:CNY |
activityProductNo |
String |
否 |
活动产品编号 |
|
activityProductName |
String |
否 |
活动产品名称 |
|
voucherDetail |
List<voucherDetail> |
否 |
优惠券信息 |
返回本次交易的优惠券信息 |
返回报文举例
{
"extendsData":{
},
"returnCode":"00",
"invoiceAmount":0,
"receiptAmount":0,
"transDate":"20190909184245",
"activityProductName":"ビックカメラ1000円分クーポン券",
"orderNo":"181481000589",
"voucherDetail":[
{
"voucherCode":"10010526553080405449"
}
],
"paidAmount":0,
"traceNo":"209_59392775_1568022164957",
"uuid":"fccd5fccae5a4efe88222439bd530d9d",
"returnDesc":"操作成功",
"rpcContext":"10.255.3.71:46120-->10.255.3.71:30032",
"step":"01"
}
筛选交易列表
接口用途
接口地址
请求参数
字段 |
类型 |
是否必填 |
字段意义 |
备注 |
---|
traceNo |
String |
是 |
app流水号 |
不允许重复 |
beginDateTime |
String |
否 |
筛选开始时间 |
2019-06-20 12:00:00(不填默认当天0点) |
endDateTime |
String |
否 |
筛选结束时间 |
2019-06-25 23:59:59(不填默认此刻) |
pagesize |
int |
是 |
每页条数 |
50 |
pageno |
int |
是 |
当前页数 |
1 |
noStatistics |
String |
否 |
无需可视化图表数据 |
默认yes |
conditionInfo |
ConditionInfo |
是 |
其他筛选条件 |
只上送筛选项 |
请求报文举例
{
"traceNo": "APPTEST9100010101732123013",
"beginDateTime": "2019-06-10 00:00:00",
"endDateTime": "2019-06-18 23:59:59",
"pagesize": 50,
"pageno": 1,
"noStatistics": "yes",
"conditionInfo": {
"transType": "010", //核销 撤销 退款
"returnCode": "!00" //!为不等于
}
}
返回参数
字段 |
类型 |
是否必填 |
字段意义 |
备注 |
---|
returnCode |
String |
是 |
返回码 |
00表示交易成功,其他表示失败 |
returnDesc |
String |
是 |
返回信息 |
交易结果描述或错误原因 |
totalamount |
Price |
是 |
统计总金额 |
单位:元 |
totalcount |
int |
否 |
统计总笔数 |
单位:元 |
saleamount |
Price |
否 |
交易金额 |
单位:元 |
refundamount |
Price |
否 |
退款金额 |
单位:元 |
currency |
String |
否 |
货币类型 |
例如:CNY |
entitys |
List<TransInfo> |
否 |
交易列表 |
|
dateDatasList |
List<DateData> |
否 |
按日统计结果 |
|
appNameDatasList |
List<AppNameData> |
否 |
按应用统计结果 |
返回报文举例
{
"dateDatasList": [{
"amount": 0.02,
"name": "20190402",
"count": 3
},{
"amount": 0.02,
"name": "20190403",
"count": 3
}],
"totalcount": 3,
"returnCode": "00",
"totalamount": 0.02,
"saleamount": 0.02,
"appNameDatasList": [{
"amount": 0.02,
"name": "Alipay",
"count": 2
},{
"amount": 0,
"count": 1,
"name": "Ecoupon"
}],
"currency": "CNY",
"refundamount": 0,
"returnDesc": "获取成功",
"entitys": [
{
"createTime": 1569922420000,
"returnCode": "00",
"transtime": "183340",
"transcationId": 514,
"posno": "",
"transdate": "20191001",
"isRefund": "0",
"amount": "333.33",
"appName": "Ecoupon",
"isVoid": "0",
"orderNo": "29_36392055_1569922420023",
"nickName": "matsuya001店長",
"qrcode": "10010506195921748853",
"transclass": "ecoupon-verify",
"traceNo": "29_36392055_1569922420023"
},
{
"returnCode": "00",
"transtime": "145027",
"amount": "0.01",
"orderNo": "EP1904021450400686002000106",
"nickName": "matsuya001店長",
"transclass": "qrpay-sale",
"isVoid": "0",
"createTime": 1554187835000,
"appName": "AlipayQrpay",
"isRefund": "0",
"transcationId": 1098,
"transdate": "20190402"
},
{
"returnCode": "00",
"transtime": "143719",
"amount": "0.01",
"orderNo": "EP1904021437320686002000098",
"nickName": "matsuya001店長",
"transclass": "qrpay-sale",
"isVoid": "0",
"createTime": 1554187047000,
"appName": "AlipayQrpay",
"isRefund": "0",
"transcationId": 1097,
"transdate": "20190403"
}
],
}
新页面按券号查询历史交易
接口用途
接口地址
请求参数
字段 |
类型 |
是否必填 |
字段意义 |
备注 |
---|
traceNo |
String |
是 |
app流水号 |
不允许重复 |
conditionInfo |
ConditionInfo |
是 |
其他筛选条件 |
只上送筛选项 |
请求报文举例
{
"traceNo": "APPTEST9100010101732123013",
"conditionInfo": {
"qrcode": "12312312313123"
}
}
返回参数
字段 |
类型 |
是否必填 |
字段意义 |
备注 |
---|
returnCode |
String |
是 |
返回码 |
00表示交易成功,其他表示失败 |
returnDesc |
String |
是 |
返回信息 |
交易结果描述或错误原因 |
totalamount |
Price |
是 |
统计总金额 |
单位:元 |
totalcount |
int |
否 |
统计总笔数 |
单位:元 |
saleamount |
Price |
否 |
交易金额 |
单位:元 |
refundamount |
Price |
否 |
退款金额 |
单位:元 |
currency |
String |
否 |
货币类型 |
例如:CNY |
entitys |
List<TransInfo> |
否 |
交易列表 |
|
dateDatasList |
List<DateData> |
否 |
按日统计结果 |
|
appNameDatasList |
List<AppNameData> |
否 |
按应用统计结果 |
返回报文举例
{
"dateDatasList": [{
"amount": 0.02,
"name": "20190402",
"count": 3
},{
"amount": 0.02,
"name": "20190403",
"count": 3
}],
"totalcount": 3,
"returnCode": "00",
"totalamount": 0.02,
"saleamount": 0.02,
"appNameDatasList": [{
"amount": 0.02,
"name": "Alipay",
"count": 2
},{
"amount": 0,
"count": 1,
"name": "Ecoupon"
}],
"currency": "CNY",
"refundamount": 0,
"returnDesc": "获取成功",
"entitys": [
{
"createTime": 1569922420000,
"returnCode": "00",
"transtime": "183340",
"transcationId": 514,
"posno": "",
"transdate": "20191001",
"isRefund": "0",
"amount": "333.33",
"appName": "Ecoupon",
"isVoid": "0",
"orderNo": "29_36392055_1569922420023",
"nickName": "matsuya001店長",
"qrcode": "10010506195921748853",
"transclass": "ecoupon-verify",
"traceNo": "29_36392055_1569922420023"
},
{
"returnCode": "00",
"transtime": "145027",
"amount": "0.01",
"orderNo": "EP1904021450400686002000106",
"nickName": "matsuya001店長",
"transclass": "qrpay-sale",
"isVoid": "0",
"createTime": 1554187835000,
"appName": "AlipayQrpay",
"isRefund": "0",
"transcationId": 1098,
"transdate": "20190402"
},
{
"returnCode": "00",
"transtime": "143719",
"amount": "0.01",
"orderNo": "EP1904021437320686002000098",
"nickName": "matsuya001店長",
"transclass": "qrpay-sale",
"isVoid": "0",
"createTime": 1554187047000,
"appName": "AlipayQrpay",
"isRefund": "0",
"transcationId": 1097,
"transdate": "20190403"
}
],
}