钱包开户接口
商户业务系统通过该接口创建钱包用户,支付网关根据传入信息创建账户,创建成功会返回钱包编号,失败则返回错误信息。
接口说明
开户时传递的银行卡会自动绑定到用户,可不再调用银行卡绑定接口。
适用对象: 特约商户
请求URL:https://pay.jeepay.vip/api/wallet/user
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(30) | M1621873433953 | 商户号 |
应用ID | appId | 是 | String(30) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
商户订单号 | mchOrderNo | 是 | String(64) | MHO894289238932 | 商户订单号 |
支付接口代码 | ifCode | 是 | String(20) | hnawalletpay | 支付接口代码,目前仅支持:hnawalletpay |
身份证号 | idcardNo | 是 | String(64) | 130xxxxx | 身份证号 |
身份证姓名 | idcardName | 是 | String(64) | 张三 | 身份证姓名 |
手机号 | telphone | 是 | String(32) | 139xxxxx | 手机号 |
银行卡号 | accountNo | 是 | String(32) | 62xxxxx | 银行卡号 |
银行名称 | bankName | 是 | String(32) | 中国农业银行 | 银行名称 |
银行预留手机号 | bankMobile | 否 | String(32) | 139xxxxx | 为空,则取值上面手机号telphone字段 |
开户行支行名称 | bankBranchName | 否 | String(64) | 人民路支行 | 开户行支行名称 |
开户银行联行号 | bankBranchCode | 否 | String(32) | 12255465522 | 开户银行联行号 |
备注 | remark | 否 | String(256) | 备注 | 备注 |
请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 2.0 | 接口版本号,固定:2.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5方式 |
请求示例数据
{
"mchNo": "M1623984572",
"appId": "60cc09bce4b0f1c0b83761c9",
"ifCode": "hnawalletpay",
"idcardNo": "130xxxxx",
"idcardName": "张三",
"telphone": "139xxxxx",
"accountNo": "62xxxxx",
"accountName": "张三",
"bankName": "中国农业银行",
"bankMobile": "139xxxxx",
"remark": "备注",
"signType": "MD5",
"sign": "84F606FA25A6EC4783BECC08D4FDC681",
"reqTime": "1622016572190",
"version": "1.0"
}
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | int | 0 | 0-处理成功,其他-处理有误,详见错误码 |
返回信息 | msg | 否 | String | 签名失败 | 具体错误原因,例如:签名失败、参数格式校验错误 |
签名信息 | sign | 否 | String | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String | {} | 返回下单数据,json格式数据 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
钱包用户编号 | walletId | 是 | String | 124442600 | 返回钱包用户编号 |
开户状态 | channelState | 是 | int | 2 | 开户状态 0-未开户 1-开户成功 2-待审核 3-审核拒绝 4-待激活 5-开户失败 6-已注销 |
渠道错误码 | errCode | 否 | String | IDCARDNAME_INVALID | 上游渠道返回的错误码 |
渠道错误描述 | errMsg | 否 | String | Business Failed 失败 | 上游渠道返回的错误描述 |
返回示例数据
{
"code": 0,
"data": {
"channelState": 1,
"walletId": "124442600"
},
"msg": "SUCCESS",
"sign": "F4DA202C516D1F33A12F1E547C5004FD"
}
银行卡绑定接口
商户业务系统通过该接口绑定银行卡,用户提现需先绑定银行卡。
接口说明
卡号不变时,重复调用此接口将修改银行卡信息。
适用对象: 特约商户
请求URL:https://pay.jeepay.vip/api/wallet/bankcard/bind
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(30) | M1621873433953 | 商户号 |
应用ID | appId | 是 | String(30) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
商户订单号 | mchOrderNo | 是 | String(64) | MHO894289238932 | 商户订单号 |
钱包用户编号 | walletId | 是 | String(30) | 124442600 | 钱包用户编号 |
银行卡号 | accountNo | 是 | String(64) | 62xxxxx | 银行卡号 |
开户名称 | accountName | 是 | String(64) | 张三 | 开户名称 |
银行名称 | bankName | 是 | String(32) | 中国农业银行 | 银行名称 |
银行预留手机号 | bankMobile | 是 | String(32) | 139xxxxx | 银行预留手机号 |
开户行省份 | province | 否 | String(32) | 河北省 | 开户行省份 |
开户行城市 | city | 否 | String(32) | 沧州市 | 开户行城市 |
开户支行名称 | bankBranchName | 否 | String(64) | 人民路支行 | 开户支行名称 |
开户行联行号 | bankBranchCode | 否 | String(32) | 1025445457 | 开户行联行号 |
备注 | remark | 否 | String(256) | 备注 | 备注 |
请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5方式 |
请求示例数据
{
"mchNo": "M1623984572",
"appId": "60cc09bce4b0f1c0b83761c9",
"mchOrderNo": "MHO894289238932",
"walletId": "124442600",
"accountNo": "62xxxxx",
"accountName": "张三",
"bankName": "中国农业银行",
"bankMobile": "139xxxxx",
"province": "河北省",
"city": "沧州市",
"bankBranchName": "人民路支行",
"bankBranchCode": "1025445457",
"remark": "备注",
"signType": "MD5",
"sign": "84F606FA25A6EC4783BECC08D4FDC681",
"reqTime": "1622016572190",
"version": "1.0"
}
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | int | 0 | 0-处理成功,其他-处理有误,详见错误码 |
返回信息 | msg | 否 | String | 签名失败 | 具体错误原因,例如:签名失败、参数格式校验错误 |
签名信息 | sign | 否 | String | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String | {} | 返回下单数据,json格式数据 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户订单号 | mchOrderNo | 是 | String | MHO894289238932 | 商户订单号 |
渠道绑卡状态 | channelState | 是 | int | 1 | 渠道绑卡状态 0-未绑定 1-已绑定 2-绑定失败 |
渠道错误码 | errCode | 否 | String | IDCARDNAME_INVALID | 上游渠道返回的错误码 |
渠道错误描述 | errMsg | 否 | String | Business Failed 失败 | 上游渠道返回的错误描述 |
返回示例数据
{
"code": 0,
"data": {
"channelState": 1,
"mchOrderNo": "MHO894289238932"
},
"msg": "SUCCESS",
"sign": "F4DA202C516D1F33A12F1E547C5004FD"
}
钱包查询接口
商户通过该接口上送钱包编号,查询钱包开户信息、状态、余额等。
接口说明
适用对象:特约商户
请求URL:https://pay.jeepay.vip/api/wallet/user/query
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(30) | M1621873433953 | 商户号 |
应用ID | appId | 是 | String(24) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
钱包用户编号 | walletId | 是 | String(30) | 124442600 | 开户接口返回的钱包用户编号 |
请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5方式 |
请求示例数据
{
"walletId": "124442600",
"appId": "60cc09bce4b0f1c0b83761c9",
"sign": "46940C58B2F3AE426B77A297ABF4D31E",
"signType": "MD5",
"reqTime": "1624006009",
"mchNo": "M1623984572",
"version": "1.0"
}
响应参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | int | 0 | 0-处理成功,其他-处理有误,详见错误码 |
返回信息 | msg | 否 | String | 签名失败 | 具体错误原因,例如:签名失败、参数格式校验错误 |
签名信息 | sign | 否 | String | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String | {} | 返回下单数据,json格式数据 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
钱包用户编号 | walletId | 是 | String | 124442600 | 返回钱包用户编号 |
商户号 | mchNo | 是 | String | M1621873433953 | 商户号 |
应用ID | appId | 是 | String | 60cc09bce4b0f1c0b83761c9 | 应用ID |
支付接口代码 | ifCode | 是 | String | hnawalletpay | 支付接口代码 |
钱包状态 | state | 是 | int | 1 | 钱包状态 0-停用 1-启用 |
开户状态 | channelState | 是 | int | 1 | 开户状态 0-未开户 1-开户成功 2-待审核 3-审核拒绝 4-待激活 5-开户失败 6-已注销 |
身份证号 | idcardNo | 是 | String | 130xxxxx | 身份证号 |
身份证姓名 | idcardName | 是 | String | 张三 | 身份证姓名 |
手机号 | telphone | 是 | String | 139xxxxx | 手机号 |
账户余额 | balance | 否 | long | 32 | 账户余额,单位分,金额相关字段仅开户成功的用户返回 |
可用余额 | availableBalance | 否 | long | 0 | 可用余额,单位分 |
待清算余额 | unclearBalance | 否 | long | 0 | 待清算余额,单位分 |
待清算余额汇总 | unclearSumBalance | 否 | long | 0 | 待清算余额汇总,单位分 |
待结转余额 | unsettleBalance | 否 | long | 0 | 待结转余额,单位分 |
备注 | remark | 否 | String | 备注 | 备注 |
返回示例数据
{
"code": 0,
"data": {
"appId": "64e87b640d1480cf86ae4385",
"availableBalance": 0,
"balance": 32,
"channelState": 1,
"idcardName": "张*",
"idcardNo": "130************001",
"ifCode": "hnawalletpay",
"mchNo": "M1692957540",
"state": 1,
"telphone": "132****0001",
"unclearBalance": 0,
"unclearSumBalance": 0,
"unsettleBalance": 0,
"walletId": "2"
},
"msg": "SUCCESS",
"sign": "9548145EA12D0CD8C1628BCF44E19E0D"
}
钱包明细查询接口
商户通过该接口上送钱包编号,查询钱包账户资金变动明细。
接口说明
适用对象:特约商户
请求URL:https://pay.jeepay.vip/api/wallet/user/changeDetails
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(30) | M1621873433953 | 商户号 |
应用ID | appId | 是 | String(24) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
钱包用户编号 | walletId | 是 | String(30) | 124442600 | 开户接口返回的钱包用户编号 |
开始时间 | startDate | 否 | String(20) | 2023-10-01 | 查询开始时间,格式:YYYY-MM-DD,默认查询近30天 |
结束时间 | endDate | 否 | String(20) | 2023-10-07 | 查询结束时间,格式:YYYY-MM-DD,默认查询近30天 |
请求页数 | pageNum | 是 | int | 1 | 请求页数 |
请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5方式 |
请求示例数据
{
"walletId": "2",
"startDate": "2023-10-01",
"endDate": "2023-10-07",
"appId": "64e87b640d1480cf86ae4385",
"sign": "C5FDF8303DE9E4F4C6592D1DDBEA9AF6",
"signType": "MD5",
"reqTime": "1700039659",
"mchNo": "M1692957540",
"pageNum": 1,
"version": "1.0"
}
响应参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | int | 0 | 0-处理成功,其他-处理有误,详见错误码 |
返回信息 | msg | 否 | String | 签名失败 | 具体错误原因,例如:签名失败、参数格式校验错误 |
签名信息 | sign | 否 | String | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String | {} | 返回下单数据,json格式数据 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
钱包用户编号 | walletId | 是 | String | 124442600 | 开户接口返回的钱包用户编号 |
总条数 | total | 是 | int | 3 | 账户变更明细总数 |
账户明细列表 | changeDetailList | 否 | List | - | 账户明细列表,具体数据见下方说明 |
渠道错误码 | errCode | 否 | String | 1002 | 渠道关单返回错误码 |
渠道错误描述 | errMsg | 否 | String | 关闭异常 | 渠道关单返回错误描述 |
账户明细说明
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
交易类型 | tradeType | 是 | String | 124442600 | 交易类型 trans-转账 cashout-提现 pay-收款 refund-退款 |
交易金额 | amount | 是 | long | 3 | 交易金额,单位分 |
交易金额变动方向 | fundChangeType | 否 | String | - | 交易金额变动方向,+增加,-减少 |
渠道订单号 | channelOrderId | 否 | String | 1002 | 上游渠道订单号 |
交易后余额 | balance | 否 | long | 32 | 交易后余额 |
摘要 | summary | 否 | String | 提现 | 摘要 |
交易时间 | tradeTime | 否 | String | 2023-10-23 17:09:25 | 交易时间,格式:YYYY-DD-MM HH:MM:SS |
返回示例数据
{
"code": 0,
"data": {
"changeDetailList": [
{
"amount": 1,
"balance": 32,
"channelOrderId": "2023111510640951",
"fundChangeType": "-",
"summary": "转出",
"tradeTime": "2023-11-15 10:04:00",
"tradeType": "trans"
},
{
"amount": 1,
"balance": 33,
"channelOrderId": "2023102317122246",
"fundChangeType": "-",
"summary": "转出",
"tradeTime": "2023-10-23 17:09:25",
"tradeType": "trans"
},
{
"amount": 1,
"balance": 34,
"channelOrderId": "2023102317122236",
"fundChangeType": "-",
"summary": "提现",
"tradeTime": "2023-10-23 17:09:22",
"tradeType": "cashout"
}
],
"total": 3,
"walletId": 2
},
"msg": "SUCCESS",
"sign": "A1A30415727C1A0E0CEFC5EE0420207A"
}
返回码
code | 描述 |
---|---|
0 | 成功 |
9999 | 异常,具体错误详见msg字段 |