支付退回
业务说明：
- 调用方通过调用该接口将 已支付成功 的支付单退回。
- 此接口仅修改支付单状态为“支付失败”，对单据状态不做变更。
接口地址
/api/openapi/paymenttransaction/refund
接口类型
POST
请求参数说明
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| data | object[] | Y | 目前仅限1条，超过报错 |
参数说明
| 参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| paymentNo | string | Y | 支付流水号 | |
| number | string | N | 退回流水号，限制100字符 | |
| reason | string | Y | 退回原因，限制1000字符 | |
| employeeId | string | N | 操作退回的员工工号，需要有退回权限。 1、传了参数，但是找不到员工或者员工没有退回权限则会报错； 2、如果没有传这个参数则会随机从全部具有退回权限的员工中取一个。 |
|
| assignPayEmployeeIds | list |
Y | 退回后指定的操作人工号，需要有支付权限。最多50个。 | |
| refundTime | long | Y | 银行退回的时间，到毫秒的13位时间戳。 |
参数示例
{
"data": [
{
"paymentNo": "FPO0000000000000",
"number": "12345678999",
"reason": "测试OPENAPI退回",
"employeeId": "Y001",
"assignPayEmployeeIds": [
"Y001",
"M002",
"QQQ000"
],
"refundTime": 1657608932000
}
]
}
请求响应
正常处理时返回
{
"code":"ACK"
}
存在错误支付结果时返回
{
"code": "BUSINESS_ERROR",
"data": [
{
"no": "1",
"message": "缺少失败信息"
}
]
}
已退回时再次退回返回参数
{
"code": "ACK",
"message": null,
"data": [
{
"no": "FPO2101041K4S5K00",
"message": "该支付单目前已经是支付退回状态，无需退回。"
}
],
"errorCode": null,
"success": true
}
参数说明
| 名称 | 类型 | 是否必须 | 备注 | 其他信息 |
|---|---|---|---|---|
| code | string | Y | 返回ACK、NACK、BUSINESS_ERROR | ACK表示接口正常.NACK表示接口异常，BUSINESS_ERROR表示支付结果参数错误, 只会返回错误的数据, 其他会被正确处理, 只要重试返回数据.异常详细信息见data参数 |
| message | string | N | ||
| data | object[] | N | 数据错误提示信息. 对象类型见errorMsg |
errorMsg参数说明
| 名称 | 类型 | 是否必须 | 备注 | 其他信息 |
|---|---|---|---|---|
| no | string | Y | 支付流水, 对应更新支付结构接口中的参数 | |
| message | string | Y | 支付流水对应记录的错误信息 |