Skip to main content
Version: 3.0 版本

2.0-支付接口

2.1 支付申请

2.1.1 简要描述

申请支付,待发放的人员,通过必要流程验证,系统生成支付结算批次订单并发放.

2.1.2 请求URL
  • /regulator/openapi/v2/task/payment
请求方式
  • POST
返回类型
  • JSON

2.1.3 请求参数

参数名称参数类型必填参数说明备注
payAccountNoStringY支付账号为接口(1.2-账户余额查询)返回数据中的defaultAccount=true 对应记录的subAccountNo字段
bizCodeString(32)Y业务参考号接入方系统中的结算单编码
orderDetailListList(1000)Y订单明细如下

订单明细详情

参数名称参数类型必填参数说明备注
subBizCodeString(32)Y子业务参考号接入方系统中的结算单明细编码
receiptAccountNoStringY收款人账户号支持国内大部分银行,部分银行及第三方支付账号存在较高支付失败几率,不建议使用以下银行卡作为收款账户:中国农业银行、农商银行、中国邮政储蓄银行、农村信用社、微信、支付宝。
receiptBankNameStringN收款银行名称
receiptAccountNameStringY收款人开户名
receiptAccountAddressStringN收款人开户地址
receiptPhoneStringY收款手机号
receiptCardNoStringY收款人身份证号
taskAmountBigDecimalY交易金额(元)单位:元,保留两位小小数截位

2.1.4 返回参数(JSON)

参数名称参数类型参数说明备注
msgString返回结果描述
codeString返回状态码200成功,其他均为失败
successboolean是否成功true/false
dataString(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 请求参数

参数名称参数类型必填参数说明备注
orderCodeStringY订单号

2.2.4 返回参数(JSON)

参数名称参数类型参数说明备注
msgString返回结果描述
codeString返回状态码200成功,其他均为失败
successboolean是否成功true/false
dataString返回数据详情见下表

返回数据明细(data)

参数名称参数类型参数说明备注
bizCodeString业务参考号
payAccountNoString支付账户
orderCodeString订单编号
orderStatusInteger订单状态1新建, 2取消, 3部分成功, 4全部成功, 5失败,6未知, 21已冻结, 22已锁定, 23结算中, 24处理中
failReasonSring失败原因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 请求参数

参数名称参数类型必填参数说明备注
bizCodeStringY业务参考号

2.3.4 返回参数(JSON)

参数名称参数类型参数说明备注
msgString返回结果描述
codeString返回状态码200成功,其他均为失败
successboolean是否成功true/false
dataString返回数据详情见下表

返回数据明细(data)

参数名称参数类型参数说明备注
bizCodeString业务参考号
payAccountNoString支付账户
orderCodeString订单编号
orderStatusInteger订单状态1新建, 2取消, 3部分成功, 4全部成功, 5失败,6未知, 21已冻结, 22已锁定, 23结算中, 24处理中
failReasonSring失败原因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 请求参数

参数名称参数类型必填参数说明备注
orderCodeStringY订单编号

2.4.4 返回参数(JSON)

参数名称参数类型参数说明备注
msgString返回结果描述
codeString返回状态码200成功,其他均为失败
successboolean是否成功true/false
dataList返回数据明细如下

返回数据明细(data)

参数名称参数类型参数说明备注
payAccountNoString支付账号
subBizCodeString子业务参考号
taskAmountBigDecimal任务金额
settlementAmountBigDecimal结算金额
serviceAmountBigDecimal服务费金额
taxAmountBigDecimal税金
receiptAccountNoString收款账号
receiptBankNameString收款银行地址
receiptAccountNameSring收款户名
receiptAccountAddressSring收款账户地址
receiptPhoneSring收款方手机号
receiptCardNoSring收款方身份证号
orderDetailStatusInteger子订单状态1新建2成功3失败
failReasonSring失败原因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 请求参数

参数名称参数类型必填参数说明备注
bizCodeStringY业务参考号

2.5.4 返回参数(JSON)

参数名称参数类型参数说明备注
msgString返回结果描述
codeString返回状态码200成功,其他均为失败
successboolean是否成功true/false
dataList返回数据明细如下

返回数据明细(data)

参数名称参数类型参数说明备注
payAccountNoString支付账号
subBizCodeString子业务参考号
taskAmountBigDecimal任务金额
settlementAmountBigDecimal结算金额
serviceAmountBigDecimal服务费金额
taxAmountBigDecimal税金
receiptAccountNoString收款账号
receiptBankNameString收款银行地址
receiptAccountNameSring收款户名
receiptAccountAddressSring收款账户地址
receiptPhoneSring收款方手机号
receiptCardNoSring收款方身份证号
orderDetailStatusInteger子订单状态1新建2成功3失败
failReasonSring失败原因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 请求参数

参数名称参数类型必填参数说明备注
subBizCodeStringY明细订单业务编号

2.6.4 返回参数(JSON)

参数名称参数类型参数说明备注
msgString返回结果描述
codeString返回状态码200成功,其他均为失败
successboolean是否成功true/false
dataObject返回数据明细如下

返回数据明细(data)

参数名称参数类型参数说明备注
payAccountNoString支付账号
subBizCodeString子业务参考号
taskAmountBigDecimal任务金额
settlementAmountBigDecimal结算金额
serviceAmountBigDecimal服务费金额
taxAmountBigDecimal税金
receiptAccountNoString收款账号
receiptBankNameString收款银行地址
receiptAccountNameSring收款户名
receiptAccountAddressSring收款账户地址
receiptPhoneSring收款方手机号
receiptCardNoSring收款方身份证号
orderDetailStatusInteger子订单状态1新建2成功3失败
failReasonSring失败原因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)

参数名称参数类型必填参数说明备注
pageNoIntegerY页号分页大大小为200
orderCodeStringN订单编号
subBizCodeStringN子业务参考号
minTaskAmountBigDecimalN最小金额
maxTaskAmountBigDecimalN最大金额
receiptAccountNoStringN收款账户不支持模糊查询
receiptAccountNameStringN收款户名不支持模糊查询
receiptCardNoStringN收款身份证号不支持模糊查询
startDateDateN开始时间yyyy-MM-dd HH:mm:ss
开始时间不得超过当前时间前30天,
默认查询当前时间前三天的订单明细
endDateDateN结束时间yyyy-MM-dd HH:mm:ss
结束时间不得超过当前时间前30天,
默认查询当前时间前三天的订单明细

2.7.4 返回参数(JSON)

参数名称参数类型参数说明备注
msgString返回结果描述
codeString返回状态码200成功,其他均为失败
successboolean是否成功true/false
dataList返回数据明细列表

返回数据明细(data)

参数名称参数类型参数说明备注
subBizCodeString子业务参考号
taskAmountBigDecimal任务金额
receiptAccountNoString收款账号
receiptBankNameString收款银行地址
receiptAccountNameSring收款户名
receiptAccountAddressSring收款账户地址
receiptPhoneSring收款方手机号
receiptCardNoSring收款方身份证号

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)

参数名称参数类型必填参数说明备注
bizCodeStringY业务参考号
orderCodeStringY订单编号
orderStatusIntegerY订单状态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)

参数名称参数类型必填参数说明备注
subBizCodeStringY子业务参考号
orderDetailCodeStringY订单明细编号
orderDetailStatusIntegerY订单状态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)

参数名称参数类型必填参数说明备注
subBizCodeString子业务参考号
taskAmountBigDecimal任务金额
receiptAccountNoString收款账号
receiptBankNameString收款银行地址
receiptAccountNameSring收款户名
receiptAccountAddressSring收款账户地址
receiptPhoneSring收款方手机号
receiptCardNoSring收款方身份证号

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-响应状态码