2.0-支付接口
2.1 支付申请
2.1.1 简要描述
申请支付,待发放的人员,通过必要流程验证,系统生成支付结算批次订单并发放.
2.1.2 请求URL
/regulator/openapi/v2/task/payment
请求方式
- POST
返回类型
- JSON
2.1.3 请求参数
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
payAccountNo | String | Y | 支付账号 | 为接口(1.2-账户余额查询)返回数据中的defaultAccount=true 对应记录的subAccountNo字段 |
bizCode | String(32) | Y | 业务参考号 | 接入方系统中的结算单编码 |
orderDetailList | List(1000) | Y | 订单明细 | 如下 |
订单明细详情
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
subBizCode | String(32) | Y | 子业务参考号 | 接入方系统中的结算单明细编码 |
receiptAccountNo | String | Y | 收款人账户号 | 支持国内大部分银行,部分银行及第三方支付账号存在较高支付失败几率,不建议使用以下银行卡作为收款账户:中国农业银行、农商银行、中国邮政储蓄银行、农村信用社、微信、支付宝。 |
receiptBankName | String | N | 收款银行名称 | |
receiptAccountName | String | Y | 收款人开户名 | |
receiptAccountAddress | String | N | 收款人开户地址 | |
receiptPhone | String | Y | 收款手机号 | |
receiptCardNo | String | Y | 收款人身份证号 | |
taskAmount | BigDecimal | Y | 交易金额(元) | 单位:元,保留两位小小数截位 |
2.1.4 返回参数(JSON)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
msg | String | 返回结果描述 | |
code | String | 返回状态码 | 200成功,其他均为失败 |
success | boolean | 是否成功 | true/false |
data | String(32) | 返回数据 | 批次号 |
2.1.5 接口请求示例
{
"payAccountNo":"1001102003000206",
"bizCode":"WOD2020071700005",
"orderDetailList":[
{
"subBizCode":"WTD2020071700005",
"receiptAccountNo":"123456789",
"receiptBankName":"招商银行",
"receiptAccountName":"张三",
"receiptAccountAddress":"招商银行上海支行",
"receiptPhone":"18888668866",
"receiptCardNo":"330312192311211241",
"taskAmount":"100"
}
]
}
接口成功返回示例
{
"msg": "",
"code": "200",
"success": true,
"data": "WAD1240801827917284129"
}
接口失败返回示例
{
"requestId":"40b870e44e9cb39c",
"msg":"订单已存在",
"code":"999",
"success":false,
"data":null
}
2.1.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
2.2 通过订单编号查询订单批次
2.2.1 简要描述
查询已申请的结算单订单批次信息
2.2.2 请求URL
/regulator/openapi/v2/task/query/order/order_code/{orderCode}
请求方式
- GET
返回类型
- JSON
2.2.3 请求参数
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
orderCode | String | Y | 订单号 |
2.2.4 返回参数(JSON)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
msg | String | 返回结果描述 | |
code | String | 返回状态码 | 200成功,其他均为失败 |
success | boolean | 是否成功 | true/false |
data | String | 返回数据 | 详情见下表 |
返回数据明细(data)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
bizCode | String | 业务参考号 | |
payAccountNo | String | 支付账户 | |
orderCode | String | 订单编号 | |
orderStatus | Integer | 订单状态 | 1新建, 2取消, 3部分成功, 4全部成功, 5失败,6未知, 21已冻结, 22已锁定, 23结算中, 24处理中 |
failReason | Sring | 失败原因 | DETAIL_VERIFY_ERROR(子订单校验不通过); BALANCE_LACK(余额不足) |
2.2.5 接口示例
必填参数查询
/regulator/openapi/v2/task/query/order/order_code/WAD1240801827917284129
必填参数查询接口返回示例
{
"msg": "",
"code": "200",
"success": true,
"data": {
"bizCode": "WOD2020071700005",
"payAccountNo": "1001102003000206",
"orderCode": "WAD1240801827917284129",,
"orderStatus": 3,
"failReason": ""
}
}
2.2.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
2.3 通过业务参考号查询订单批次
2.3.1 简要描述
查询已申请的订单批次信息
2.3.2 请求URL
/regulator/openapi/v2/task/query/order/biz_code/{bizCode}
请求方式
- GET
返回类型
- JSON
2.3.3 请求参数
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
bizCode | String | Y | 业务参考号 |
2.3.4 返回参数(JSON)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
msg | String | 返回结果描述 | |
code | String | 返回状态码 | 200成功,其他均为失败 |
success | boolean | 是否成功 | true/false |
data | String | 返回数据 | 详情见下表 |
返回数据明细(data)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
bizCode | String | 业务参考号 | |
payAccountNo | String | 支付账户 | |
orderCode | String | 订单编号 | |
orderStatus | Integer | 订单状态 | 1新建, 2取消, 3部分成功, 4全部成功, 5失败,6未知, 21已冻结, 22已锁定, 23结算中, 24处理中 |
failReason | Sring | 失败原因 | DETAIL_VERIFY_ERROR(子订单校验不通过); BALANCE_LACK(余额不足) |
2.3.5 接口请求示例
/regulator/openapi/v2/task/query/order/biz_code/WOD2020071700005
必填参数查询接口返回示例
{
"msg": "",
"code": "200",
"success": true,
"data": {
"bizCode": "WOD2020071700005",
"payAccountNo": "1001102003000206",
"orderCode": "WAD1240801827917284129",,
"orderStatus": 3,
"failReason": ""
}
}
2.3.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
2.4 通过订单编号查询订单明细
2.4.1 简要描述
查询订单明细
2.4.2 请求URL
/regulator/openapi/v2/task/query/order_detail/{orderCode}
请求方式
- GET
返回类型
- JSON
2.4.3 请求参数
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
orderCode | String | Y | 订单编号 |
2.4.4 返回参数(JSON)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
msg | String | 返回结果描述 | |
code | String | 返回状态码 | 200成功,其他均为失败 |
success | boolean | 是否成功 | true/false |
data | List | 返回数据 | 明细如下 |
返回数据明细(data)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
payAccountNo | String | 支付账号 | |
subBizCode | String | 子业务参考号 | |
taskAmount | BigDecimal | 任务金额 | |
settlementAmount | BigDecimal | 结算金额 | |
serviceAmount | BigDecimal | 服务费金额 | |
taxAmount | BigDecimal | 税金 | |
receiptAccountNo | String | 收款账号 | |
receiptBankName | String | 收款银行地址 | |
receiptAccountName | Sring | 收款户名 | |
receiptAccountAddress | Sring | 收款账户地址 | |
receiptPhone | Sring | 收款方手机号 | |
receiptCardNo | Sring | 收款方身份证号 | |
orderDetailStatus | Integer | 子订单状态 | 1新建2成功3失败 |
failReason | Sring | 失败原因 | REAL_NAME_CHECK_FAIL(用户未通过实名验证) CONTRACT_CHECK_FAIL(用户未签约) RECEIPT_ACCOUNT_ERROR(收款账户未通过校验) RECEIPT_BANK_ERROR(收款银行未校验) RECEIPT_ACCOUNT_NOT_EXISTS(收款账户不存在) RECEIPT_INFO_ERROR(收款信息未通过三要素校验) ID_CARD_NOT_CORRECT(用户身份证校验失败) PHONE_NOT_CORRECT(用户手机号校验失败) RECEIPT_AGE_NOT_CORRECT(用户年龄不符合) RECEIPT_LIMIT_AMOUNT_LACK(用户当月限额不足) RECEIPT_CREATE_ERROR(用户创建失败) |
2.4.5 接口请求示例
请求url
/regulator/openapi/v2/task/query/order_detail/WOD2020071700005
返回结果
{
"msg": "",
"code": "200",
"success": true,
"data": [{
"subBizCode": "WOD2020071700005",
"payAccountNo": "1001102003000206",
"taskAmount": 100,
"settlementAmount": 103,
"serviceAmount": 3,
"taxAmount": 1,
"receiptAccountNo": "330312192311211241",
"receiptBankName": "招商银行",
"receiptAccountName": "张三",
"receiptAccountAddress": "招商银行上海支行",
"receiptPhone": "18888668866",
"receiptCardNo": "330312192311211241",
"orderDetailStatus": "1",
"failReason": ""
}]
}
2.4.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
2.5 通过业务参考号查询订单明细
2.5.1 简要描述
查询订单明细
2.5.2 请求URL
/regulator/openapi/v2/task/query/order_detail/biz_code/{bizCode}
请求方式
- GET
返回类型
- JSON
2.5.3 请求参数
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
bizCode | String | Y | 业务参考号 |
2.5.4 返回参数(JSON)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
msg | String | 返回结果描述 | |
code | String | 返回状态码 | 200成功,其他均为失败 |
success | boolean | 是否成功 | true/false |
data | List | 返回数据 | 明细如下 |
返回数据明细(data)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
payAccountNo | String | 支付账号 | |
subBizCode | String | 子业务参考号 | |
taskAmount | BigDecimal | 任务金额 | |
settlementAmount | BigDecimal | 结算金额 | |
serviceAmount | BigDecimal | 服务费金额 | |
taxAmount | BigDecimal | 税金 | |
receiptAccountNo | String | 收款账号 | |
receiptBankName | String | 收款银行地址 | |
receiptAccountName | Sring | 收款户名 | |
receiptAccountAddress | Sring | 收款账户地址 | |
receiptPhone | Sring | 收款方手机号 | |
receiptCardNo | Sring | 收款方身份证号 | |
orderDetailStatus | Integer | 子订单状态 | 1新建2成功3失败 |
failReason | Sring | 失败原因 | REAL_NAME_CHECK_FAIL(用户未通过实名验证) CONTRACT_CHECK_FAIL(用户未签约) RECEIPT_ACCOUNT_ERROR(收款账户未通过校验) RECEIPT_BANK_ERROR(收款银行未校验) RECEIPT_ACCOUNT_NOT_EXISTS(收款账户不存在) RECEIPT_INFO_ERROR(收款信息未通过三要素校验) ID_CARD_NOT_CORRECT(用户身份证校验失败) PHONE_NOT_CORRECT(用户手机号校验失败) RECEIPT_AGE_NOT_CORRECT(用户年龄不符合) RECEIPT_LIMIT_AMOUNT_LACK(用户当月限额不足) RECEIPT_CREATE_ERROR(用户创建失败) |
2.5.5 接口请求示例
请求url
/regulator/openapi/v2/task/query/order_detail/biz_code/WOD2020071700005
返回结果
{
"msg": "",
"code": "200",
"success": true,
"data": [{
"subBizCode": "WOD2020071700005",
"payAccountNo": "1001102003000206",
"taskAmount": 100,
"settlementAmount": 103,
"serviceAmount": 3,
"taxAmount": 1,
"receiptAccountNo": "330312192311211241",
"receiptBankName": "招商银行",
"receiptAccountName": "张三",
"receiptAccountAddress": "招商银行上海支行",
"receiptPhone": "18888668866",
"receiptCardNo": "330312192311211241",
"orderDetailStatus": "1",
"failReason": ""
}]
}
2.5.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
2.6 通过明细订单业务编号查询订单明细
2.6.1 简要描述
查询订单明细
2.6.2 请求URL
/regulator/openapi/v2/task/query/order_detail/sub_biz_code/{subBizCode}
请求方式
- GET
返回类型
- JSON
2.6.3 请求参数
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
subBizCode | String | Y | 明细订单业务编号 |
2.6.4 返回参数(JSON)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
msg | String | 返回结果描述 | |
code | String | 返回状态码 | 200成功,其他均为失败 |
success | boolean | 是否成功 | true/false |
data | Object | 返回数据 | 明细如下 |
返回数据明细(data)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
payAccountNo | String | 支付账号 | |
subBizCode | String | 子业务参考号 | |
taskAmount | BigDecimal | 任务金额 | |
settlementAmount | BigDecimal | 结算金额 | |
serviceAmount | BigDecimal | 服务费金额 | |
taxAmount | BigDecimal | 税金 | |
receiptAccountNo | String | 收款账号 | |
receiptBankName | String | 收款银行地址 | |
receiptAccountName | Sring | 收款户名 | |
receiptAccountAddress | Sring | 收款账户地址 | |
receiptPhone | Sring | 收款方手机号 | |
receiptCardNo | Sring | 收款方身份证号 | |
orderDetailStatus | Integer | 子订单状态 | 1新建2成功3失败 |
failReason | Sring | 失败原因 | REAL_NAME_CHECK_FAIL(用户未通过实名验证) CONTRACT_CHECK_FAIL(用户未签约) RECEIPT_ACCOUNT_ERROR(收款账户未通过校验) RECEIPT_BANK_ERROR(收款银行未校验) RECEIPT_ACCOUNT_NOT_EXISTS(收款账户不存在) RECEIPT_INFO_ERROR(收款信息未通过三要素校验) ID_CARD_NOT_CORRECT(用户身份证校验失败) PHONE_NOT_CORRECT(用户手机号校验失败) RECEIPT_AGE_NOT_CORRECT(用户年龄不符合) RECEIPT_LIMIT_AMOUNT_LACK(用户当月限额不足) RECEIPT_CREATE_ERROR(用户创建失败) |
2.6.5 接口请求示例
请求url
/regulator/openapi/v2/task/query/order_detail/sub_biz_code/s7q4by7qaeheyfs28t8ef9cyha2t2f9y
返回结果
{
"msg": "",
"code": "200",
"success": true,
"data": {
"subBizCode": "WOD2020071700005",
"payAccountNo": "1001102003000206",
"taskAmount": 100,
"settlementAmount": 103,
"serviceAmount": 3,
"taxAmount": 1,
"receiptAccountNo": "330312192311211241",
"receiptBankName": "招商银行",
"receiptAccountName": "张三",
"receiptAccountAddress": "招商银行上海支行",
"receiptPhone": "18888668866",
"receiptCardNo": "330312192311211241",
"orderDetailStatus": "1",
"failReason": ""
}
}
2.6.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
2.7 退票明细列表查询
2.7.1 简要描述
查询退票订单明细列表
2.7.2 请求URL
/regulator/openapi/v2/task/refund_list
2.7.3 请求参数(GET)
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
pageNo | Integer | Y | 页号 | 分页大大小为200 |
orderCode | String | N | 订单编号 | |
subBizCode | String | N | 子业务参考号 | |
minTaskAmount | BigDecimal | N | 最小金额 | |
maxTaskAmount | BigDecimal | N | 最大金额 | |
receiptAccountNo | String | N | 收款账户 | 不支持模糊查询 |
receiptAccountName | String | N | 收款户名 | 不支持模糊查询 |
receiptCardNo | String | N | 收款身份证号 | 不支持模糊查询 |
startDate | Date | N | 开始时间 | yyyy-MM-dd HH:mm:ss 开始时间不得超过当前时间前30天, 默认查询当前时间前三天的订单明细 |
endDate | Date | N | 结束时间 | yyyy-MM-dd HH:mm:ss 结束时间不得超过当前时间前30天, 默认查询当前时间前三天的订单明细 |
2.7.4 返回参数(JSON)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
msg | String | 返回结果描述 | |
code | String | 返回状态码 | 200成功,其他均为失败 |
success | boolean | 是否成功 | true/false |
data | List | 返回数据 | 明细列表 |
返回数据明细(data)
参数名称 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
subBizCode | String | 子业务参考号 | |
taskAmount | BigDecimal | 任务金额 | |
receiptAccountNo | String | 收款账号 | |
receiptBankName | String | 收款银行地址 | |
receiptAccountName | Sring | 收款户名 | |
receiptAccountAddress | Sring | 收款账户地址 | |
receiptPhone | Sring | 收款方手机号 | |
receiptCardNo | Sring | 收款方身份证号 |
2.7.5 接口请求示例
请求
{
"pageNo": 1,
"orderCode":"WOD2020071700005",
"subBizCode":"WOD2021320071700005",
"minTaskAmount":0.01,
"maxTaskAmount":10,
"receiptAccountNo":"123456789",
"receiptAccountName":"张三",
"receiptCardNo":"330312192311211241",
"startDate":"2021-01-01 00:00:00",
"endDate":"2021-01-02 00:00:00"
}
返回结果
{
"msg": "",
"code": "200",
"success": true,
"data": [{
"subBizCode": "WOD2020071700005",
"taskAmount": 100,
"receiptAccountNo": "123456789",
"receiptBankName": "招商银行",
"receiptAccountName": "张三",
"receiptAccountAddress": "招商银行上海支行",
"receiptPhone": "18888668866",
"receiptCardNo": "330312192311211241"
}]
}
2.7.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
2.8 订单回调通知
2.8.1 简要描述
订单到达完成状态(部分成功、全部成功、失败)时,发送http通知
2.8.2 请求URL
- 根据商户配置请求地址
2.8.3 请求参数(POST)
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
bizCode | String | Y | 业务参考号 | |
orderCode | String | Y | 订单编号 | |
orderStatus | Integer | Y | 订单状态 | 1新建, 2取消, 3部分成功, 4全部成功, 5失败,6未知, 21已冻结, 22已锁定, 23结算中, 24处理中 |
2.8.4 返回参数(JSON)
true
2.8.5 接口请求示例
请求
{
"orderCode":"WOD2020071700005",
"bizCode":"WOD2021320071700005",
"orderStatus":"4"
}
返回结果
true
2.8.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
2.9 订单明细状态更新回调通知
2.9.1 简要描述
订单明细到达最终状态(成功、失败)时,发送http通知
2.9.2 请求URL
- 根据商户配置请求地址
2.9.3 请求参数(POST)
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
subBizCode | String | Y | 子业务参考号 | |
orderDetailCode | String | Y | 订单明细编号 | |
orderDetailStatus | Integer | Y | 订单状态 | 1新建, 2成功, 3失败 |
2.9.4 返回参数(JSON)
true
2.9.5 接口请求示例
请求
{
"subBizCode":"WOD2020071700005",
"orderDetailCode":"WOD2021320071700005",
"orderDetailStatus":"4"
}
返回结果
true
2.9.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码
2.10 退票订单明细回调通知
2.10.1 简要描述
订单明细退票后,发送http通知
2.10.2 请求URL
- 根据商户配置请求地址
2.10.3 请求参数(POST)
参数名称 | 参数类型 | 必填 | 参数说明 | 备注 |
---|---|---|---|---|
subBizCode | String | 子业务参考号 | ||
taskAmount | BigDecimal | 任务金额 | ||
receiptAccountNo | String | 收款账号 | ||
receiptBankName | String | 收款银行地址 | ||
receiptAccountName | Sring | 收款户名 | ||
receiptAccountAddress | Sring | 收款账户地址 | ||
receiptPhone | Sring | 收款方手机号 | ||
receiptCardNo | Sring | 收款方身份证号 |
2.10.4 返回参数(JSON)
true
2.10.5 接口请求示例
请求
-- 仅为数据结构示例
{
"msg": "请求成功",
"code": "200",
"data": {
"pageCount": 1,
"needPage": true,
"pageNo": 1,
"entityList": [
{
"receiptAccountAddress": "招商银行上海支行",
"receiptAccountName": "梁雪标",
"subBizCode": "94a5ef2gq52hhgcbq5e31atq6yehee1e",
"receiptPhone": "18516001029",
"taskAmount": 1000.0,
"receiptCardNo": "342201199111158539",
"receiptAccountNo": "6214852130472882",
"receiptBankName": "招商银行"
},
{
"receiptAccountAddress": "招商银行上海支行",
"receiptAccountName": "梁雪标",
"subBizCode": "7669fgsseqfc4ccc5aswt47abqbgwqby",
"receiptPhone": "18516001029",
"taskAmount": 1000.0,
"receiptCardNo": "342201199111158539",
"receiptAccountNo": "6214852130472882",
"receiptBankName": "招商银行"
}
],
"pageSize": 200,
"totalCount": 2,
"firstEntityIndex": 0
},
"requestId": "5bf78c794666293d",
"success": true
}
返回结果
true
2.10.6 备注
更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码