测试地址:http://116.228.64.55:28082/yst-service-api/tm/handle
生产地址:https://ibsapi.allinpay.com/yst-service-api/tm/handle
接口代码(transCode):1050
功能说明:
- “3-收单分账服务协议”协议类型签约,包括3类协议: 收单协议、分账协议(收单商户与分账方)、平台抽佣协议(收单商户与ISV)。
协议类型 |
协议说明 |
收单协议 |
会员状态=“有效”+已绑定手机号+会员已通过【会员进件】接口完成支付账户出号+未签订收单协议。 |
分账协议(收单商户与分账方) |
会员状态=“有效”+未签订分账协议(设置收款方-分账方角色)+已绑定手机号 |
平台抽佣协议(收单商户与ISV) |
会员状态=“有效”+未签订分账协议(设置收款方角色-ISV平台方)+已绑定手机号 |
- 收款方(收单商户)可三份协议一起签约;分账方仅需要签订“分账协议(收单商户与分账方)”一份协议;针对收款协议与多个分账方存在业务关系的,需签订多次分账协议。
- 鉴权方式:向绑定手机号发送短信验证;
- 电子签章:鉴权校验通过,同步电子签章生成协议;
- 签约的协议比例更新:则调用本接口,再次发起签约。新的协议置“签约成功”后,则原协议置为“已失效”状态。
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
请求流水号 |
|
signNum |
String |
60 |
是 |
签约会员编号 |
若上送收款方角色的会员,可在签约协议信息中上送分账会员信息,签订分账协议 |
memberName |
String |
32 |
是 |
签约会员名称 |
需签订分账协议的场景 此字段填收款会员信息; 分账会员信息在签约协议信息中明确 |
agreementType |
String |
1 |
是 |
协议类型 |
3-收单分账服务协议 |
agreementJson |
JSONObject |
否 |
签约协议信息 |
当协议类型=3-收单分账服务协议:上送“收单分账服务协议详情信息”; |
|
jumpPageType |
String |
1 |
否 |
跳转页面类型 |
1-H5页面 2-小程序页面 兼容存量模式,不上送默认跳转H5页面 |
jumpUrl |
String |
256 |
否 |
前台跳转地址 |
签约成功,则跳转 |
notifyUrl |
String |
256 |
是 |
签约结果通知地址 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
40 |
否 |
响应流水号 |
业务正常处理,则返回 |
respCode |
String |
5 |
是 |
业务码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
200 |
是 |
失败原因 |
|
signAgreementUrl |
String |
256 |
否 |
协议签约地址 |
00000-申请成功,返回说明:72小时有效期均可打开签约 返回签约主体的签约地址 |
sepAgreementUrl |
String |
256 |
否 |
分账方协议签约地址 |
00000-申请成功,返回说明:仅需要签订分账协议,才返回 |
收单分账服务协议详情信息(agreementJson)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
couponWay |
String |
否 |
平台抽佣方式 目前仅支持:1:分账比例 |
若上送,则2个字段必须同时上送。 上送该值,则表示需签订平台抽佣协议。 |
couponRate |
String |
否 |
平台抽佣比例 比例:单位 %,精确到小数点后2位 |
|
sepMemBusCode |
String |
否 |
分账会员编号 |
仅当“签约会员名称”是收款方,可上送分账方信息,且“分账会员编号”和“分账会员名称”、“分账方式 ”四个字段必须同时必填; |
sepMemName |
String |
否 |
分账会员名称 |
|
sepWay |
String |
否 |
分账方式 1:分账比例 |
|
sepRateOrAmt |
String |
否 |
分账比例 比例:单位 %,精确到小数点后2位 |
收单分账服务协议签约前端页面回调参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
请求流水号 |
|
signNum |
String |
60 |
是 |
签约会员编号 |
|
memberName |
String |
32 |
是 |
签约会员名称 |
|
couponAgreeStatus |
String |
1 |
是 |
平台抽佣协议状态 |
收单商户与ISV平台方,需要签订平台抽佣协议时,返回 |
couponAgreementNo |
String |
32 |
是 |
平台抽佣协议签约编号 |
|
elecAgreeStatus |
String |
1 |
否 |
收单协议状态 |
0:未签约 1:签约成功 2:签约失败 3:签约中 |
elecAgreementNo |
String |
32 |
否 |
收单协议签约编号 |
|
sepAgreeStatus |
String |
1 |
否 |
分账协议状态 |
收单商户与分账方,需要签订分账协议时,返回 0:未签约 1:签约成功 2:签约失败 3:签约中 |
sepAgreeNo |
String |
32 |
否 |
分账协议编号 |