订单获取对账单下载地址

1.修订记录

修订 日期 说明 作者
V0.1 2016/4/13 新接口参数定义 郭勇
V0.2 2016/4/25 修改请求方法名称 易显群
V0.3 2016/5/20 增加业务参数说明 易显群
V0.4 2016/9/08 增加异常描述 郭勇
V0.5 2021/12/27 支持国密 王晶

2.接口说明

(1)场景说明

1、获取订单对账单的地址,需要调用此接口

(2)接口说明

1、根据服务商商户号及日期,获取对应的对账单地址,然后按返回地址下载对账单文件

3.请求地址

环境 HTTPS请求地址
正式环境 https://openapi.ysepay.com/gateway.do

4.请求参数说明

4.1公共请求参数

参数 类型(字节长度) 必填 参数说明
method String(128) Y 接口名称 固定值 ysepay.online.bill.downloadurl.get
partner_id String(20) Y 在银盛支付开设的服务商商户号,请联系客户经理提供
timestamp String(19) Y 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50
charset String(10) Y 商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK
sign_type String(10) Y 报文签名算法,RSA/SM
sign String(256) Y 签名字符串,再用Base64编码
version String(3) Y 接口版本3.0 当前版本:3.0
biz_content String Y 业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递

4.2 业务请求参数

参数名biz_content,值为一个json格式对象,下面列表描述json对象的值

参数 类型(字节长度) 必填 参数说明
account_date String(10) Y 会计日期:日账单格式为yyyy-MM-dd 示例值:2016-04-13

5.返回参数说明

银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。

请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。

5.1 公共响应参数

参数 类型(字节长度) 必填 参数说明
sign String Y 签名字符串,Base64编码
ysepay_online_bill_downloadurl_get_response String Y 业务响应参数的集合,最大长度不限

5.2 业务响应参数

参数 参数类型 必填 参数说明
code String Y 响应代码
msg String Y 响应代码描述
bill_download_url String(2048) Y 账单下载地址链接,获取连接后30秒后未下载,链接地址失效 示例值: http://download.ysepay.com/Cv1dF1Cuy8ezofoFAAADB_ClX6I350.zip

6.样例

本文介绍银盛支付【即时到帐对账单】,对账单文件格式为zip,开发文档文件名会不断扩展,开发时请注意兼容性。

6.1 正交易参数

参数 类型 必填 参数说明
PAYEE_USERCODE String Y 收款方用户号
accountdate String Y 会计日期,格式为yyyy-MM-dd 示例值:2016-04-13
payment String Y 交易类型,即时到帐:real-time transfer担保交易:guarantee transfer
ORDERID String Y 商家订单号
TRANDESN String Y 银盛支付流水号
paymode String Y 支付方式
ORDERAMOUNT String Y 订单交易金额
payee_fee+(src_fee) String Y 手续费,商户为收款方,如果发起方和收款方为同一个则要相加
STATE String Y 交易状态,00 交易成功
REMARK String N 订单备注
coupon_Info String N 优惠信息, 当活动对象为多个时,coupon_Info中就有多方优惠信息spnsrId出资方,值为1时银联出资,值为2时付款方出资,值为3时商户出资offstAmt优惠金额
settlement_amount String N 结算金额,当出资方为银联、付款人的情况下,结算金额 = 订单金额 - 手续费 当出资方为商户的情况下,结算金额 = 订单金额 - 优惠金额 - 手续费
createtime String Y 订单创建时间,格式:yyyy-MM-dd HH:mm:ss

示例:

wuzl05,20160719,payment,86044172,311160719003501069,02,0.21,0.0,00,电子df 3产品, [{offstAmt=1.0| spnsrId=1}| {offstAmt=2.0| spnsrId=2}],0.21,2021-08-16 12:12:12

6.2 反交易参数

参数 类型 必填 参数说明
org_PAYEE_USERCODE String Y 原收款方用户号
accountdate String Y 会计日期
refund String Y 交易类型,即时到帐(退款):real-time transfer refund担保交易(退款):guarantee transfer refund
refund_orderid String Y 退款订单号
refundsn String Y 银盛流水号
refundamount String Y 本次退款金额
org_Orderid String Y 原商家订单号
org_amount String Y 原交易金额
payee_fee+(src_fee) String Y 本次退款返还手费,如果部分退款为则为该笔退款订单退还手续费,如果全部退款为原手续费
STATE String Y 退款状态,00 交易成功
refundApproach String N 退款途径,Y表示直联退款,N表示商户门户退款
is_cancel String N 是否为撤销交易,1是, 0否
coupon_Info String N 优惠信息, 当活动对象为多个时,coupon_Info中就有多方优惠信息spnsrId出资方,值为1时银联出资,值为2时付款方出资,值为3时商户出资offstAmt优惠金额
createtime String Y 退款订单创建时间,格式:yyyy-MM-dd HH:mm:ss

请注意:成功交易发起撤销后,银盛系统会自动进行退款,该退款订单号由银盛系统自动生成,商家可根据原商家订单号、是否为撤销交易进行判断

示例:

pengmeng0001,20160630,real-time transfer refund,S0110000001111010,324160630003389567,0.25,sd001112100000

7.样例

7.1 优惠信息 coupon_Info

[{
    "state": "TRADE_FAILED",
    "trade_no": "01O190531055885032",
    "seq": 1
}, {
    "state": "TRADE_SUCCESS",
    "trade_no": "01O190531055885032",
    "seq": 2
}]

附录

8.1 对账单业务错误码

错误码 错误描述 解决方案
ACQ.SYSTEM_ERROR 系统错误 重新发起请求
ACQ.INVALID_PARAMETER 参数无效 检查请求参数,修改后重新发起请求
error.code.desc.no.match.object.query 查询无匹配对象 重新生成对账单文件
error.code.desc.The.ones.on.the.day.of.reconciliation.document 该商户当天无对账单文件

results matching ""

    No results matching ""