1、进件职能图
2、进件概览
2.1、API3.0进件必须的接口5个
序号 | 接口名称 | 调用方向 | 说明 | 参考代码-Java版本 包名:com.*.demo.YsfApiDemo |
---|---|---|---|---|
1 | 资料上送 | 主调 | 商户基本资料上送,例如法人信息、结算信息 接口中包含如下子接口 1、【基础数据】卡bin查询 2、【基础数据】地区信息查询 3、【基础数据】行名行号查询 4、【基础数据】mcc |
参考addCustInfoApplyDemo()方法 |
2 | 图片上送 | 主调 | 图片上送,例如营业执照,身份证,结算银行卡等 | 参考imgUploadDemo()方法 |
3 | 资料确认 | 主调 | 服务商对商户信息进行确认(审核) | 参考auditCustInfoApplyDemo()方法 |
4 | 合同签约申请 | 主调 | 设置费率,权限以及合同类型 费率设置与商户号的关系说明: 1、设置刷卡费率分配826开头的商户号,并签署合同 2、设置扫码费率分配QRY开头的商户号,并签署合同 3、设置刷卡费率、刷卡费率分配826开头的商户号,并签署合同 如果一开始设置扫码费率,并完成了合同签署。后续需要POS机时只需要调用此接口设置刷卡费率即可,同时会生成一个新的826开头的商户号,不需要再次调用《资料上送》、《图片上送》、《资料确认》接口。 |
参考smscSignDemo()方法 |
5 | 合同签约异步通知 | 被调 | 最终的进件结果,商户号会通过此接口返回 | 参考AnsyNotifyDemo.java文件 |
2.2、《资料确认》被拒之后可以调用的接口3个
序号 | 接口名称 | 调用方向 | 说明 | 参考代码-Java版本 包名:com.*.demo.YsfApiDemo |
---|---|---|---|---|
1 | 资料修改 | 主调 | 在《资料确认》之前或者在调用《资料确认》被拒接时可以调用支持调用覆盖 | 参考modifyCustInfoDemo()方法 |
2 | 图片上送 | 主调 | 在《资料确认》之前或者在调用《资料确认》被拒接时可以调用支持调用覆盖 | 参考imgUploadDemo()方法 |
3 | 资料确认 | 主调 | 服务商对商户信息进行确认(审核) | 参考auditCustInfoApplyDemo()方法 |
2.3、API3.0进件可选的接口(按需选择)14个
序号 | 接口名称 | 调用方向 | 说明 | 参考代码-Java版本 包名:com.*.demo.YsfApiDemo |
---|---|---|---|---|
1 | 商户状态查询 | 主调 | 主动查询商户进件状态 | 参考queryCustApplyDemo()方法 |
2 | 签约短信或邮件重发 | 主调 | 进件时银盛会自动发送一次,只有当商户未收到可以主动再次调用 短信无法收到的几种情形: 1、该商户当天接收短信次数超过限制 2、商户手机设置了拦截 3、商户手机余额不足停机 4、手机其它App拦截 |
参考sendSmsOrEmailMsgDemo()方法 |
3 | 签约状态查询 | 主调 | 服务商查询子商户合同是否已经签约完成 | 参考queryContractDemo()方法 |
4 | 电子合同下载 | 主调 | 下载pdf格式的合同文件 | 参考downloadContractDemo()方法 |
5 | 基本信息变更申请 | 主调 | 子商户基本资料变更时调用此接口,资料提交后由银盛审核 | 暂无 |
6 | 结算信息变更申请 | 主调 | 子商户结算资料变更时调用此接口,资料提交后由银盛审核 | 暂无 |
7 | 费率信息变更申请 | 主调 | 子商户费率资料变更时调用此接口,资料提交后由银盛审核 | 暂无 |
8 | 变更图片上传 | 主调 | 资料变更之后调用此接口 | 暂无 |
9 | 报备 | 主调 | 服务商的子商户在使用自己的微信公众号或微信小程序时需要调用该接口上送Appid以及授权目录 | 暂无 |
10 | 重新报备 | 主调 | 1、银盛自动报备失败之后,服务商可以使用该接口自行报备 2、服务商可以在调用变更商户资料的接口(审核通过)之后,可以调用此接口,这时银盛会取变更之后的商户资料进行报备 |
暂无 |
11 | 入网资料变更通知 | 被调 | 对应《基本信息变更申请》、《结算信息变更申请》 | 参考AnsyNotifyDemo.java文件 |
12 | 费率变更异步通知 | 被调 | 对应《费率信息变更申请》 | 参考AnsyNotifyDemo.java文件 |
13 | 客户进件异步通知 | 被调 | 如果子商户进入人工审核(《资料确认》时同步返回status=10)请关注此接口异步通知,如果审核通过就可以调用《合同签约申请》进行下一步操作 | 参考AnsyNotifyDemo.java文件 |
14 | 报备异步通知 | 被调 | 通知微信报备、支付宝报备结果,并返回第三方商户号;如果报备失败,请自行调用《报备》接口 | 参考AnsyNotifyDemo.java文件 |
2.4、图片上传说明
子商户进件如下图片资料必填、条件必填、选填 对应表
小微商户 | 个体商户 | 企业商户 |
---|---|---|
- | A001--营业执照图片 | A001--营业执照图片 |
A002--法人身份证人像面 | A002--法人身份证人像面 | A002--法人身份证人像面 |
A003--法人身份证国徽面 | A003--法人身份证国徽面 | A003--法人身份证国徽面 |
A009--法人手持身份证照片 | A009--法人手持身份证照片 | A009--法人手持身份证照片 |
A006--商户门头照 | A006--商户门头照 | A006--商户门头照 |
A007--商户经营场所照 | A007--商户经营场所照 | A007--商户经营场所照 |
A008--商户收银台照 | A008--商户收银台照 | A008--商户收银台照 |
A004--结算银行卡正面(有卡号一面) | A004--结算银行卡正面(有卡号一面) (对私结算情况下必填) |
A004--结算银行卡正面(有卡号一面) (对私结算情况下必填) |
A005--结算银行卡反面 | A004--A005--结算银行卡反面 (对私结算情况下必填) |
A004--A005--结算银行卡反面 (对私结算情况下必填) |
- | A011--开户许可证 (对公结算情况下必填) |
A011--开户许可证 (对公结算情况下必填) |
- | A013--被授权人身份证人像面 (非法人结算时必填) |
A013--被授权人身份证人像面 (非法人结算时必填) |
- | A014--被授权人身份证国徽面 (非法人结算时必填) |
A014--被授权人身份证国徽面 (非法人结算时必填) |
- | B005--结算授权书 (非法人结算时必填) |
B005--结算授权书 (非法人结算时必填) |
- | B004--法人手持结算授权书 (非法人结算时必填) |
B004--法人手持结算授权书 (非法人结算时必填) |
A012--收单业务协议首页 (在《合同签约申请》接口选择纸质合同时必填) |
A012--收单业务协议首页 (在《合同签约申请》接口选择纸质合同时必填) |
A012--收单业务协议首页 (在《合同签约申请》接口选择纸质合同时必填) |
A010--收单业务协议盖章页 (在《合同签约申请》接口选择纸质合同时必填) |
A010--收单业务协议盖章页 (在《合同签约申请》接口选择纸质合同时必填) |
A010--收单业务协议盖章页 (在《合同签约申请》接口选择纸质合同时必填) |
B001--选填:租赁合同第一页 | B001--选填:租赁合同第一页 | B001--选填:租赁合同第一页 |
B002--选填:租赁合同第二页 | B002--选填:租赁合同第二页 | B002--选填:租赁合同第二页 |
B003--选填:租赁合同第三页 | B003--选填:租赁合同第三页 | B003--选填:租赁合同第三页 |
B006--选填:租赁面积图片 | B006--选填:租赁面积图片 | B006--选填:租赁面积图片 |
子商户资料变更时需要上送的图片如下
小微商户 | 个体商户 | 企业商户 |
---|---|---|
B008--变更申请表 (拍照) |
B008--变更申请表 (拍照) |
B008--变更申请表 (拍照) |
3、Demo介绍
为了快速接入,各业务接口有如下示例代码提供参考,不一定全部阅读,服务商按需查看,请阅读如下说明
加解密方式:银盛提供了两种密钥方式供接入方选择,分别是RSA和国密,建议接入方优先考虑国密(sm2)方式
示例代码的工程下载地址:https://gateway-doc.ysepay.com/gatewayDocs/summary/N0000001/I0000001.html
3.1、RSA方式
[RSA]加解密方式的示例代码包路径:com.eptok.yspayopensdk.openapidemo.demo
[RSA]证书文件格式:.cer、 .pfx;
其中cer是公钥用来验证银盛异步通知的数据,考虑到数据安全防篡改
pfx用来对发往银盛的数据进行签名
1、AnsyNotifyDemo.java 服务商接受异步通知示例代码
2、CommonDemo.java 公共接口调用示例代码
3、CouponDemo.java 卡券接口调用示例代码
4、FileUploadDemo.java 文件上传调用示例代码
5、MisPushDemo.java 云喇叭播报示例代码
6、PortalAccountBindDemo.java 银行卡绑定接口调用示例代码
7、PortalRechargeDemo.java 汇款充值接口调用示例代码
8、QhylDemo.java 前海移联接口调用示例代码
9、SettleProgressDemo.java 结算进度查询接口调用示例代码
10、YsfApiDemo.java 子商户进件接口调用示例代码(高频调用)
11、YsfTermOrQryDemo.java 码牌绑定,终端绑定接口调用示例代码
12、yxmarketDemo.java 营销活动接口调用示例代码
3.2、国密方式
[国密]加解密方式的示例代码包路径:com.eptok.yspayopensdk.openapidemo.gMdemo
[国密]证书文件格式:*.sm
1、AnsyNotifyDemo.java 服务商接受异步通知示例代码
2、CommonDemo.java 公共接口调用示例代码
3、CouponDemo.java 卡券接口调用示例代码
4、FileUploadDemo.java 文件上传调用示例代码
5、MisPushDemo.java 云喇叭播报示例代码
6、QhylDemo.java 前海移联接口调用示例代码
7、YsfApiDemo.java 商户进件接口调用示例代码
8、YsfTermOrQryDemo.java 码牌绑定,终端绑定接口调用示例代码
9、yxmarketDemo.java 营销活动接口调用示例代码
3.3、工具类:com.eptok.yspayopensdk.openapidemo.util
提供签名,验签等方法的封装