合单支付 - 订单及明细查询

1、修订记录

版本号 日期 说明 作者
0.1 2021/09/01 新接口参数定义 杨诗东
0.2 2021/12/27 支持国密 王晶

2、业务说明

(1)场景说明

商户通过合单订单查询API查询订单状态

(2)接口说明

平台通过合单订单查询API查询订单状态,完成下一步的业务逻辑 需要调用查询接口的情况: 1、当商户后台、网络、服务器等出现异常,商户系统最终未接收到支付通知。 2、调用支付接口后,返回系统错误或未知交易状态情况。 3、调用关单或撤销接口API之前,需确认支付状态。

3.请求地址

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

4.请求参数说明

4.1公共请求参数

参数 类型(字节长度) 必填 参数说明
method String(128) Y 接口名称 固定值 ysepay.online.trade.order.combine.query
partner_id String(20) Y 在银盛支付开设的服务商商户号,请联系客户经理提供
timestamp String(19) Y 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2021-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
biz_content String Y 业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递

4.2 业务请求参数

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

参数 类型(字节长度) 参数说明
combine_out_trade_no String(1,32) 商户生成的合单订单号 示例值:201805256843192280647118
shopdate String(8,8) 商户日期(该参数与做交易时一致)
combine_trade_no String(32) 该交易在银盛支付系统中的交易流水号。

5.响应参数说明

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

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

5.1 公共响应参数

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

5.2 业务响应参数

参数 类型(字节长度) 必填 参数说明
code String Y 响应代码
msg String Y 响应代码描述
combine_out_trade_no String(32) Y 商户生成的合单订单号 示例值:201805256843192280647118
combine_trade_no String(20) N 银盛支付合单交易流水号。
trade_status String Y 交易目前所处的状态。成功状态的值: TRADE_SUCCESS 示例值:附录6.1
total_amount Number Y 该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。示例值:100
sub_order_list list Y 子单订单信息(最多50笔)

5.3 子订单 sub_order_list

参数 类型(字节长度) 必填 参数说明
trade_status String Y 交易目前所处的状态。成功状态的值: TRADE_SUCCESS\ TRADE_CLOSED等具体详情看下文中的交易状态详解Json格式字符串,作用于原生态的js支付时的参数
trade_no String(20) N 银盛支付交易流水号。
out_trade_no String(32) 商户生成的订单号 示例值:6843192280647118
amount Number(10,2) Y 金额,Number(10,2)指10位长度,2位精度 示例值:100.01
account_date String(10) N 入账日期,格式”yyyy-MM-dd” 示例值:2014-07-24
settlement_amount Number N 结算金额元 示例值:100
total_discount double N 优惠金额元 示例值:100.00
pay_detail_list list N 子单支付明细信息

5.3.1 子单支付明细 pay_detail_list

参数 类型(字节长度) 必填 参数说明
status String Y 支付状态 TRADE_SUCCESS 示值值:附录6.1
send_channel_time String N 发往渠道的交易时间格式”yyyy-MM-dd HH:mm:ss” 示例值:2019-5-24 09:44:31
serial_number Number(1) Y 序列号,序列号数值越大则表示此笔交易流水为最新记录 示例值:1
partner_fee double Y 该笔订单的合作方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位 元 示例值:100.00
payee_fee double Y 该笔订单的收款方手续费(参考),单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位元 示例值:100.00
channel_send_sn String(50) N 发往渠道流水
channel_recv_sn String(50) N 渠道返回流水
bank_type String N 二维码行别,微信-1902000 支付宝-1903000 QQ扫码-1904000 银联扫码-9001002 招商银行 -3085840
total_discount_fee double N 优惠手续费元 示例值:100.00
is_discount String N 是否参与优惠 Y\ N

6.附录

6.1 交易状态

枚举名称 枚举说明
WAIT_BUYER_PAY 交易创建,等待买家付款。
TRADE_CLOSED 在指定时间段内未支付时关闭的交易;客户主动关闭订单。
TRADE_SUCCESS 交易成功,且可对该交易做操作,如:多级分润、退款等。
TRADE_PART_REFUND 部分退款成功。
TRADE_ALL_REFUND 全部退款成功。
TRADE_FAILD 交易失败
TRADE_UNDEPOSIT 交易成功,商户未入账,请联系客户经理处理

results matching ""

    No results matching ""