1、接入指引
复制页面
1、接入指引
1.1 阅读人 员与名词解释
1.2版本发布说明
1.3接入准备
1.4接入指引
2、平台规范
2.1接口格式定义
2.2 加签验签说明与代码示例
2.3 参数说明
2.4上线前检查清单
3、业务指引
3.1 商户入网业务接入指引
4、API列表
4.1商户入网类接口
4.1.1 图片上传接口
4.1.1.1 公共文件上传(进件用上传临时文件)
4.1.2 商户入网与配置
4.1.2.1 商户添加
4.1.2.2 商户更新
4.1.2.3 收单商户入网
4.1.2.4 收单商户更新
4.1.2.5 通道添加
4.1.2.6 通道变更
4.1.2.7 商户详情查询
4.1.2.8 收单商户更新详情查询
4.1.2.9 分账开通
4.1.2.10 分账变更
4.1.2.11 分账开通结果查询
4.1.2.12 分账关系绑定
4.1.2.13 分账关系解绑
4.1.2.14 微信关注配置
4.1.2.15 微信关注配置查询
4.1.2.16 实名认证申请
4.1.2.17 实名认证申请状态查询
4.1.2.18 实名认证授权状态结果查询
4.2聚合支付交易类接口
4.3订单分账类接口
4.4余额分账类接口
4.4.1 余额分账相关接口
4.4.1.1 B2B转账
4.4.1.2 转账查询
4.4.2 余额查询接口
4.4.2.1 余额查询
4.4.3 提现相关接口
4.4.3.1 提现
4.4.3.2 提现查询
4.4.3.3 查询提现银行卡
4.5信用付(先享后付)类接口
4.6大额支付类接口
4.7营销类接口
4.7.1 资产预查核验
4.7.2 资产交易(核销)
4.7.3 资产交易(核销)查询
4.7.4 资产交易(核销)撤销
4.7.5 资产交易(核销)退款
4.7.6 资产交易(核销)退款查询
4.7.7 资产余额查询
4.7.8 资产交易对账单拉取
4.7.9 付款码订单轮询查询
4.7.10 付款码订单结果通知
4.8辅助类接口
4.8.1 开放平台API示例控制器
4.8.1.1 参数加密示例
4.8.2 配置获取类接口
4.8.2.1 获取MCC行业类目树
4.8.2.2 获取区域列表(三级联动查询)
4.8.2.3 获取银行总行列表
4.8.2.4 获取银行支行列表
4.8.2.5 获取易宝MCC行业类目树
4.8.2.6 获取易生MCC行业类目树
4.8.2.7 获取易生支付宝微信MCC映射关系列表
4.8.2.8 获取平安银行MCC映射关系列表
4.8.3 交易投诉处理类接口
4.8.3.1 投诉单分页查询
4.8.3.2 投诉单详情查询
4.8.3.3 回复投诉用户
4.8.3.4 完结投诉处理
4.8.3.5 投诉凭证图片上传
4.8.3.6 投诉凭证图片查看
4.9银行账户与分账类接口
4.9.1 EBK账户类
4.9.1.1 EBK账户注册
4.9.1.2 EBK账户基本信息查询
4.9.1.3 EBK账户绑定提现账户
4.9.1.4 EBK账户解绑提现账户
4.9.2 EBK动账交易类
4.9.2.1 账户转账
4.9.2.2 EBK账户提现
4.9.2.3 批量清分
4.9.3 EBK交易查询类
4.9.3.1 转账状态查询
4.9.3.2 EBK账户余额查询
4.9.3.3 提现状态查询
4.9.3.4 清分状态查询
4.1.2 商户入网与配置
F.附录
FAQ
数据模型
BalanceQueryResponse
ComplaintItem
EbkAccountRegisterResp
MerchantAddResp
PageDTO
MktAssetPreQueryVO
EbkAccountBalResp
EbkTransferCreateResp
OpenApiResponseBalanceQueryResponse
MerchantPictureUploadResp
ComplaintPageResp
OpenApiResponseMerchantAddResp
OpenApiResponseEbkAccountRegisterResp
MccTreeResp
OpenApiResponseListMccTreeResp
OpenApiResponseMerchantPictureUploadResp
OpenApiResponseMktAssetPreQueryVO
OpenApiResponseEbkAccountBalResp
OpenApiResponseEbkTransferCreateResp
OpenApiResponseMapObject
BalanceQueryRequest
GenericResponseMerchantPictureUploadResp
OpenApiResponseComplaintPageResp
GenericResponseMerchantAddResp
ApplyInfo
GenericResponseListMccTreeResp
EbkTransferQueryReq
MktAssetPreQueryDTO
EbkTransferCreateReq
OpenApiResponseString
OpenApiRequestBalanceQueryRequest
MerchantPictureUploadReq
ComplaintPageReq
BasicInfo
EbkAccountRegisterReq
MccTreeReq
OpenApiRequestMccTreeReq
OpenApiRequestEbkTransferQueryReq
OpenApiRequestMerchantPictureUploadReq
OpenApiRequestMktAssetPreQueryDTO
OpenApiRequestEbkTransferCreateReq
AccountTransferResponse
OpenApiRequestComplaintPageReq
OpenApiRequestEbkAccountRegisterReq
MerchantAddReq
AreaResp
JSONObject
MktAssetPayVO
EbkWithdrawCreateResp
OpenApiResponseString
OpenApiResponseAccountTransferResponse
ComplaintOrderInfo
OpenApiRequestMerchantAddReq
BankCard
GenericResponseListAreaResp
OpenApiResponseListAreaResp
OpenApiResponseMktAssetPayVO
OpenApiResponseEbkWithdrawCreateResp
PayRequest
AccountTransferRequest
ComplaintMediaList
MerchantUpdateResp
EbkAccountInfoResp
AreaListReq
MktAssetPayDTO
EbkWithdrawCreateReq
OpenApiRequestPayRequest
OpenApiRequestAccountTransferRequest
ServiceOrderInfo
OpenApiResponseMerchantUpdateResp
GenericResponseMerchantUpdateResp
OpenApiResponseEbkAccountInfoResp
BankParentResp
OpenApiRequestAreaListReq
OpenApiRequestMktAssetPayDTO
OpenApiRequestEbkWithdrawCreateReq
OpenApiRequestString
AccountTransferQueryResponse
ReturnAddressInfo
BasicInfo
EbkAccountQueryReq
GenericResponseListBankParentResp
MktAssetQueryPayVO
RefundRequest
OpenApiResponseAccountTransferQueryResponse
SharePowerInfo
OpenApiRequestEbkAccountQueryReq
MerchantUpdateReq
BankParentListReq
OpenApiResponseListBankParentResp
OpenApiResponseMktAssetQueryPayVO
ClearItem
OpenApiRequestRefundRequest
AccountTransferQueryRequest
AdditionalInfo
EbkWithdrawQueryReq
OpenApiRequestMerchantUpdateReq
BankResp
MktAssetQueryPayDTO
EbkClearCreateReq
OpenApiRequestAccountTransferQueryRequest
WxComplaintDetail
OpenApiRequestEbkWithdrawQueryReq
ChannelInfo
GenericResponseListBankResp
EbkBankCardBindReq
OpenApiRequestBankParentListReq
OpenApiRequestMktAssetQueryPayDTO
OpenApiRequestEbkClearCreateReq
AccountWithdrawResponse
EbkClearQueryResp
MapString
MemberAddResp
BankListReq
OpenApiRequestEbkBankCardBindReq
MktAssetCancelVO
OpenApiResponseAccountWithdrawResponse
ComplaintTradeInfo
OpenApiResponseEbkClearQueryResp
OpenApiResponseMemberAddResp
GenericResponseMemberAddResp
MccYbTreeReq
EbkBankCardUnbindReq
OpenApiResponseListBankResp
OpenApiResponseMktAssetCancelVO
AccountWithdrawRequest
AlipaySecurityRiskComplaintInfoQueryResponse
EbkClearQueryReq
MerchantBasicInfo
MccEasypayTreeReq
OpenApiRequestEbkBankCardUnbindReq
MktAssetCancelDTO
OpenApiRequestAccountWithdrawRequest
ComplaintDetailResp
OpenApiRequestEbkClearQueryReq
LicenseInfo
MccMappingEasypayResp
OpenApiRequestBankListReq
OpenApiRequestMktAssetCancelDTO
AccountWithdrawQueryResponse
OpenApiResponseComplaintDetailResp
LegalInfo
GenericResponseListMccMappingEasypayResp
MktAssetRefundVO
OpenApiResponseAccountWithdrawQueryResponse
ComplaintDetailReq
SettlementInfo
OpenApiRequestMccYbTreeReq
OpenApiResponseMktAssetRefundVO
AccountWithdrawQueryRequest
OpenApiRequestComplaintDetailReq
ChannelInfo
MccMappingPaResp
MktAssetRefundDTO
OpenApiRequestAccountWithdrawQueryRequest
PictureInfo
OpenApiResponseVoid
OpenApiRequestMccEasypayTreeReq
GenericResponseListMccMappingPaResp
OpenApiRequestMktAssetRefundDTO
UploadItem
MemberAddReq
MccMappingPaReq
MktAssetQueryRefundVO
MapObject
ComplaintReplyReq
OpenApiRequestMemberAddReq
OpenApiResponseListMccMappingEasypayResp
OpenApiResponseMktAssetQueryRefundVO
BankCardAccount
OpenApiRequestComplaintReplyReq
ChannelInfo
MccMappingEasypayReq
MktAssetQueryRefundDTO
ComplaintCompleteReq
MemberUpdateResp
GenericResponseMemberUpdateResp
OpenApiRequestMccMappingEasypayReq
OpenApiRequestMktAssetQueryRefundDTO
BindCardQueryRespDTO
OpenApiRequestComplaintCompleteReq
OpenApiResponseMemberUpdateResp
MktAssetBalanceVO
OpenApiResponseBindCardQueryRespDTO
ComplaintImageUploadResp
MerchantBasicInfo
LicenseInfo
OpenApiResponseListMccMappingPaResp
OpenApiResponseMktAssetBalanceVO
WithdrawCardQueryRequest
OpenApiResponseComplaintImageUploadResp
MktAssetBalanceDTO
OpenApiRequestWithdrawCardQueryRequest
ComplaintImageUploadReq
LegalInfo
OpenApiRequestMccMappingPaReq
OpenApiRequestMktAssetBalanceDTO
OpenApiRequestComplaintImageUploadReq
SettlementInfo
MktAssetReconciliationRecord
ComplaintImageViewResp
PictureInfo
MktAssetReconciliationVO
OpenApiResponseComplaintImageViewResp
MemberUpdateReq
OpenApiResponseMktAssetReconciliationVO
ComplaintImageViewReq
OpenApiRequestMemberUpdateReq
MktAssetReconciliationDTO
OpenApiRequestComplaintImageViewReq
ChannelInfo
OpenApiRequestMktAssetReconciliationDTO
ChannelAddResp
GenericResponseChannelAddResp
MktAssetQueryPayCodeOrderVO
OpenApiResponseChannelAddResp
OpenApiResponseMktAssetQueryPayCodeOrderVO
ChannelAddReq
MktAssetQueryPayCodeOrderDTO
OpenApiRequestChannelAddReq
OpenApiRequestMktAssetQueryPayCodeOrderDTO
ChannelInfo
GenericResponseChannelUpdateResp
MktAssetNotifyPayResultVO
ChannelUpdateResp
OpenApiResponseMktAssetNotifyPayResultVO
OpenApiResponseChannelUpdateResp
ApplyInfo
MktAssetNotifyPayResultDTO
OpenApiRequestMktAssetNotifyPayResultDTO
OpenApiRequestChannelUpdateReq
ChannelUpdateReq
LicenseInfo
ApplyInfo
LegalInfo
MerchantBasicInfo
SettlementInfo
ChannelInfo
PictureInfo
ChannelInfo
GenericResponseMerchantDetailResp
MerchantDetailResp
OpenApiResponseMerchantDetailResp
GenericResponseSplitOpenResp
MerchantDetailReq
key
OpenApiRequestMerchantDetailReq
SplitOpenResp
OpenApiResponseSplitOpenResp
GenericResponseSplitUpdateResp
SplitParam
SplitOpenReq
OpenApiRequestSplitOpenReq
key
SplitUpdateResp
OpenApiResponseSplitUpdateResp
SplitQueryResp
GenericResponseListSplitQueryResp
SplitParam
SplitUpdateReq
SplitQueryReq
OpenApiRequestSplitUpdateReq
SplitConfigInfo
GenericResponseSplitBindResp
SplitBindReq
OpenApiResponseListSplitQueryResp
GenericResponseSplitUnbindResp
OpenApiRequestSplitQueryReq
SplitUnbindReq
SplitBindResp
WechatConfigItem
OpenApiResponseSplitBindResp
WechatConfigSaveResp
GenericResponseWechatConfigSaveResp
OpenApiRequestSplitBindReq
SplitUnbindResp
WechatConfigSaveReq
OpenApiResponseSplitUnbindResp
WechatConfigItem
OpenApiRequestSplitUnbindReq
GenericResponseWechatConfigQueryResp
WechatConfigQueryReq
OpenApiResponseWechatConfigSaveResp
GenericResponseRealnameAuthApplyResp
AppidConfigItem
RealnameAuthApplyReq
OpenApiRequestWechatConfigSaveReq
GenericResponseRealnameAuthStatusResp
RealnameAuthStatusQueryReq
WechatConfigQueryResp
OpenApiResponseWechatConfigQueryResp
GenericResponseRealnameAuthResultResp
RealnameAuthResultQueryReq
OpenApiRequestWechatConfigQueryReq
RealnameAuthApplyResp
OpenApiResponseRealnameAuthApplyResp
OpenApiRequestRealnameAuthApplyReq
RealnameAuthStatusResp
OpenApiResponseRealnameAuthStatusResp
OpenApiRequestRealnameAuthStatusQueryReq
RealnameAuthResultResp
OpenApiResponseRealnameAuthResultResp
OpenApiRequestRealnameAuthResultQueryReq
1、接入指引
复制页面
1.3接入准备
快速接入
#
本文档将系统性指导您完成收呗开放平台的接入流程,帮助您高效开始使用平台提供的各项金融科技能力。通过遵循本指南的步骤,您可以规范、有序地完成从应用创建到正式上线的全过程,快速实现业务价值。
流程概览
一、商户入网并签约产品
#
1. 查看产品开通情况
#
2. 检查应用配置
#
查看应用信息
: 确认应用标识(AppKey)和应用名称,这是您应用的唯一身份标识
确认应用权限范围
:验证应用是否具备所需产品的访问权限,确保权限配置完整
二、密钥配置
#
1. 密钥制备
#
2. 密钥配置
#
三、开发对接
#
1. API 对接准备
#
了解业务场景和模型
:明确您的业务需求与平台能力的匹配点,设计合理的业务流程;也可联系收呗商务经理以及客服,让收呗技术团队协助您匹配技术方案
确定需要使用的具体接口
:根据业务流程选择合适的接口组合,避免冗余 调用
查看详细的 API 文档
:深入了解接口的请求参数、响应结果和业务规则,确保正确实现
了解签名算法和参数规范
:掌握安全验证机制,确保请求能够通过平台的安全验证
2. 关键开发要点
#
严格按照接口文档规范传递参数
:注意必填项、参数格式和长度限制,避免因参数错误导致调用失败
正确处理接口返回结果
:根据返回码判断交易状态,合理处理成功和异常情况
实现异步通知接收接口
:开发稳定可靠的回调接口,确保能够接收并处理平台的异步通知
注意接口调用频率限制
:遵循平台的调用频率规范,实现合理的请求控制,避免触发限流措施
通信安全
:请严格遵循平台的接口通信加密验签安全机制,确保可信的通信安全,放置通信劫持与伪造