구매 API - 결제 Capture #
1. API Overview #
Purpose #
결제 승인 후 Capture(매입/정산)를 요청하는 API입니다.
주문번호를 기반으로 승인된 결제 금액을 확정하고 정산 처리를 진행합니다.
처리 성공 시 해당 주문에 대한 결과를 반환하여 안정적인 정산 프로세스를 보장합니다.
Details #
| 항목 | 값 |
|---|---|
| API Name | 결제 Capture |
| API Path | /api/v2/payment/capture |
| API ID | EBP_API_228 |
| HTTP Method | POST |
| Region | Global |
2. Request Specification #
2.1 Request Header #
상세한 헤더 정보는 Common Headers 문서를 참고하세요.
2.2 Request Data Schema #
| depth | Field | Details & Description |
|---|---|---|
| 0 | orderNo |
🔴 Required Order Number |
| 0 | captureAmount |
🔴 Required 캡처 금액 |
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 |
🔴 Required 결과 코드 (성공 "0", 에러 시 "EBP-A-0001" 등) |
| -1 | message |
🔴 Required 결과 메시지 (성공 또는 에러 상세) |
| -1 | requestId |
🔴 Required 추적을 위한 고유 요청 ID |
| -1 | timestamp |
🔴 Required ISO 8601 형식의 응답 타임스탬프 e.g., 2025-12-19T14:24:00+09:00 |
| -1 | data |
🔴 Required 응답 데이터 |
| 0 | orderNo |
🔴 Required 주문번호 |
| 0 | resultCode |
🔴 Required |
| 0 | message |
🔴 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"
}
}