商户提现查询
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2023.04.20 | 初版 |
2、业务说明
(1)接口说明
通过该接口,可查询商户的提现交易。
请求主体类型:application/json
请求方式:POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay.com/openapi/unify/merchant/withdraw/quick/query |
| 正式环境 | https://ysgate.ysepay.com/openapi/unify/merchant/withdraw/quick/query |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称,固定值:unify.merchant.withdraw.quick.query |
| charset | String(10) | Y | 请求使用的编码格式,如utf-8,gbk,gb2312等,固定为utf-8 |
| sign | String | Y | 商户请求参数的签名串(签名算法默认为国密),详见demo,注意:请用商户私钥进行签名 |
| check | String | Y | 银盛公钥加密随机生成的字符串(key)得到的加密值,详见demo |
| bizContent | String | Y | 业务参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递。注意:需要通过AES以及随机生成的字符串(key)加密业务参数集合,得到bizContent |
| reqId | String | Y | 请求唯一流水号,商户系统唯一,要求32个字符内(最少14个字符),只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值:xy1415220315145602 |
| certId | String | Y | 发起方商户号,服务商在银盛给自己开设的商户号,即可当作发起方商户号,由银盛生成并下发。 注意:不同于子商户号,服务商发展的商户即为子商户号 |
| version | String | Y | 调用的接口版本,固定为:1.0 |
4.2、业务请求参数
(bizContent加密前的json数据明文字符串)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| orderId | String(32) | Y | 商户订单号,商户系统生成的订单号。 |
| shopDate | String(8) | Y | 交易日期,商户系统的交易发生日期,格式yyyyMMdd, 示例值:20180525。 |
5、响应参数说明
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。5.1、公共响应参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| code | String(5) | Y | 网关响应码,示例值:00000 ,详见网关公共响应码 |
| msg | String(50) | Y | 网关响应码描述 |
| subCode | String | Y | 业务响应码,参见具体的API接口文档 |
| subMsg | String | Y | 业务响应描述 |
| timeStamp | String | Y | 响应时间,格式"yyyy-MM-dd HH:mm:ss" |
| norce | String(128) | Y | 随机参数 |
| sign | String | Y | 响应参数的签名串,详见demo, 注意:请用银盛公钥进行验签 |
| businessData | String | Y | 业务响应参数集合, 注意:银盛网关通过AES加密业务响应参数集合,得到businessData,商户需要对其进行解密,详情请见demo |
5.2、业务响应参数
响应业务参数businessData(json数据)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| reqMsgId | String | N | 请求流水号 |
| businessData | Object | N | 响应结果 |
5.2.1 businessData具体参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| orderId | String(32) | Y | 订单号,商户系统生成的订单号。 |
| tradeStatus | String(2) | Y | 交易目前所处的状态,状态如下: 00-支付成功/交易成功 10-处理中/受理成功,请耐心等待异步通知结果 11-已向渠道发起 12-代付付款方支付 11-处理中,已向渠道发起 45-渠道参数转换完成 46-交易待授权 47-已获取授权码 50-内部处理超时 51-调用支付网关超时 52-渠道超时 53-订单超时处理中 80-部分退款 81-全部退款成功 94-审核不通过 99-支付失败/交易失败 |
| tradeStatusDescription | String(256) | Y | 状态描述 |
| totalAmount | String(10) | Y | 订单总金额,单位:分。 |
| accountDate | String(8) | N | 会计日期,格式为yyyyMMdd,示例值:20160413。 |
| tradeSn | String(30) | N | 银盛支付交易流水号 |
| fee | String(10) | N | 总手续费,单位:分。 |
| partnerFee | String(10) | Y | 合作方手续费,单位:分。 |
| payeeFee | String(10) | Y | 收款方手续费,单位:分。 |
| payerFee | String(10) | Y | 付款方手续费,单位:分。 |
| withheldAmount | String(10) | N | 增值费,单位:分。 |
| chargeRemark | String | N | 增值费描述 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0000 | 交易成功 | |
| 9999 | 系统错误 | 支付中该状态为未知状态,请勿当成失败状态处理,请等待支付 通知或继续查询 |
| 5000 | 请求超时 | 请调用查询接⼝查询订单状态 |
| A029998 | 网关非法参数 | 根据返回的描述,修改请求参数。 |
| B020100 | 参数校验错误 | 检查请求参数,修改后重新发起请求。 |
| B029901 | 业务失败 | 根据实际返回消息分析具体原因。 |
| B049999 | 业务失败 | 根据实际返回消息分析具体原因。 |
| B043003 | 商户号或发起方商户号异常,请检查! | 请检查商户号和发起方是否正常。 |
| B047024 | 没找到代理关系 | 确认是否存在代理关系。 |