---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/en/notes/checkout/api/getVoid/index.md
description: >-
  getVoid API is used to query the pre-authorization void status. Applicable to
  scenarios where the void result needs to be confirmed after completing the
  pre-authorization transaction, ensuring it is called after the synchronous
  return to avoid query exceptions. Main functions include verifying whether the
  void was successful and returning relevant status information.
---
# Pre-Authorization Void Query

```apidef
endpoint: POST /v4/void/query
name: getVoid
summary: Query void status
tags: Query, Void
```

getVoid API is used to query the pre-authorization void status. Applicable to scenarios where the void result needs to be confirmed after completing the pre-authorization transaction, ensuring it is called after the synchronous return to avoid query exceptions. Main functions include verifying whether the void was successful and returning relevant status information.

## 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 |
| └─ merchantVoidId | string | M | Merchant website pre-authorization void transaction number |
| └─ merchantTransactionId | string | M | Merchant website original transaction number |

### Request Example

```json
{
  "accId": "2018092714313010016291",
  "clientId": "2018092714313010016",
  "signType": "SHA256",
  "sign": "898A3CBE981B3E2BF4E2B8D1A817D7E23EF93BC4293993EE545E36F4C87F2E79",
  "version": "1.0",
  "bizContent": "{\"merchantVoidId\":\"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/ |
| └─ resultCode | string | Status result code |
| └─ resultDescription | string | Status result description |
| └─ amount | string | Void amount |
| └─ voidTime | string | Void initiation time, timestamp |
| └─ voidEndingTime | string | Void final status arrival time, timestamp |
| └─ status | string | Transaction status: Status Idempotence: /en/notes/guide/paystatus/ SUCCESS - Success; FAILED - Failed; PROCESSING - Processing; |

### Response Example

```json
{
  "accId": "2023060217493010231446",
  "bizContent": "{\"amount\":\"200.000000\",\"resultCode\":\"000000\",\"transactionId\":\"2023062150000345\",\"voidTime\":\"1687347620000\",\"merchantTransactionId\":\"PMT-P1IC0ZS7E11687347218645\",\"currency\":\"USD\",\"resultDescription\":\"Transaction succeeded\",\"status\":\"SUCCESS\"}",
  "clientId": "2023060217493010231",
  "code": "001000",
  "description": "Successful request",
  "sign": "1EDDB8216409E900AD29095174BEC90710CDD5D2D4B72D84DBD4DF8F2C3E169B",
  "signType": "SHA256"
}
```