---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/en/notes/api/services/InPersonPayments/cancel/index.md
description: >-
  Order Cancel API is used to cancel orders that have not yet been completed.
  Suitable for scenarios where customers need to cancel pending orders,
  supporting cancellation of orders in various states.
---
# Order Cancel API

```apidef
endpoint: POST /onsiteAcquirer/payment/misCancel
name: Order Cancel API
```

Order Cancel API is used to cancel orders that have not yet been completed. Suitable for scenarios where customers need to cancel pending orders, supporting cancellation of orders in various states.

## 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 |
| └─ merchantTransactionId | string | M | Merchant transaction serial number |

### Request Example

```json
{
  "accId": "SP1234567890",
  "clientId": "P100001",
  "signType": "SHA256",
  "sign": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
  "version": "1.0",
  "bizContent": "{\"requestTime\":\"1698912345678\",\"merchantTransactionId\":\"TX20231101123456\"}"
}
```

## 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 |
| └─ merchantTransactionId | string | Merchant transaction serial number |
| └─ cancelStatus | string | Cancel status: CANCEL_SUCCESS - Cancel successful; CANCEL_FAIL_PAID - Cancel failed, payment completed; CANCEL_PROCESSING - Cancel processing; |

### Response Example

```json
{
  "accId": "SP1234567890",
  "clientId": "P100001",
  "signType": "SHA256",
  "sign": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
  "code": "000000",
  "description": "成功",
  "bizContent": "{\"cancelStatus\":\"CANCEL_SUCCESS\",\"merchantTransactionId\":\"TX20231101123456\"}"
}
```