---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/en/notes/api/services/InPersonPayments/refund/index.md
description: >-
  The Request Refund API is used to process refund requests for paid orders in
  PingPongCheckout. It applies to scenarios requiring refund services for
  customers and supports multiple currencies across major global markets.
  Through this interface, developers can specify key parameters such as refund
  amount and reason to achieve fast and secure fund returns.
---
# Request Refund

```apidef
endpoint: POST /onsiteAcquirer/payment/refund
name: Request Refund
```

The Request Refund API is used to process refund requests for paid orders in PingPongCheckout. It applies to scenarios requiring refund services for customers and supports multiple currencies across major global markets. Through this interface, developers can specify key parameters such as refund amount and reason to achieve fast and secure fund returns.

## 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 |
| └─ deviceSn | string | O | Device serial number, used to specify the target POS machine for payment. Required for POS refund |
| └─ deviceModel | string | O | Device model, used to specify the target POS machine for payment. Required for POS refund |
| └─ merchantTransactionId | string | M | Original merchant order serial number, unique identifier of the order, can be used for subsequent order queries and reconciliation |
| └─ merchantRefundId | string | M | Merchant refund order serial number, unique identifier of the order |
| └─ amount | string | M | Refund amount, the precision digits are related to the currency, please check the appendix Transaction Currency: /en/notes/appendix/transactionCurrency/ |
| └─ currency | string | M | Refund currency, ISO 4217 three-letter currency code, see appendix Transaction Currency: /en/notes/appendix/transactionCurrency/ for specific supported currencies |
| └─ cashierDeviceId | string | M | Unique ID of the cashier device serial number |

### Request Example

```json
{
  "accId": "2018092520455210043243",
  "bizContent": "{\"requestTime\":\"1748597280752\",\"merchantTransactionId\":\"PMT-15ZSIRMPKT1748591387687\",\"merchantRefundId\":\"REF-15ZSIRMPKT1748591800000\",\"deviceSn\":\"NEC300067041\",\"deviceModel\":\"N950S\",\"amount\":\"121.23\",\"currency\":\"MYR\",\"cashierDeviceId\":\"111\"}",
  "clientId": "2018092520455210043",
  "sign": "6D214AE3A1926127C3240D4F7604130362B2007EB3D81C67C43CB7C9D9D97F4A",
  "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 |
| └─ transactionRefundId | string | PingPong refund serial number |
| └─ merchantRefundId | string | Transaction serial number on the merchant website |
| └─ status | string | Transaction status: ACCEPT_SUCCESS-Acceptance successful; FAILED-Failed; PROCESSING-In progress; |

### Response Example

```json
{
  "accId": "2018092520455210043243",
  "bizContent": "{\"merchantRefundId\":\"REF-15ZSIRMPKT1748591800000\",\"transactionRefundId\":\"OS202505300010000211\",\"status\":\"PROCESSING\"}",
  "clientId": "2018092520455210043",
  "code": "002000",
  "description": "Transaction processing"
}
```