接口地址:https://dms-api.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/withdraw
测试地址:https://dms-api-test.shopoint.cn/shopoint-openapis-web/szyx/apiweb/fund/withdraw
使用场景:开通了数字营销结算资金管理的商户,可以通过此接口发起提现。本接口如果返回的状态是1-提现中,则需要通过查询接口查询最终状态。
请求参数
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
||
appid |
应用ID |
平台分配的APPID |
否 |
20 |
|
||
orgid |
机构ID |
实际交易的机构ID |
是 |
11 |
服务商appid调用时必填 |
||
cusid |
商户号 |
店铺ID 分佣方Id _platform_ |
否 |
11 |
_platform_表示平台会员 |
||
reqsn |
提现申请单号 |
|
否 |
20 |
保证商户平台唯一 |
||
withdrawAmount |
提现金额 |
单位:分 |
否 |
15 |
|
||
notifyUrl |
提现结果通知地址 |
|
是 |
300 |
设置该地址后,提现成功或者失败将发起通知 注意:本请求直接返回失败时,没有通知 |
||
summary |
摘要 |
|
是 |
100 |
大B为结算通时,长度为100; 大B为其他类型时,长度为50 |
||
|
|
|
|
|
|
||
version |
版本号 |
接口版本号 |
可 |
2 |
默认填11 |
||
randomstr |
随机字符串 |
随机生成的字符串 |
否 |
32 |
|
||
signtype |
签名类型 |
|
是 |
8 |
支持MD5、RSA、SM2,不填默认MD5 |
||
sign |
签名 |
|
否 |
32 |
详见安全规范 |
响应参数
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
retcode |
返回码 |
SUCCESS/FAIL |
否 |
8 |
此字段是通信标识,非交易结果,交易是否成功需要查看withdrawStatus和结果查询接口返回的withdrawStatus来判断 |
retmsg |
返回码说明 |
|
是 |
100 |
|
以下信息只有当retcode为SUCCESS时有返回 |
|||||
cusid |
商户号 |
店铺ID 分佣方Id _platform_ |
否 |
11 |
|
externalCode |
外部商户号 |
店铺编号 外部分佣方编号 |
是 |
30 |
|
appid |
应用ID |
平台分配的APPID |
否 |
20 |
|
orgid |
机构ID |
实际交易的机构ID |
否 |
11 |
|
reqsn |
提现申请单号 |
|
否 |
20 |
|
withdrawTId |
提现流水编号 |
|
是 |
11 |
通联返回的提现交易流水号 |
accountUserId |
账户Id |
|
否 |
11 |
|
accountSetNo |
账户集编号 |
100001,余额户 2000000,营销户 100000001,储值卡专用户 |
否 |
8 |
|
referenceType |
账户来源 |
11,大B 13,店铺 49,外部分佣方 |
|
2 |
|
shopName |
店铺名 |
|
是 |
50 |
|
accountName |
账户名称 |
|
否 |
200 |
|
withdrawAmount |
提现金额 |
单位:分 |
否 |
15 |
实际到账金额 |
fee |
手续费 |
单位:分 |
否 |
15 |
提现手续费 |
summary |
摘要 |
|
是 |
100 |
大B为结算通时,长度为100; 大B为其他类型时,长度为50 |
withdrawStatus |
提现状态 |
1,提现中 3,提现失败 |
否 |
2 |
|
withdrawStatusDesc |
提现状态描述 |
1,提现中 3,提现失败原因 |
否 |
100 |
|
signtype |
签名类型 |
|
否 |
4 |
支持MD5、RSA、SM2 |
sign |
签名 |
|
否 |
32 |
详见安全规范 |