Version: 3.0 版本

1.0-交易相关

1.1 支付申请

1.1.1 简要描述

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

1.1.2 请求 URL

/regulator/openapi/v3/order/create

请求方式

POST

返回类型

JSON

1.1.3 请求参数

参数名称	参数类型	必填	参数说明	备注
payAccountNo	String	Y	支付账号	为接口(1.1-账户列表查询）返回数据中的 payAccountNo 字段
bizCode	String(32)	Y	业务参考号	接入方系统中的结算单编码
totalCount	Integer	Y	订单明细总数量
totalAmount	BigDecimal	Y	订单明细总金额
orderUsage	String	Y	用途	数据字典-0011-用途
remark	String	N	订单备注
orderDetails	List(1000)	Y	订单明细	如下

订单明细详情

参数名称	参数类型	必填	参数说明	备注
subBizCode	String(32)	Y	子业务参考号	接入方系统中的结算单明细编码
oppositeAccountType	Integer	Y	交易账户类型	默认为：1 银行卡
oppositeAccountName	String	Y	收款账户名
oppositeAccountNo	String	Y	收款人账户号	支持国内大部分银行，部分银行及第三方支付账号存在较高支付失败几率，不建议使用以下银行卡作为收款账户：中国农业银行、农商银行、中国邮政储蓄银行、农村信用社、微信、支付宝。
oppositeCardNo	String	Y	收款人身份证号
oppositePhone	String	Y	收款人手机号
oppositeBankName	String	N	收款账户银行名称
oppositeBankBranchNo	String	Y	收款账户银行支行号
tradeAmount	BigDecimal	Y	交易金额(元)	单位:元,保留两位小小数截位
remark	String	N	备注

1.1.4 返回参数(JSON)

参数名称	参数类型	参数说明	备注
msg	String	返回结果描述
code	String	返回状态码	200 成功，其他均为失败
success	boolean	是否成功	true/false
data	String(32)	返回数据	批次号

返回数据明细（data）

参数名称	参数类型	参数说明	备注
bizCode	String	业务参考号
orderCode	String	订单编号

1.1.5 接口请求示例

{
  "payAccountNo": "221010121120001001",
  "bizCode": "WOD2021121000001",
  "totalCount": "1",
  "totalAmount": "15",
  "orderUsage": "391|投资分红",
  "orderDetails": [
    {
      "subBizCode": "WTD2021121000001",
      "oppositeAccountType": "1",
      "oppositeAccountName": "茹虾凤",
      "oppositeAccountNo": "6214841215639289",
      "oppositeCardNo": "444877198307300059",
      "oppositePhone": "15116333110",
      "oppositeBankName": "招商银行",
      "oppositeBankBranchNo": "308290003239",
      "tradeAmount": "15",
      "remark": "工资代发"
    }
  ],
  "remark": "工资代发"
}

1.1.6 接口成功返回示例

{
  "requestId": "d72d037ae3f7fecf",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": {
    "orderCode": "ROM21122000000000000000000001",
    "bizCode": "WOD2021122000001"
  },
  "errorData": null
}

接口失败返回示例

{
  "requestId": "d147ef1015fe62c5",
  "msg": "订单用途不能为空",
  "code": "999",
  "success": false,
  "data": null,
  "errorData": null
}

1.1.7 备注

更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码

1.2 查询订单批次

1.2.1 简要描述

查询已申请的结算单订单批次信息

1.2.2 请求 URL

/regulator/openapi/v3/order/query

请求方式

返回类型

JSON

1.2.3 请求参数

参数名称	参数类型	必填	参数说明	备注
orderCode	String	N	订单号	（订单号/业务参考号二选一）
bizCode	String	N	业务参考号	（订单号/业务参考号二选一）

1.2.4 返回参数(JSON)

参数名称	参数类型	参数说明	备注
msg	String	返回结果描述
code	String	返回状态码	200 成功，其他均为失败
success	boolean	是否成功	true/false
data	String	返回数据	详情见下表

返回数据明细（data）

参数名称	参数类型	参数说明	备注
bizCode	String	业务参考号
payAccountNo	String	支付账户
orderCode	String	订单编号
settleTime	String	支付时间
orderStatus	Integer	订单状态	1 新建 2 校验中 3 校验完成 4 支付中 5 全部成功 6 部分成功 7 全部失败 8 校验失败 99 未知
failMsg	Sring	失败原因
totalSuccessCount	Integer	成功笔数
totalSuccessAmount	BigDecimal	成功总金额
totalFailCount	Integer	失败笔数
totalFailAmount	BigDecimal	失败总金额
totalCount	Integer	总笔数
totalAmount	BigDecimal	总金额
orderDetails	List	订单明细信息

订单明细（data）

参数名称	参数类型	参数说明	备注
subBizCode	String	子业务参考号
subOrderCode	String	子订单编号
subOrderStatus	Integer	子订单状态	1 新建 2 已校验 3 支付中 4 成功 5 失败 6 退票
failMsg	Sring	失败原因	DETAIL_VERIFY_ERROR(子订单校验不通过)； BALANCE_LACK(余额不足)
oppositeAccountType	Integer	对方交易账户类型	默认为：1 银行卡
oppositeAccountName	String	收款账户名
oppositeAccountNo	String	收款账号
oppositeCardNo	String	收款人身份证号
oppositePhone	String	收款人手机号
oppositeBankName	String	收款账户银行名称
oppositeBranchNo	String	收款账户银行支行号
tradeAmount	BigDecimal	交易金额
otherAmount	BigDecimal	其他金额
totalAmount	BigDecimal	总金额
remark	String	备注

1.2.5 接口返回示例

必填参数查询接口返回示例

{
  "requestId": "2c2d50b8d9e5192f",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": {
    "payAccountNo": null,
    "bizCode": "WOD2021121000014",
    "orderCode": "ROM21121000000000000000000012",
    "orderStatus": 5,
    "settleTime": "2021-12-10 17:57:02",
    "failMsg": null,
    "totalSuccessCount": 1,
    "totalSuccessAmount": 40,
    "totalFailCount": 0,
    "totalFailAmount": 0,
    "totalCount": 1,
    "totalAmount": 20,
    "orderUsage": "391|投资分红",
    "orderDetails": [
      {
        "subBizCode": "WTD2021121000014",
        "subOrderCode": "ROD21121000000000000000000012",
        "subOrderStatus": 4,
        "failedMsg": null,
        "oppositeAccountType": 1,
        "oppositeAccountName": "茹虾凤",
        "oppositeAccountNo": "6214831215689289",
        "oppositeCardNo": "444877198307300059",
        "oppositePhone": "15116333110",
        "oppositeBankName": "招商银行",
        "oppositeBankBranchNo": "308290003239",
        "tradeAmount": 20,
        "otherAmount": 1.2,
        "totalAmount": 40,
        "remark": "工资代发"
      }
    ],
    "remark": "工资代发"
  },
  "errorData": null
}

1.2.6 备注

1.3 查询退票流水

1.3.1 简要描述

查询退票流水信息

1.3.2 请求 URL

/regulator/openapi/v3/order/refund_query

请求方式

返回类型

JSON

1.3.3 请求参数

参数名称	参数类型	必填	参数说明	备注
orderCode	String	N	订单号
settleTimeStart	String	N	支付时间-开始	格式 : yyyy-MM-dd HH:mm:ss
settleTimeEnd	String	N	支付时间-结束	格式 : yyyy-MM-dd HH:mm:ss

1.3.4 返回参数(JSON)

参数名称	参数类型	参数说明	备注
msg	String	返回结果描述
code	String	返回状态码	200 成功，其他均为失败
success	boolean	是否成功	true/false
data	String	返回数据	详情见下表

订单明细（data）

参数名称	参数类型	参数说明	备注
orderCode	String	订单编号
subBizCode	String	子业务参考号
subOrderCode	String	子订单编号
subOrderStatus	Integer	子订单状态	6 退票
failMsg	Sring	失败原因
oppositeAccountType	Integer	对方交易账户类型	默认为：1 银行卡
oppositeAccountName	String	收款账户名
oppositeAccountNo	String	收款账号
oppositeCardNo	String	收款人身份证号
oppositePhone	String	收款人手机号
oppositeBankName	String	收款账户银行名称
oppositeBranchNo	String	收款账户银行支行号
tradeAmount	BigDecimal	交易金额
otherAmount	BigDecimal	其他金额
totalAmount	BigDecimal	总金额
remark	String	备注

1.3.5 接口返回示例

必填参数查询接口返回示例

{
  "requestId": "b0e22b0f73a6ee3e",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": {
    "pageNo": 1,
    "pageSize": 20,
    "pageCount": 1,
    "totalCount": 2,
    "entityList": [
      {
        "orderCode": "ROM22030100000000000000000003",
        "subBizCode": "WTD20220301000000003",
        "subOrderCode": "ROD22030100000000000000000003",
        "subOrderStatus": 6,
        "failMsg": "已退款",
        "oppositeAccountType": 1,
        "oppositeAccountName": "颜钲奇",
        "oppositeAccountNo": "6214830219956876",
        "oppositeCardNo": "320721198901180856",
        "oppositePhone": "18221965936",
        "oppositeBankName": "民生银行",
        "oppositeBankBranchNo": "308290003239",
        "tradeAmount": 0.01,
        "otherAmount": null,
        "totalAmount": null,
        "remark": "工资代发"
      },
      {
        "orderCode": "ROM22030100000000000000000002",
        "subBizCode": "WTD20220301000000002",
        "subOrderCode": "ROD22030100000000000000000002",
        "subOrderStatus": 6,
        "failMsg": "已退款",
        "oppositeAccountType": 1,
        "oppositeAccountName": "颜钲奇",
        "oppositeAccountNo": "6214830219956876",
        "oppositeCardNo": "320721198901180856",
        "oppositePhone": "18221965936",
        "oppositeBankName": "民生银行",
        "oppositeBankBranchNo": "308290003239",
        "tradeAmount": 0.01,
        "otherAmount": null,
        "totalAmount": null,
        "remark": "工资代发"
      }
    ],
    "firstEntityIndex": 0,
    "needPage": true
  },
  "errorData": null
}

1.3.6 备注

1.4 订单回调

1.4.1 简要描述

在订单,订单明细到达最终态时以及退票时发送http请求通知第三方。当回调方接收到回调并正确返回结果时，回调结束。如果未正确返回，则会重试3次。

1.4.2 请求 URL

根据商户配置请求地址

请求方式

POST

返回类型

JSON

1.4.3 请求参数

参数名称	参数类型	必填	参数说明	备注
appNo	String	Y	应用编号	系统为接入方分配的系统编号
callbackType	Integer	Y	通知类型	1 订单头完成通知 2 订单退票通知 4 订单明细完成通知
data	String	N	回调数据	现有的 1 2 4 类型会有回调数据,数据内容见示例

1.4.4 请求参数示例

订单完成通知请求参数示例

{
  "appNo":"002",
  "callbackType":1,
  "data":{
    "bizCode":"WOD20220301000004",
    "failMsg":null,
    "orderStatus":5,
    "orderCode":"ROM22030100000000000000000004"
  }
}

订单明细完成通知请求参数示例

{
  "appNo":"002",
  "callbackType":4,
  "data":{
    "bizCode":"WOD20220301000004",
    "subBizCode":"WTD20220301000000004",
    "subOrderCode":"ROD22030100000000000000000004",
    "subOrderStatus":4,
    "failMsg":null
  }
}

订单退票通知请求参数示例

{
  "appNo":"002",
  "callbackType":2,
  "data":{
    "bizCode":"WOD20220301000004",
    "subBizCode":"WTD20220301000000004",
    "subOrderCode":"ROD22030100000000000000000004",
    "subOrderStatus":6,
    "failMsg":"已退款"
  }
}

1.4.5 返回参数(JSON)

参数名称	参数类型	参数说明	备注
msg	String	返回结果描述	默认为空，无需填值
code	String	返回状态码	200 成功，其他均为失败
success	boolean	是否成功	true/false
data	String	返回数据	默认为空，无需填值

1.4.6 备注

1.5 回单下载

1.5.1 简要描述

订单完结后,次日可以通过此接口下载电子回单。

1.5.2 请求 URL

/regulator/openapi/v3/order/receipt

请求方式

返回类型

JSON

1.5.3 请求参数

参数名称	参数类型	必填	参数说明	备注
orderCode	String	Y	订单号	1.1交易后返回

1.5.4 返回参数(JSON)

参数名称	参数类型	参数说明	备注
msg	String	返回结果描述
code	String	返回状态码	200 成功，其他均为失败
success	boolean	是否成功	true/false
data	List	返回数据	详情见下表

返回数据明细（data）

参数名称	参数类型	参数说明
subOrderCode	String	子订单编号
downloadUrl	String	下载地址
downloadFileName	String	下载文件名

1.5.6 请求参数示例

{
  "requestId": "b0e22btf73a6el3e",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": [
      {
        "subOrderCode": "ROD22030200000000000000000003",
        "downloadUrl": "https://task.alitatest.cn/anon/file/download/149eb54403ba49a295ffb57259853de5",
        "downloadFileName": "pdf_A2022032922474222002352790026069.pdf"
      },
      {
        "subOrderCode": "ROD22030200000000000000000002",
        "downloadUrl": "https://task.alitatest.cn/anon/file/download/149eb54403ba49a295ffb57259853de5",
        "downloadFileName": "pdf_A20220329224748220023527900240139.pdf"
      }
    ],
  "errorData": null
}

1.5.7 备注

更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码

1.1 支付申请​

1.1.1 简要描述​

1.1.2 请求 URL​

请求方式​

返回类型​

1.1.3 请求参数​

1.1.4 返回参数(JSON)​

1.1.5 接口请求示例​

1.1.6 接口成功返回示例​

接口失败返回示例​

1.1.7 备注​

1.2 查询订单批次​

1.2.1 简要描述​

1.2.2 请求 URL​

请求方式​

返回类型​

1.2.3 请求参数​

1.2.4 返回参数(JSON)​

1.2.5 接口返回示例​

1.2.6 备注​

1.3 查询退票流水​

1.3.1 简要描述​

1.3.2 请求 URL​

请求方式​

返回类型​

1.3.3 请求参数​

1.3.4 返回参数(JSON)​

1.3.5 接口返回示例​

1.3.6 备注​

1.4 订单回调​

1.4.1 简要描述​

1.4.2 请求 URL​

请求方式​

返回类型​

1.4.3 请求参数​

1.4.4 请求参数示例​

1.4.5 返回参数(JSON)​

1.4.6 备注​

1.5 回单下载​

1.5.1 简要描述​

1.5.2 请求 URL​

请求方式​

返回类型​

1.5.3 请求参数​

1.5.4 返回参数(JSON)​

1.5.6 请求参数示例​

1.5.7 备注​

1.1 支付申请

1.1.1 简要描述

1.1.2 请求 URL

请求方式

返回类型

1.1.3 请求参数

1.1.4 返回参数(JSON)

1.1.5 接口请求示例

1.1.6 接口成功返回示例

接口失败返回示例

1.1.7 备注

1.2 查询订单批次

1.2.1 简要描述

1.2.2 请求 URL

请求方式

返回类型

1.2.3 请求参数

1.2.4 返回参数(JSON)

1.2.5 接口返回示例

1.2.6 备注

1.3 查询退票流水

1.3.1 简要描述

1.3.2 请求 URL

请求方式

返回类型

1.3.3 请求参数

1.3.4 返回参数(JSON)

1.3.5 接口返回示例

1.3.6 备注

1.4 订单回调

1.4.1 简要描述

1.4.2 请求 URL

请求方式

返回类型

1.4.3 请求参数

1.4.4 请求参数示例

1.4.5 返回参数(JSON)

1.4.6 备注

1.5 回单下载

1.5.1 简要描述

1.5.2 请求 URL

请求方式

返回类型

1.5.3 请求参数

1.5.4 返回参数(JSON)

1.5.6 请求参数示例

1.5.7 备注