---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/en/notes/checkout/api/modifications/void/index.md
description: >-
  The pre-authorization void API is used to cancel pre-authorization
  transactions that have been executed but not yet completed settlement. It
  applies to situations requiring immediate stoppage of pre-authorized charges,
  such as order cancellation or payment method changes. Key functions include
  canceling specified pre-authorizations and providing real-time void status
  feedback. Key parameters include the pre-authorization ID and merchant order
  number.
---
# void

```apidef
endpoint: POST /v4/payment/void
name: void
summary: Void an authorized payment
tags: Checkout, Modification
```

The pre-authorization void API is used to cancel pre-authorization transactions that have been executed but not yet completed settlement. It applies to situations requiring immediate stoppage of pre-authorized charges, such as order cancellation or payment method changes. Key functions include canceling specified pre-authorizations and providing real-time void status feedback. Key parameters include the pre-authorization ID and merchant order number.

## 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 |
| └─ merchantTransactionId | string | M | Original transaction ID from the merchant's website |
| └─ notificationUrl | string | M | Asynchronous notification address |
| └─ merchantVoidId | string | M | Merchant's pre-authorization void transaction ID, globally unique |
| └─ amount | string | M | Transaction amount, with two decimal places retained, such as 10.12. For some transaction currencies like JPY and KRW, where the smallest unit is the base currency, it also requires two decimal places to be submitted, for example, 29.00 |
| └─ currency | string | M | Transaction currency, ISO 4217 three-letter code. For specific supported currencies, see the attached Transaction Currencies: /en/notes/appendix/transactionCurrency/ table |

### Request Example

```json
{
  "accId": "2023042011040310224447",
  "bizContent": "{\"merchantVoidId\":\"PMT-RM319TQYEJ1715049483296\",\"merchantTransactionId\":\"PMT-RM319TQYEJ1715049483296\",\"amount\":\"100\",\"currency\":\"USD\",\"notificationUrl\":\"https://test-acquirerpay.pingpongx.com/qa/notify\"}",
  "clientId": "2023042011040310224",
  "sign": "334BB275659C85577A889EDCE1693972BA1744B24F8C12A8A5E37EE557B66DD0",
  "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 |
| └─ transactionId | string | Original transaction serial number of PingPong |
| └─ merchantTransactionId | string | Original transaction serial number of the merchant's website |
| └─ merchantVoidId | string | Void transaction serial number of the merchant's website |
| └─ description | string | Result description |
| └─ currency | string | Transaction currency |
| └─ amount | string | Transaction amount |
| └─ voidTime | string | Void initiation time, timestamp |
| └─ voidEndingTime | string | Void final state arrival time, timestamp |
| └─ status | string | Status SUCCESS- Success; FAILED- Failure; PROCESSING- In progress; |

### Response Example

```json
{
  "accId": "2023042011040310224447",
  "bizContent": "{\"amount\":\"100.000000\",\"merchantVoidId\":\"PMT-RM319TQYEJ1715049483296\",\"transactionId\":\"2024050750046462\",\"voidEndingTime\":\"1715049613278\",\"voidTime\":\"1715049612000\",\"merchantTransactionId\":\"PMT-RM319TQYEJ1715049483296\",\"currency\":\"USD\",\"status\":\"SUCCESS\"}",
  "clientId": "2023042011040310224",
  "code": "000000",
  "description": "Transaction succeeded",
  "sign": "0474235D375F8A81E9FD17E278ED3F11039F8462F64650A1F0D613FADAE5B04F",
  "signType": "SHA256"
}
```