---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/en/notes/checkout/api/modifications/close/index.md
description: >-
  The close payment session API is used to end the current payment process. It
  is suitable for scenarios that require terminating incomplete payment
  operations, such as user order cancellation or payment timeout. Main functions
  include sending close requests and receiving confirmation responses. Key
  parameters include session_id and merchant_order_no.
---
# close

```apidef
endpoint: POST /v4/payment/close
name: close
summary: Close a payment order
tags: Checkout, Modification
```

The close payment session API is used to end the current payment process. It is suitable for scenarios that require terminating incomplete payment operations, such as user order cancellation or payment timeout. Main functions include sending close requests and receiving confirmation responses. Key parameters include session_id and merchant_order_no.

## 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 | Merchant website order number |

### Request Example

```json
{
  "accId": "2023042011040310224447",
  "bizContent": "{\"merchantTransactionId\":\"PMT-2S7RR3K4LQ1715047351210\"}",
  "clientId": "2023042011040310224",
  "sign": "0F271F64F5ADDF225D32A8F3EADFD5E4F6E71734531D2F18DD51DB6D8CD50E79",
  "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 | PingPong original transaction serial number |
| └─ merchantTransactionId | string | Original transaction serial number of the merchant's website |
| └─ resultStatus | string | Order closure result: SUCCESS - Success; FAILED - Failure; UNKNOWN - Unknown; |

### Response Example

```json
{
  "accId": "2023042011040310224447",
  "bizContent": "{\"transactionId\":\"2024050750046460\",\"merchantTransactionId\":\"PMT-2S7RR3K4LQ1715047351210\",\"resultStatus\":\"SUCCESS\"}",
  "clientId": "2023042011040310224",
  "code": "000000",
  "description": "Transaction succeeded",
  "sign": "3415FF30D4DF1A3FD32322EBFBAC73342A7E6140D4E39490097C7F06BDD34620C",
  "signType": "SHA256"
}
```