---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/notes/zh/checkout/api/getRefund/index.md
description: >-
  getRefund
  接口用于查询已发起的退款请求状态。适用于需要确认退款是否成功的场景。调用前请确保退款同步返回完成，以避免查询异常。主要功能包括通过订单号或退款单号获取退款详情，关键参数有order_id和refund_id。
---
# 退款查询

```apidef
endpoint: POST /v4/refund/query
name: 退款查询
summary: 查询退款结果
tags: Query, Refund
```

getRefund 接口用于查询已发起的退款请求状态。适用于需要确认退款是否成功的场景。调用前请确保退款同步返回完成，以避免查询异常。主要功能包括通过订单号或退款单号获取退款详情，关键参数有order_id和refund_id。

## 请求参数

| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| accId | string | M | 店铺唯一标识 |
| clientId | string | M | PingPong 商户号 |
| signType | string | M | 支持 MD5 、 SHA256 ，具体⻅本文签名规约: /notes/zh/onlinePayment/developer/sign/一栏 |
| sign | string | M | 签名，具体⻅本文签名规约: /notes/zh/onlinePayment/developer/sign/，所有参数均参与签名 |
| version | string | M | 版本号，当前固定为1.0，后续随接口变动可能有调整 |
| bizContent | string | M | 请求参数的集合，最大长度不限，除公共请求参数外所有请求参数都必须放在这个参数中传递，格式：JSON字符串。该字段内容为 JSON 字符串，反序列化后的结构见 contentSchema。 |
| └─ refundId | string | C | PingPong 退款流水号，与 merchantRefundId 至少上送一项 |
| └─ merchantRefundId | string | C | 商户网站退款流水号，与 refundId 至少 上送一项 |
| └─ merchantTransactionId | string | M | 商户网站的原交易流水号 |

### 请求示例

```json
{
  "accId": "2018092714313010016291",
  "clientId": "2018092714313010016",
  "signType": "SHA256",
  "sign": "898A3CBE981B3E2BF4E2B8D1A817D7E23EF93BC4293993EE545E36F4C87F2E79",
  "version": "1.0",
  "bizContent": "{\"merchantRefundId\":\"2023070750000647\",\"merchantTransactionId\":\"202307075000324\"}"
}
```

## 响应参数

| 参数名 | 类型 | 说明 |
|--------|------|------|
| accId | string | 店铺唯一标识 |
| clientId | string | PingPong 商户号 |
| signType | string | 支持 MD5 、 SHA256 ，具体⻅本文签名规约: /notes/zh/onlinePayment/developer/sign/一栏 |
| sign | string | 签名，具体⻅本文签名规约: /notes/zh/onlinePayment/developer/sign/，所有参数均参与签名 |
| code | string | 结果状态码，见附录状态码表: /notes/zh/appendix/successCodeList/ |
| description | string | 结果描述 |
| bizContent | string | 业务响应参数。该字段内容为 JSON 字符串，反序列化后的结构见 contentSchema。 |
| └─ transactionId | string | PingPong 交易流水号 |
| └─ merchantTransactionId | string | 网站交易流水号 |
| └─ currency | string | 交易币种，ISO 4217 三位币种，具体支持币种⻅附件交易币种: /notes/zh/appendix/transactionCurrency/ |
| └─ amount | string | 金额 |
| └─ refundTime | string | 退款发起时间，时间戳 |
| └─ resultCode | string | 状态结果码 |
| └─ resultDescription | string | 状态结果描述 |
| └─ refundEndingTime | string | 退款到达终态时间，时间戳 |
| └─ status | string | 交易状态：状态幂等: /notes/zh/guide/paystatus/ SUCCESS-成功; FAILED-失败; PROCESSING-处理中; |
| └─ remark | string | 商户扩展字段 |

### 响应示例

```json
{
  "accId": "2023060217493010231446",
  "bizContent": "{\"amount\":\"200.000000\",\"cardInfo\":{\"firstName\":\"zhang\",\"lastName\":\"san\",\"lastFourDigits\":\"8Q==\",\"ipCountry\":\"CN\",\"firstSixDigits\":\"AQICAH\"},\"threeDSecure\":\"\",\"resultCode\":\"000000\",\"transactionTime\":\"1687334372000\",\"transactionId\":\"2023062150000329\",\"merchantTransactionId\":\"PMT-1OL5AJOJA91687334040656\",\"currency\":\"USD\",\"resultDescription\":\"Transaction succeeded\",\"captureDelayHours\":0,\"status\":\"SUCCESS\"}",
  "clientId": "2023060217493010231",
  "code": "001000",
  "description": "Successful request",
  "sign": "D7F4C867DDB7F3BDC56F598B5467F2D4792E6FCE459EA119BA3FF2FCEF97DB79",
  "signType": "SHA256"
}
```