Purchase API - Capture Payment #

1. API Overview #

Purpose #

This API is used to request a Capture (settlement) after payment authorization.
It finalizes the authorized payment amount and processes the settlement based on the order number.
After processing the capture, the API returns the result to the merchant to ensure a secure settlement process.

Details #

Item	Value
API Name	Capture Payment
API Path	/api/v2/payment/capture
API ID	EBP_API_228
HTTP Method	POST
Region	Global

2. Request Specification #

2.1 Request Header #

For detailed header information, please refer to the Common Headers documentation.

2.2 Request Data Schema #

depth Field Details & Description

orderNo

depth	Field	Details & Description
0	orderNo	`string` 🔴 Required Order Number
0	captureAmount	`number` 🔴 Required Capture Amount

string

🔴 Required

Order Number

captureAmount

number

🔴 Required

Capture Amount

2.3 Request Examples #

JSON Example #

{
  "orderNo": "ORD20251224001",
  "captureAmount": 100.0
}

3. Response Specification #

3.1 Response Data Schema #

depth	Field	Details & Description
-1	resultCode	`string` 🔴 Required Result code e.g., "0" for success, "EBP-A-0001" for error
-1	message	`string` 🔴 Required Result message
-1	requestId	`string` 🔴 Required Unique request identifier for tracking
-1	timestamp	`string` 🔴 Required Response timestamp in ISO 8601 format e.g., 2025-12-19T14:24:00+09:00
-1	data	`object` 🔴 Required Response data
0	orderNo	`string` 🔴 Required Order Number
0	resultCode	`string` 🔴 Required -
0	message	`string` 🔴 Required -

3.2 Response Samples #

Success Response #

{
  "resultCode": "0",
  "message": "SUCCESS",
  "requestId": "1767139979421",
  "timestamp": "2025-12-31T00:12:59.422210900Z",
  "data": {
    "orderNo": "ORD20251224001",
    "resultCode": "000",
    "message": "success"
  }
}