主题
退款
接口描述
供医院HIS系统进行调用，针对已完成的订单进行退款。
请求URL
/his/order/refund
请求方式
- POST
公共请求参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| appId | 是 | string | 应用ID | 202415629590370906 | |
| signature | 是 | string | 签名 | ||
| transNonce | 是 | string | 32 | 请求流水号 | 43e2c287-24b1-4cd1-b3d2-e40e7840cc40 |
| transDate | 是 | string | 13 | 请求时间，13位时间戳 | 1731406784607 |
请求参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| outTradeNo | 是 | string | 32 | 商户侧退款交易号 | REFUND_001 |
| refundAmount | 是 | string | 20 | 退款金额，单位分，不能超过订单总金额 | 10000 |
| notifyUrl | 否 | string | 255 | 异步通知URL | https://example.com/refund/notify |
| origTradeNo | 是 | string | 32 | 原交易订单号，需要退款的那笔交易单号 | XS20260423000001 |
| payerIp | 是 | string | 32 | 请求方IP地址 | 192.168.1.1 |
| longitude | 否 | string | 经度 | 116.407425 | |
| latitude | 否 | string | 纬度 | 39.90425 |
请求报文示例
json
{
"appId": "202415629590370906",
"signature": "pz+Z8unqO2VBjTGtzWASCCfzix5QxODSkAdKKyPiVXIXLtp574xCmuWaOeHfslnbUK2RKsYdNy/OhcMPV+GMaoXxcXuDvmVhUdKHWgYODovK5GbbqfqaT+nrzO0xnNz8rLCnevTQ3y4+Qn6++xVlwyMOW3SDw9gRM5qF40TlectpvylieoFROXzYIHXBveRrcT3FQSwnoNamNet/k7OTvotiT0Fft6SGDflqkWeHhiP83265OSMvQPwtIcEStyTv4AHLsWC5pSd7zTQ+pkvetMlm0AAwO6Jl4xUYx+OZkBM8vpgxqAQa4yzV9mTwfsaFZsKRnTXTJdFVHr9xONro5g==",
"transDate": "1731469621597",
"transNonce": "43e2c287-24b1-4cd1-b3d2-e40e7840cc40",
"outTradeNo": "REFUND_001",
"refundAmount": "10000",
"notifyUrl": "https://example.com/refund/notify",
"origTradeNo": "XS20260423000001",
"payerIp": "192.168.1.1",
"longitude": "116.407425",
"latitude": "39.90425"
}公共响应参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| code | 是 | string | 响应编码：000000000-成功，非000000000-失败，具体原因取message | 00000000 | |
| message | 是 | string | 响应信息 | 成功 | |
| signature | 是 | string | 签名 | ||
| transNonce | 是 | string | 32 | 请求流水号(同入参) | 43e2c287-24b1-4cd1-b3d2-e40e7840cc40 |
| transDate | 是 | string | 13 | 响应时间，13位时间戳 | 1731406784607 |
响应参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| outTradeNo | 是 | string | 32 | 退款订单号，同入参的outTradeNo | REFUND_001 |
| refundAmount | 是 | string | 20 | 退款金额 | 10000 |
响应示例
json
{
"code": "00000000",
"message": "成功",
"signature": "pz+Z8unqO2VBjTGtzWASCCfzix5QxODSkAdKKyPiVXIXLtp574xCmuWaOeHfslnbUK2RKsYdNy/OhcMPV+GMaoXxcXuDvmVhUdKHWgYODovK5GbbqfqaT+nrzO0xnNz8rLCnevTQ3y4+Qn6++xVlwyMOW3SDw9gRM5qF40TlectpvylieoFROXzYIHXBveRrcT3FQSwnoNamNet/k7OTvotiT0Fft6SGDflqkWeHhiP83265OSMvQPwtIcEStyTv4AHLsWC5pSd7zTQ+pkvetMlm0AAwO6Jl4xUYx+OZkBM8vpgxqAQa4yzV9mTwfsaFZsKRnTXTJdFVHr9xONro5g==",
"transDate": "1731469621597",
"transNonce": "43e2c287-24b1-4cd1-b3d2-e40e7840cc40",
"outTradeNo": "REFUND_001",
"refundAmount": "10000"
}备注
- 更多返回错误代码请看 通用规则说明-错误码 的错误代码描述