支付
接口描述:
接口地址:/{context}/pay/business/
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"sn": "",
"timeout": 0,
"payload": {
"key": "value"
}
}
请求参数:
参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
sn | 订单号 | body | true | string | |
timeout | 请求超时时间,单位:秒,默认:130 | body | false | integer(int32) | |
payload | 负载的其它业务数据, JSON 格式 | body | false | object |
响应示例:
{
"currency": "CNY",
"amount": 0,
"refund": 0,
"canceled": 0,
"sn": "",
"originalSN": "",
"bankSN": "",
"callerSN": "",
"terminalSN": "",
"payType": "",
"notes": "",
"qrCord": "",
"payTime": "",
"expiryTime": "",
"createTime": "",
"batch": "",
"type": "",
"id": 0,
"remark": "",
"payload": "",
"state": "",
"respVo": {}
}
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
currency | 货币 | string | |
amount | 金额,单位:元 | number | |
refund | 退费金额,单位:元 | number | |
canceled | 撤单金额,单位:元 | number | |
sn | 流水号 | string | |
originalSN | 原单流水号,退费时记录原支付流水号 | string | |
bankSN | 支付渠道流水号,如:各个银行流水号或业务主键 | string | |
callerSN | 调用方流水号,如:HIS 流水号 | string | |
terminalSN | 终端流水号,如:POS 机流水号/凭证号(建行 OCX 返回) | string | |
payType | 支付方式,参见:约定字典 | string | |
notes | 交易标题、描述或说明 | string | |
qrCord | 支付码 | string | |
payTime | 支付时间 | string(date-time) | string(date-time) |
expiryTime | 失效时间 | string(date-time) | string(date-time) |
createTime | 创建时间 | string(date-time) | string(date-time) |
batch | 批次/账期 | string | |
type | 订单类型,0:支付;1:退费;2:撤单 | string | |
id | 标识,修改时必须 | integer(int32) | integer(int32) |
remark | 备注/描述 | string | |
payload | 负载的其它业务数据, JSON 格式 | string | |
state | 支付状态,1: 初始化、2:交易中、3:成功、4:失败 |
string | |
respVo | 响应参数对象 | object |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |