查询

获取指定订单

接口描述:

接口地址:/{context}/bill/{SN}

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
SN	订单号/调用方流水号/支付渠道流水号	path	true	string

响应示例:

{
  "amount": 0,
  "bankSN": "",
  "batch": "",
  "callerSN": "",
  "canceled": 0,
  "createTime": "",
  "currency": "",
  "expiryTime": "",
  "id": 0,
  "notes": "",
  "organId": 0,
  "originalSN": "",
  "payTime": "",
  "payType": "",
  "payload": {
    "key": "value"
  },
  "qrCord": "",
  "refund": 0,
  "remark": "",
  "sn": "",
  "terminalSN": "",
  "type": "",
  "overdue": 0,
  "userId": 0
}

响应参数:

参数名称	参数说明	类型	schema
amount	金额，单位：元	number
bankSN	支付渠道流水号，如：各个银行流水号或业务主键	string
batch	批次/账期	string
callerSN	调用方流水号，如：HIS 流水号	string
canceled	撤单金额，单位：元	number
createTime	创建时间	string(date-time)	string(date-time)
currency	货币	string
expiryTime	失效时间	string(date-time)	string(date-time)
id	标识，修改时必须	integer(int32)	integer(int32)
notes	交易标题、描述或说明	string
organId	所属机构标识	integer(int32)	integer(int32)
organName	所属机构名称	string
originalSN	原单流水号，退费时记录原支付流水号	string
payTime	支付时间	string(date-time)	string(date-time)
payType	支付方式，参见：约定字典	string
payload	负载的其它业务数据, JSON 格式	object
qrCord	支付码	string
refund	退费金额，单位：元	number
remark	备注/描述	string
sn		string
state	状态	integer(int32)	integer(int32)
overdue	是否超期，超期指超过该笔订单最长可退款时间，1：是，0否，默认为0	integer(int32)	integer(int32)
terminalSN	终端流水号，如：POS 机流水号/凭证号（建行 OCX 返回）	string
type	订单类型，0：支付；1：退费；2：撤单；3：转账,可用值:支付单,退费单,撤销单,转账单	string
userId	创建人标识，关联账号标识	integer(int32)	integer(int32)
userName	创建人名称	string

响应状态:

状态码	说明	schema
200	OK	支付单
401	Unauthorized
403	Forbidden
404	Not Found

根据第三方流水号查询订单

接口描述:

接口地址:/{context}/bill/callersn/{callerSN}

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
callerSN	调用方流水号，如：HIS 流水号	path	true	string
billType	订单类型，枚举：支付单, 退费单, 撤销单, 转账单	query	true	string

响应示例:

{
  "amount": 0,
  "bankSN": "",
  "batch": "",
  "callerSN": "",
  "canceled": 0,
  "createTime": "",
  "currency": "",
  "expiryTime": "",
  "id": 0,
  "notes": "",
  "organId": 0,
  "originalSN": "",
  "payTime": "",
  "payType": "",
  "payload": {
    "key": "value"
  },
  "qrCord": "",
  "refund": 0,
  "remark": "",
  "sn": "",
  "terminalSN": "",
  "type": "",
  "overdue": 0,
  "userId": 0
}

响应参数:

参数名称	参数说明	类型	schema
amount	金额，单位：元	number
bankSN	支付渠道流水号，如：各个银行流水号或业务主键	string
batch	批次/账期	string
callerSN	调用方流水号，如：HIS 流水号	string
canceled	撤单金额，单位：元	number
createTime	创建时间	string(date-time)	string(date-time)
currency	货币	string
expiryTime	失效时间	string(date-time)	string(date-time)
id	标识，修改时必须	integer(int32)	integer(int32)
notes	交易标题、描述或说明	string
organId	所属机构标识	integer(int32)	integer(int32)
organName	所属机构名称	string
originalSN	原单流水号，退费时记录原支付流水号	string
payTime	支付时间	string(date-time)	string(date-time)
payType	支付方式，参见：约定字典	string
payload	负载的其它业务数据, JSON 格式	object
qrCord	支付码	string
refund	退费金额，单位：元	number
remark	备注/描述	string
sn		string
state	状态	integer(int32)	integer(int32)
overdue	是否超期，超期指超过该笔订单最长可退款时间，1：是，0否，默认为0	integer(int32)	integer(int32)
terminalSN	终端流水号，如：POS 机流水号/凭证号（建行 OCX 返回）	string
type	订单类型，0：支付；1：退费；2：撤单；3：转账,可用值:支付单,退费单,撤销单,转账单	string
userId	创建人标识，关联账号标识	integer(int32)	integer(int32)
userName	创建人名称	string

响应状态:

状态码	说明	schema
200	OK	支付单
401	Unauthorized
403	Forbidden
404	Not Found

分页获取订单

接口描述:

接口地址:/{context}/bill/

请求方式：GET

consumes:``

produces:["*/*"]

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
SN	订单号	query	false	string
callerSN	调用方流水号	query	false	string
eDate	结束时间格式：yyyy-MM-dd HH:mm:ss	query	false	string
orderTypes	订单类型，0：支付；1：退款；2：撤销；3：转账	query	false	array	integer
page	第几页	query	false	integer
payType	支付类型	query	false	string
rows	每页几条记录	query	false	integer
sDate	开始时间格式：yyyy-MM-dd HH:mm:ss	query	false	string
states	状态集，1：初始化；2：交易中；3：成功；4：失败	query	false	array	integer

响应示例:

{
  "firstPage": true,
  "lastPage": true,
  "list": [
    {
      "amount": 0,
      "bankSN": "",
      "batch": "",
      "callerSN": "",
      "canceled": 0,
      "createTime": "",
      "currency": "",
      "expiryTime": "",
      "id": 0,
      "notes": "",
      "organId": 0,
      "originalSN": "",
      "payTime": "",
      "payType": "",
      "payload": {
        "key": "value"
      },
      "qrCord": "",
      "refund": 0,
      "remark": "",
      "sn": "",
      "terminalSN": "",
      "type": "",
      "overdue": 0,
      "userId": 0
    }
  ],
  "pageNumber": 0,
  "pageSize": 0,
  "totalPage": 0,
  "totalRow": 0
}

响应参数:

参数名称	参数说明	类型	schema
firstPage	是否第一页	boolean
lastPage	是否最后一页	boolean
list	数据集	array	支付单
pageNumber	当前页码	integer(int32)	integer(int32)
pageSize	每页记录数	integer(int32)	integer(int32)
totalPage	总页数	integer(int32)	integer(int32)
totalRow	总记录数	integer(int32)	integer(int32)

schema 属性说明

订单

参数名称	参数说明	类型	schema
amount	金额，单位：元	number
bankSN	支付渠道流水号，如：各个银行流水号或业务主键	string
batch	批次/账期	string
callerSN	调用方流水号，如：HIS 流水号	string
canceled	撤单金额，单位：元	number
createTime	创建时间	string(date-time)
currency	货币	string
expiryTime	失效时间	string(date-time)
id	标识，修改时必须	integer(int32)
notes	交易标题、描述或说明	string
organId	所属机构标识	integer(int32)
organName	所属机构名称	string
originalSN	原单流水号，退费时记录原支付流水号	string
payTime	支付时间	string(date-time)
payType	支付方式，参见：约定字典	string
payload	负载的其它业务数据, JSON 格式	object
qrCord	支付码	string
refund	退费金额，单位：元	number
remark	备注/描述	string
sn		string
state	状态	integer(int32)
overdue	是否超期，超期指超过该笔订单最长可退款时间，1：是，0否，默认为0	integer(int32)	integer(int32)
terminalSN	终端流水号，如：POS 机流水号/凭证号（建行 OCX 返回）	string
type	订单类型，0：支付；1：退费；2：撤单；3：转账,可用值:支付单,退费单,撤销单,转账单	string
userId	创建人标识，关联账号标识	integer(int32)
userName	创建人名称	string

响应状态:

状态码	说明	schema
200	OK	分页«支付单»
401	Unauthorized
403	Forbidden
404	Not Found

查询

查询

获取指定订单

根据第三方流水号查询订单

分页获取订单

results matching ""

No results matching ""