结算记录查询接口

功能概述

本接口商户用于查询子商户结算记录。

接口地址

https://apis.5upay.com/settlement/record/query

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
merchantId 商户编号 varchar(9) 商户在首信易系统的唯一id,可在商户后台查看 M
partnerId 服务商id varchar(9) 服务商在首信易系统的唯一id,可在商户后台查看 C
startDateTime 结算发起时间起始日期 datatime yyyy-MM-dd HH:mm:ss,起始日期与结束日期,最多相隔 30 天。 M
endDateTime 结算发起时间结束日期 varchar(9) yyyy-MM-dd HH:mm:ss,起始日期与结束日期,最多相隔 30 天。 C
hmac 参数签名 varchar(500) 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 M

注意:以上参数值中不能包含以下特殊字符 ' " & < > ( ) 空格

参数示例

{ "merchantId": "120140762", "partnerId": "", "startDateTime": "2020-06-22 00:00:00", "endDateTime": "2020-06-22 23:59:59", "hmac": null }

请求返回参数列表

参数名称 参数中文名称 参数说明
merchantId 商户编号 同请求参数
partnerId 服务商Id 同请求参数
startDateTime 结算发起时间起始日期 同请求参数
endDateTime 结算发起时间结束日期 同请求参数
total 查询结果条数 查询结果条数
records 记录列表 见记录列表
hmac 参数签名 首信易生成的参数签名结果,验签过程请参考解密流程

基本信息参数列表

参数名称 参数中文名称 参数说明
amount 结算金额 单位:分,1 元=100 分
currency 币种 CNY 人民币
USD 美元
JPY 日元
EUR 欧元
CHF 瑞士法郎
GBP 英镑
CAD 加拿大元
AUD 澳大利亚元
HKD 港币
settleStatus 结算状态 CONFIRMED 已确认
WITHHOLDING 已扣款
SETTLEMENTING 结算中
SUCCESS 结算成功 --成功终态
FAIL_RETURN 失败退回 -- 失败终态
remitStatus 打款状态 INIT 待打款
REMITING 打款中
SUCCESS 打款成功
FAIL 打款失败
refundStatus 退票状态 若打款发生退票,则状态为 REFUNDING:已退票
startDate 起始日期 统计结算金额的起始日期 yyyy-MM-dd
endDate 截止日期 统计结算金额的截止日期 yyyy-MM-dd
createDateTime 结算发起时间 发起结算的开始时间 yyyy-MM-dd HH:mm:ss
remark 结算备注 在结算时记录的备注信息
errorMessage 结算失败原因 若结算失败会展示失败原因

参数示例

{ "endDateTime": "2020-06-22 23:59:59", "hmac":"WWAfW984rSrNdZaidTQuTvPEt6Z6fmhWEbVBmL3vepUZ225qDqr36iGEdpaQJyIrY2sJjWr CdK0ioQ4WG2RNK9eG+ZEzcSmTzM2DCUg8OPonvmClOPJwS6H94USf0j5DRgZysYma6Ho Z7tRqGPi4BvHerkd6y5BfE3TRIhpoiYaXgW98iXpI/1YQGV8lBL8fJ0EHytLWGFD88Ps2kL/6f QUH+6RIhXOEUZteNKO2Et7+4l+HhqROq/+KqjF0GicVHdeRLWHQwxu8lw+fxYhq4ozuF8L GRjDjrTSJaJjPSCIkUzGJExxGR31wq/bQb82cTS4y0/EDqApoRe41mRm3gA==", "merchantId": "120140762", "records": [{ "amount": 4377189.00, "createDateTime": "2020-06-22 11:46:02", "currency": "CNY", "endDate": "2020-06-21 00:00:00", "remark": "", "settleStatus": "CONFIRMED", "startDate": "2016-11-25 00:00:00" }, { "amount": 4377189.00, "createDateTime": "2020-06-22 13:31:02", "currency": "CNY", "endDate": "2020-06-21 00:00:00", "remark": "", "settleStatus": "CONFIRMED", "startDate": "2016-11-25 00:00:00" }], "startDateTime": "2020-06-22 00:00:00", "total": 2 }