查询提现账户余额

查询商户应用配置的渠道账户的可用余额。发起提现时,提现金额不可超出可用余额。

接口说明

适用对象:特约商户

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

请求方式:POSTGET

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

请求参数

字段名 变量名 必填 类型 示例值 描述
商户号 mchNo String(30) M1621873433953 商户号
应用ID appId String(32) 60cc09bce4b0f1c0b83761c9 应用ID
支付接口 ifCode String(24) shengpay 支付接口,例如:shengpay-盛付通
请求时间 reqTime long 1622016572190 请求接口时间,13位时间戳
接口版本 version String(3) 1.0 接口版本号,固定:1.0
签名 sign String(32) C380BEC2BFD727A4B6845133519F3AD6 签名值,详见签名算法
签名类型 signType String(32) MD5 签名类型,目前只支持MD5或RSA2方式

请求示例数据

{
    "ifCode": "shengpay",
    "appId": "653b67b90d14f66aa119a518",
    "sign": "AC186C9168312C02BB34EA430F320E05",
    "signType": "MD5",
    "reqTime": "1718791936",
    "mchNo": "M1698391993",
    "version": "1.0"
}

返回参数

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

data数据格式

字段名 变量名 必填 类型 示例值 描述
可用余额 balance int 100 账户可用余额金额,单位分

返回示例数据

{
    "code": 0,
    "data": {
        "balance": 5577
    },
    "msg": "SUCCESS",
    "sign": "EF09DA6F6D15AB1FA97E5FC629EC6289"
}

发起提现

商户通过该接口对商户应用配置的渠道账户发起提现。发起提现时,可先查余额,再发起提现。
接口返回成功,仅表示提现发起成功,具体状态以提现状态为准

接口说明

适用对象:特约商户

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

请求方式:POST

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

请求参数

字段名 变量名 必填 类型 示例值 描述
商户号 mchNo String(30) M1621873433953 商户号
应用ID appId String(32) 60cc09bce4b0f1c0b83761c9 应用ID
商户提现单号 mchOrderNo String(30) 20160427210604000490 商户生成的提现单号,保证唯一
提现金额 amount int 100 提现金额,单位分
支付接口 ifCode String(24) shengpay 支付接口,例如:shengpay-盛付通
渠道参数 channelExtra String(256 {} 特定渠道发起的额外参数,json格式字符串.保留字段
备注 remark String(256) 备注 备注
请求时间 reqTime long 1622016572190 请求接口时间,13位时间戳
接口版本 version String(3) 1.0 接口版本号,固定:1.0
签名 sign String(32) C380BEC2BFD727A4B6845133519F3AD6 签名值,详见签名算法
签名类型 signType String(32) MD5 签名类型,目前只支持MD5或RSA2方式

请求示例数据

{
    "ifCode": "shengpay",
    "amount": 1,
    "mchOrderNo": "1718792536732",
    "appId": "653b67b90d14f66aa119a518",
    "sign": "B1C018C4C5B21E38C1D032518CFCF3CE",
    "signType": "MD5",
    "remark": "备注1",
    "reqTime": "1718792536",
    "mchNo": "M1698391993",
    "version": "1.0"
}

返回参数

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

data数据格式

字段名 变量名 必填 类型 示例值 描述
支付系统提现单号 cashoutOrderId String(30) C12021022311124442600 支付系统提现单号
商户提现单号 mchOrderNo String(30) 20160427210604000490 返回商户传入的提现单号
提现状态 state int 2 提现状态: 0-提现单初始化, 1-提现中, 2-提现成功, 3-提现失败
渠道错误码 errCode String 1002 渠道返回错误码
渠道错误描述 errMsg String 134586944573118714 渠道返回错误描述

返回示例数据

{
    "code": 0,
    "data": {
        "cashoutOrderId": "C1803372723469307905",
        "mchOrderNo": "1718792536732",
        "state": 1
    },
    "msg": "SUCCESS",
    "sign": "2E665EE65D79482281AFD9A4DB389DB5"
}

查询提现详情

商户通过该接口查询提现订单状态和提现成功时的详细信息,支付网关会返回最新的数据

接口说明

适用对象:特约商户

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

请求方式:POST

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

请求参数

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

请求示例数据

{
    "cashoutOrderId": "C1802947294409359361",
    "appId": "653b67b90d14f66aa119a518",
    "sign": "E630D5AEAF3A081EFD836CE0108DFE5E",
    "signType": "MD5",
    "reqTime": "1718793054",
    "mchNo": "M1698391993",
    "version": "1.0"
}

返回参数

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

data数据格式

字段名 变量名 必填 类型 示例值 描述
商户号 mchNo String(30) M1621873433953 商户号
应用ID appId String(32) 60cc09bce4b0f1c0b83761c9 应用ID
支付接口 ifCode String(24) shengpay 支付接口,例如:shengpay-盛付通
支付系统提现单号 cashoutOrderId String(30) C12021022311124442600 支付系统提现单号
商户提现单号 mchOrderNo String(30) 20160427210604000490 返回商户传入的提现单号
提现状态 state int 2 提现状态: 0-提现单初始化, 1-提现中, 2-提现成功, 3-提现失败
申请提现金额 amount int 100 申请提现金额,单位分
提现前余额 balance int 1 提现前余额,单位分
渠道提现单号 channelOrderNo String 20160427210604000490 对应渠道提现单号
渠道错误码 errCode String 1002 渠道下单返回错误码
渠道错误描述 errMsg String 134586944573118714 渠道下单返回错误描述
提现成功时间 successTime long 1622016572190 提现成功时间,13位时间戳
提现银行名称 bankName String(64) 中国农业银行 提现银行名称,提现成功时返回
提现账户 accountNo String(64) 622180*2659 提现账户,提现成功时返回
提现账户名称 accountName String(64) 张三 提现账户名称,提现成功时返回
备注 remark String(256) 134586944573118714 备注
创建时间 createdAt long 1622016572190 订单创建时间,13位时间戳

返回示例数据

{
    "code": 0,
    "data": {
        "accountName": "张三",
        "accountNo": "622180*********2659",
        "amount": 1,
        "appId": "6563f0e90d146216c2003bcf",
        "bankName": "邮储银行",
        "cashoutOrderId": "C1802947294409359361",
        "channelOrderNo": "5909065809925273601117",
        "createdAt": 1718691106819,
        "ifCode": "shengpay",
        "mchNo": "M1698391993",
        "state": 2,
        "successTime": 1718691242000
    },
    "msg": "SUCCESS",
    "sign": "B8DEAA727973873A67F368E6A01E39F2"
}

返回码

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