商户余额查询
1.修订记录
修订 |
日期 |
说明 |
作者 |
V0.1 |
2017/9/18 |
新接口参数定义 |
陈宋东 |
V0.2 |
2017/9/28 |
1.HTTPS请求地址改成https://commonapi.ysepay.com/gateway.do |
陈宋东 |
V0.21 |
2017/9/28 |
2.公共参数去掉notify |
陈宋东 |
V0.3 |
2017/10/20 |
新增异常类型ACQ.BUSINESS_TIMEOUT_ERROR(业务超时) |
陈宋东 |
V0.4 |
2018/4/20 |
一般消费账户与待结算账户增加预可提现余额字段 |
黄月巧 |
V0.5 |
2018/12/13 |
增加返回参数 已结算未清算付款的金额 |
宁华雄 |
V0.6 |
2019/06/05 |
增加错误码ACQ.MERCHANT_NO_CHECK_PRIVILEGE |
陈宋东 |
V0.7 |
2020/11/11 |
修改ACQ_QUERY_NO_RECORD的说明 |
汤吉齐 |
V0.8 |
2021/12/27 |
支持国密 |
王晶 |
2.接口说明
(1)场景说明
1、商户余额
(2)接口说明
1、 商户余额-V3.0版本
3.请求地址
4.请求参数说明
4.1 公共请求参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
method |
String(1,128) |
Y |
接口名称。示例值:ysepay.merchant.balance.query |
partner_id |
String(1,20) |
Y |
商户在银盛支付平台开设的用户号[合作商户号] |
timestamp |
String(1,19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss",示例值:2014-07-24 03:07:50 |
charset |
String(1,10) |
Y |
商户网站使用的编码格式,如utf-8、gbk、gb2312等。示例值:GBK |
sign_type |
String(1,10) |
Y |
签名类型,RSA/SM |
sign |
String(1,256) |
Y |
签名字符串,再用Base64编码 |
version |
String(1,3) |
Y |
接口版本,示例值:3.0 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
merchant_usercode |
String(1,20) |
Y |
商户号,如果被查询的商户号和合作商户号不一致则需要检查机构信息 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_merchant_balance_query_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
account_total_amount |
Number(10,2) |
Y |
账户总额 |
account_settled_unpaid_amount |
Number(10,2) |
Y |
所有账户累计已结算未付款的金额(一般只会是待结算账户有) |
account_detail |
list |
Y |
账户明细信息 |
5.3 账户明细 account_detail
参数 |
类型(字节长度) |
必填 |
参数说明 |
account_id |
String(16,16) |
Y |
账户号 |
account_type |
String(1,24) |
Y |
账户类型,示例值:一般消费户 |
account_amount |
Number(10,2) |
Y |
账户余额 |
account_withdrawbalance |
Number(10,2) |
N |
预可提现余额(只针对一般消费类账户与待结算账户) |
6.样例
6.1 sdk调用示例
- 银盛将与服务端交互的接口封装在开发工具包(SDK)中,开发者无需自行实现同服务端交互的复杂逻辑,直接将SDK导入自己的工程后,通过sdk示例代码实现同银盛服务端的交互
OnlineReqDataVo req = new OnlineReqDataVo();
String reqUrl = "https://commonapi.ysepay.com/gateway.do";
String privateKeyFilePath = "D:\\opensdk\\hyfz_test2.pfx";
String publicKeyFilePath = "D:\\opensdk\\businessgate.cer";
String privateKeyPassworde = "123456";
req.setPartnerId("hyfz_test2");
req.setReqUrl(reqUrl);
req.setPrivateKeyFilePath(privateKeyFilePath);
req.setPrivateKeyPassword(privateKeyPassworde);
req.setYsPublicKeyFilePath(publicKeyFilePath);
Map<String, Object> bizContent = new HashMap<>();
bizContent.put("merchant_usercode", "hyfz_test2");
req.setParamData(bizContent);
String result = null;
try{
logger.info("账户余额查询调用sdk接口addScanMerc请求入参为:"+ JSONObject.toJSONString(req));
result = MercFundApi.getFundAccount(req);
}catch (Exception e){
logger.info("账户余额查询失败:"+ e.getMessage());
}
7.附录
7.1 业务错误码
错误码 |
错误描述 |
解决方案 |
ACQ.SYSTEM_ERROR |
系统错误 |
请联系银盛客服 |
ACQ.BUSINESS_TIMEOUT_ERROR |
业务超时 |
请调用查询接口查询订单状态 |
ACQ.QUERY_NO_RECORD |
暂未查询到记录,未找到账户信息,请检查partner_id后重试 |
该状态为未知状态,请勿当成失败状态处理 检查传入的订单号是否正确,修改后重新发起请求或继续查询 |
ACQ.GET_ACCOUNT_INFO_EXCEPTION |
获取账户信息异常 |
请联系客服或市场技术支持人员 |
ACQ.CUST_INFO_NOT_EXIST |
查询不到对应的客户信息 |
请核查商户号是否正确 |
ACQ.ORGNO_NOT_EXIST |
查询不到对应机构号 |
|
ACQ.ORGNO_MUST_NOT_SAME |
两个商户的机构号不能一样 |
|
ACQ.ORGNO_CHECK_FAILD |
代理商与商户的机构关系不匹配 |
|
ACQ.MERCHANT_NO_CHECK_PRIVILEGE |
商户无查询权限 |