发起提现接口

商户业务系统可通过提现接口,将钱包余额提现到银行卡。

接口说明

提现成功判断说明:接口返回提现状态state=2为提现成功, state=1时需调用提现查询接口确认提现状态。接口返回code=0仅表示提现发起成功。

适用对象: 特约商户

请求URL:https://pay.jeepay.vip/api/wallet/cashout

请求方式:POST

请求类型:application/jsonapplication/x-www-form-urlencoded

请求参数

字段名 变量名 必填 类型 示例值 描述
商户号 mchNo String(30) M1621873433953 商户号
应用ID appId String(24) 60cc09bce4b0f1c0b83761c9 应用ID
商户订单号 mchOrderNo String(64) M16283883828 商户生成的订单号,需保证唯一
提现钱包用户编号 walletId String(30) 124442600 提现钱包用户编号
提现到账银行卡号 accountNo String(30) 62xxxxx 提现到账银行卡号
提现金额 amount long 30 提现金额, 单位:分
货币代码 currency String(3) cny 货币代码,固定cny
客户端IP地址 clientIp String(30) 127.0.0.1 客户端IP地址
异步通知地址 notifyUrl String(128) https://www.baidu.com 提现结果异步回调URL,只有传了该值才会发起回调
渠道参数 channelExtra String(256) {“code”:”13920933111042”} 特定渠道发起的额外参数,json格式字符串,保留字段
扩展参数 extParam String(512) 134586944573118714 商户扩展参数,回调时会原样返回
请求时间 reqTime long 1622016572190 请求接口时间,13位时间戳
接口版本 version String(3) 1.0 接口版本号,固定:1.0
签名 sign String(32) C380BEC2BFD727A4B6845133519F3AD6 签名值,详见签名算法
签名类型 signType String(32) MD5 签名类型,目前只支持MD5方式

请求示例数据

{
    "walletId": "2",
    "amount": 1000,
    "extParam": "mchParams",
    "mchOrderNo": "MT1700096903554",
    "sign": "24DD7074B10D9C36B5FA6924FFF532C2",
    "remark": "备注",
    "reqTime": "1700096903",
    "version": "1.0",
    "appId": "64e87b640d1480cf86ae4385",
    "accountNo": "88888",
    "clientIp": "192.166.1.132",
    "notifyUrl": "http://192.168.0.168:9216",
    "signType": "MD5",
    "currency": "cny",
    "mchNo": "M1692957540"
}

返回参数

字段名 变量名 必填 类型 示例值 描述
返回状态 code int 0 0-处理成功,其他-处理有误,详见错误码
返回信息 msg String 签名失败 具体错误原因,例如:签名失败、参数格式校验错误
签名信息 sign String CCD9083A6DAD9A2DA9F668C3D4517A84 对data内数据签名,如data为空则不返回
返回数据 data String {} 返回下单数据,json格式数据

data数据格式

字段名 变量名 必填 类型 示例值 描述
平台提现单号 cashoutId String C1724957556453224449 平台提现单号
商户订单号 mchOrderNo String MT1700096903554 商户订单号
提现金额 amount long 30 提现金额, 单位:分
提现状态 state int 2 提现状态: 0-订单生成, 1-提现中, 2-提现成功, 3-提现失败
渠道提现单号 channelOrderNo String T7812873321y8192 渠道提现单号
渠道错误码 errCode String 100E0047 上游渠道返回的错误码
渠道错误描述 errMsg String 账户余额不足 上游渠道返回的错误描述

返回示例数据

{
    "code": 0,
    "data": {
        "amount": 1000,
        "cashoutId": "C1724957556453224449",
        "channelOrderNo": "",
        "errCode": "100E0047",
        "errMsg": "账户余额不足",
        "mchOrderNo": "MT1700096903554",
        "state": 3
    },
    "msg": "SUCCESS",
    "sign": "57CD0DECAC77D13F6DCE01F504A195CF"
}

提现查询接口

商户通过该接口上送提现单号或商户订单号,查询提现状态。

接口说明

适用对象:特约商户

请求URL:https://pay.jeepay.vip/api/wallet/cashout/query

请求方式:POST

请求类型:application/jsonapplication/x-www-form-urlencoded

请求参数

字段名 变量名 必填 类型 示例值 描述
商户号 mchNo String(30) M1621873433953 商户号
应用ID appId String(24) 60cc09bce4b0f1c0b83761c9 应用ID
平台提现单号 cashoutId String(30) C20160427210604000490 平台提现单号,与mchOrderNo二者传一即可
商户订单号 mchOrderNo String(30) 20160427210604000490 商户生成的订单号,与cashoutId二者传一即可
请求时间 reqTime long 1622016572190 请求接口时间,13位时间戳
接口版本 version String(3) 1.0 接口版本号,固定:1.0
签名 sign String(32) C380BEC2BFD727A4B6845133519F3AD6 签名值,详见签名算法
签名类型 signType String(32) MD5 签名类型,目前只支持MD5方式

请求示例数据

{
    "mchOrderNo": "MT1699947028710",
    "appId": "64e87b640d1480cf86ae4385",
    "sign": "43A3B21C14955AEA3A04467A85451D98",
    "signType": "MD5",
    "reqTime": "1700099741",
    "mchNo": "M1692957540",
    "version": "1.0"
}

响应参数

字段名 变量名 必填 类型 示例值 描述
返回状态 code int 0 0-处理成功,其他-处理有误,详见错误码
返回信息 msg String 签名失败 具体错误原因,例如:签名失败、参数格式校验错误
签名信息 sign String CCD9083A6DAD9A2DA9F668C3D4517A84 对data内数据签名,如data为空则不返回
返回数据 data String {} 返回下单数据,json格式数据

data数据格式

字段名 变量名 必填 类型 示例值 描述
平台提现单号 cashoutId String C1724328933329321985 平台提现单号
商户号 mchNo String M1621873433953 商户号
应用ID appId String 60cc09bce4b0f1c0b83761c9 应用ID
商户订单号 mchOrderNo String M16283883828 商户订单号
支付接口代码 ifCode String(30) hnawalletpay 支付接口代码
提现钱包用户编号 walletId String 124442600 提现钱包用户编号
提现金额 amount long 30 提现金额, 单位:分
提现状态 state int 2 提现状态: 0-订单生成, 1-提现中, 2-提现成功, 3-提现失败
渠道提现单号 channelOrderNo String T7812873321y8192 渠道提现单号,提现状态为2时返回
提现成功时间 successTime String 2023-11-01 10:02:25 提现成功时间,提现状态为2时返回
扩展参数 extParam String 134586944573118714 商户扩展参数,回调时会原样返回
备注 remark String 备注 备注
渠道错误码 errCode String 100E0047 渠道下单返回错误码
渠道错误描述 errMsg String 账户余额不足 渠道下单返回错误描述

返回示例数据

{
    "code": 0,
    "data": {
        "amount": 1000,
        "appId": "64e87b640d1480cf86ae4385",
        "cashoutId": "C1724328933329321985",
        "channelOrderNo": "",
        "errCode": "100E0047",
        "errMsg": "账户余额不足",
        "extParam": "mchParams",
        "ifCode": "hnawalletpay",
        "mchNo": "M1692957540",
        "mchOrderNo": "MT1699947028710",
        "remark": "备注",
        "state": 3,
        "walletId": "2"
    },
    "msg": "SUCCESS",
    "sign": "099ECF5B1941F59A7319306F176CC5BA"
}

提现通知

当钱包提现成功时,平台网关会向商户系统发起回调通知。如果商户系统没有正确返回,平台网关会延迟再次通知。

接口说明

适用对象:特约商户

请求URL:该链接是通过发起提现接口提交的参数notifyUrl设置,如果无法访问链接,商户系统将无法接收通知。

请求方式:POST

请求类型:application/x-www-form-urlencoded

通知参数

字段名 变量名 必填 类型 示例值 描述
平台提现单号 cashoutId String(30) C1724328933329321985 平台提现单号
商户号 mchNo String(30) M1621873433953 商户号
应用ID appId String(24) 60cc09bce4b0f1c0b83761c9 应用ID
商户订单号 mchOrderNo String(30) 20160427210604000490 返回商户传入的订单号
支付接口代码 ifCode String(30) hnawalletpay 支付接口代码
提现钱包用户编号 walletId String 124442600 提现钱包用户编号
提现金额 amount long 30 提现金额, 单位:分
提现状态 state int 2 提现状态: 0-订单生成, 1-提现中, 2-提现成功, 3-提现失败
渠道提现单号 channelOrderNo String T7812873321y8192 渠道提现单号,提现状态为2时返回
提现成功时间 successTime String 2023-11-01 10:02:25 提现成功时间,提现状态为2时返回
扩展参数 extParam String 134586944573118714 商户扩展参数,回调时会原样返回
备注 remark String 备注 备注
渠道错误码 errCode String 100E0047 渠道下单返回错误码
渠道错误描述 errMsg String 账户余额不足 渠道下单返回错误描述
通知请求时间 reqTime String(30) 1622016572190 通知请求时间,,13位时间戳
签名 sign String(32) C380BEC2BFD727A4B6845133519F3AD6 签名值,详见签名算法

返回结果

商户业务系统处理后同步返回给平台网关,返回字符串 success 则表示成功,返回非success则表示处理失败,支付中心会再次通知业务系统。(通知频率为0/30/60/90/120/150,单位:秒)

注意:返回的字符串必须是小写,且前后不能有空格和换行符。

通知示例数据

{
  "amount": 1000,
  "appId": "64e87b640d1480cf86ae4385",
  "cashoutId": "C1724328933329321985",
  "channelOrderNo": "",
  "errCode": "",
  "errMsg": "",
  "extParam": "mchParams",
  "ifCode": "hnawalletpay",
  "mchNo": "M1692957540",
  "mchOrderNo": "MT1699947028710",
  "remark": "备注",
  "state": 2,
  "walletId": "2",
  "reqTime": "1622016572190",
  "sign": "099ECF5B1941F59A7319306F176CC5BA"
}

返回码

code 描述
0 成功
9999 异常,具体错误详见msg字段
文档更新时间: 2024-04-30 10:44   作者:朱小