---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/en/notes/api/services/InPersonPayments/refundQuery/index.md
description: >-
  The refund query API allows merchants to retrieve the status and details of a
  specific refund request. Suitable for scenarios requiring tracking or
  verification of refund processing, supporting multiple global markets. By
  providing the refund ID as a key parameter, real-time information such as
  refund status, amount, and processing time can be obtained.
---
# Refund Query

```apidef
endpoint: POST /onsiteAcquirer/refund/query
name: Refund Query
```

The refund query API allows merchants to retrieve the status and details of a specific refund request. Suitable for scenarios requiring tracking or verification of refund processing, supporting multiple global markets. By providing the refund ID as a key parameter, real-time information such as refund status, amount, and processing time can be obtained.

## 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 |
| └─ requestTime | string | M | Merchant-side request time. Timestamp, in milliseconds |
| └─ refundId | string | M | PingPong refund serial number, at least one of refundId and merchantRefundId must be sent |
| └─ merchantRefundId | string | M | Merchant website refund serial number, at least one of refundId and merchantRefundId must be sent |
| └─ merchantTransactionId | string | M | Original merchant website transaction serial number |

### Request Example

```json
{
  "accId": "2018092520455210043243",
  "bizContent": "{\"requestTime\":\"1748599812954\",\"merchantRefundId\":\"RFD-G1DYGNCEQ61748599729106\",\"merchantTransactionId\":\"PMT-SNV279OONV1748599488191\"}",
  "clientId": "2018092520455210043",
  "sign": "BFEE0B5AABC7644CE2C80CF19C2A634DBCC6336590722755CA7890AFBB2C024B",
  "signType": "SHA256",
  "version": "1.0"
}
```

## 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 |
| └─ amount | string | Refund amount, the precision digits are related to the currency, please check the appendix Transaction Currency: /en/notes/appendix/transactionCurrency/ |
| └─ currency | string | Transaction currency, ISO 4217 three-letter currency code, see appendix Transaction Currency: /en/notes/appendix/transactionCurrency/ for specific supported currencies |
| └─ refundTime | string | Refund initiation time, timestamp |
| └─ status | string | Transaction status: Status Idempotency: /en/notes/guide/paystatus/ PROCESSING-In progress; SUCCESS-Success; FAILED-Failed; |
| └─ resultCode | string | Status result code |
| └─ resultDescription | string | Status result description |
| └─ refundEndingTime | string | Time when the refund reaches the final state, timestamp |
| └─ remark | string | Merchant extension field, can be used to specify specific parameters, will be returned as is in the response body |

### Response Example

```json
{
  "accId": "2018092520455210043243",
  "clientId": "2018092520455210043",
  "signType": "MD5",
  "sign": "b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a1",
  "code": "000000",
  "description": "Success",
  "bizContent": "{\"amount\":\"50.00\",\"currency\":\"EUR\",\"refundTime\":\"1748599729106\",\"status\":\"SUCCESS\",\"resultCode\":\"000000\",\"resultDescription\":\"Refund successful\",\"refundEndingTime\":\"1748599829106\",\"remark\":\"Partial refund\"}"
}
```