---
url: >-
  https://acquirer-api-docs-v4-en.pingpongx.com/en/notes/checkout/api/modifications/capture/index.md
description: >-
  The pre-authorization capture API is used by merchants to complete the final
  transaction amount deduction after obtaining customer payment card
  information. It applies to scenarios such as online shopping and hotel
  reservations that require fund freezing before actual payment. Key functions
  include executing deduction operations based on pre-authorization ID and
  supporting adjustment of deduction amounts. Main parameters include
  pre-authorization ID, deduction amount, and currency type.
---
# Pre-Authorization Capture

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

The pre-authorization capture API is used by merchants to complete the final transaction amount deduction after obtaining customer payment card information. It applies to scenarios such as online shopping and hotel reservations that require fund freezing before actual payment. Key functions include executing deduction operations based on pre-authorization ID and supporting adjustment of deduction amounts. Main parameters include pre-authorization ID, deduction amount, and currency type.

## 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 | The original transaction serial number of the merchant's website |
| └─ merchantCaptureId | string | M | The pre-authorization capture serial number of the merchant's website, globally unique |
| └─ amount | string | M | Transaction amount, retaining two decimal places, for example 10.12. For some transaction currencies like JPY and KRW, where the smallest unit is the yuan, it also requires two decimal places to be submitted, for example 29.00 |
| └─ currency | string | M | Transaction currency, a three-letter ISO 4217 code. For specific supported currencies, see the attached transaction currency list |
| └─ notificationUrl | string | O | A custom address defined by the merchant for this transaction result notification. Once this parameter is filled in, PingPongCheckout will asynchronously push the transaction result to this address via Post method |

### Request Example

```json
{
  "accId": "2023042011040310224447",
  "bizContent": "{\"merchantCaptureId\":\"PMT-2S7RR3K4LQ1715047351210\",\"merchantTransactionId\":\"PMT-2S7RR3K4LQ1715047351210\",\"amount\":\"100\",\"currency\":\"USD\",\"notificationUrl\":\"https://test-acquirerpay.pingpongx.com/qa/notify\"}",
  "clientId": "2023042011040310224",
  "sign": "4DCA0F0F91CDBB45DC0D40350CF428215C76CA29B282AEBBAA76CC09751E0ED1",
  "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 on the merchant's website |
| └─ merchantCaptureId | string | Merchant website pre-authorization capture serial number, globally unique |
| └─ currency | string | Transaction currency |
| └─ amount | string | Transaction amount |
| └─ captureTime | string | Capture initiation time, timestamp |
| └─ captureEndingTime | string | Time when capture reaches final state, timestamp |
| └─ status | string | SUCCESS - Success; FAILED - Failure; PROCESSING - In progress; |

### Response Example

```json
{
  "accId": "2023042011040310224447",
  "bizContent": "{\"amount\":\"100.000000\",\"merchantCaptureId\":\"PMT-2S7RR3K4LQ1715047351210\",\"captureTime\":\"1715047466000\",\"transactionId\":\"2024050750046460\",\"captureEndingTime\":\"1715047468242\",\"merchantTransactionId\":\"PMT-2S7RR3K4LQ1715047351210\",\"currency\":\"USD\",\"status\":\"SUCCESS\"}",
  "clientId": "2023042011040310224",
  "code": "000000",
  "description": "Transaction succeeded",
  "sign": "5033C47D3A1CF3E19A4B0EE0E566CE723D67E8BA236B828829BDE586CA999D2A",
  "signType": "SHA256"
}
```