---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/en/notes/checkout/api/getRefund/index.md
description: >-
  getRefund The interface is used to query the status of initiated refund
  requests. It is suitable for scenarios that need to confirm whether the refund
  was successful. Please ensure the refund synchronous return is completed
  before calling to avoid query exceptions. Main functions include obtaining
  refund details through order number or refund number, with key parameters
  order_id and refund_id.
---
# Refund Query

```apidef
endpoint: POST /v4/refund/query
name: getRefund
summary: Query refund status
tags: Query, Refund
```

getRefund The interface is used to query the status of initiated refund requests. It is suitable for scenarios that need to confirm whether the refund was successful. Please ensure the refund synchronous return is completed before calling to avoid query exceptions. Main functions include obtaining refund details through order number or refund number, with key parameters order_id and refund_id.

## Request Parameters

| Parameter | Type | Required | Description |
|--------|------|------|------|
| accId | string | M | Unique identifier for the store, which will appear in the response message after creation; inputting it means modifying the data |
| clientId | string | M | PingPong Merchant ID |
| signType | string | M | Supports MD5 , SHA256; for details, see the Signature Specification: /en/notes/guide/sign/ section of this document |
| sign | string | M | Signature; for details, see the Signature Specification: /en/notes/guide/sign/ section of this document. All parameters participate in the signature |
| version | string | M | Version number, currently fixed at 1.0, may be adjusted with changes to the interface in the future |
| bizContent | string | M | Collection of request parameters, with no limit on maximum length. Except for common request parameters, all other request parameters must be passed within this parameter, format: JSON string |
| └─ refundId | string | C | PingPong refund transaction number, at least one of which must be provided along with merchantRefundId |
| └─ merchantRefundId | string | C | Merchant website refund transaction number, at least one of which must be provided along with refundId |
| └─ merchantTransactionId | string | M | Original transaction number from the merchant's website |

### Request Example

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

## Response Parameters

| Parameter | Type | Description |
|--------|------|------|
| accId | string | Unique store identifier, which will appear in the response message after being added; inputting it means modifying the data |
| clientId | string | PingPong merchant number |
| signType | string | Supports MD5 , SHA256; for details, see the Signature Specification: /en/notes/guide/sign/ section of this document |
| sign | string | Signature; for details, see the Signature Specification: /en/notes/guide/sign/ section of this document. All parameters participate in the signature |
| code | string | Result status code, see the appendix Status Code Table: /en/notes/appendix/successCodeList/ |
| description | string | Result description |
| bizContent | string | Business response parameters |
| └─ transactionId | string | PingPong transaction number |
| └─ merchantTransactionId | string | Website transaction number |
| └─ currency | string | Transaction currency, ISO 4217 three-letter code, specific supported currencies see attachment Transaction Currencies: /en/notes/appendix/transactionCurrency/ |
| └─ amount | string | Amount |
| └─ refundTime | string | Refund initiation time, timestamp |
| └─ resultCode | string | Status result code |
| └─ resultDescription | string | Status result description |
| └─ refundEndingTime | string | Time when refund reaches final state, timestamp |
| └─ status | string | Transaction status: Idempotent Status: /en/notes/guide/paystatus/ SUCCESS- Success; FAILED- Failure; PROCESSING- Processing; |
| └─ remark | string | Merchant extended field |

### Response Example

```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"
}
```