구매 API - 결제 상세 조회 #

1. API Overview #

Purpose #

특정 결제 요청에 대한 상세 정보를 조회하는 API입니다. orderNo를 기반으로 결제 상태, 결제 금액, 구매자 정보, 결제 이력 등 상세 내역을 반환합니다.
조회 결과에는 결제 승인 여부, 정산 완료 여부, 취소 내역, 상품별 결제 금액 및 처리 이력 등이 포함됩니다. 이 API는 결제 처리 현황을 확인하거나 고객 응대 시 상세 정보를 제공하는 데 활용됩니다.

참고

orderNo는 EBP에서 발급되는 주문번호입니다.

Details #

항목	값
API Name	결제 상세 조회
API Path	/api/v2/payment/detail
API ID	EBP_API_237
HTTP Method	POST
Region	Global

2. Request Specification #

2.1 Request Header #

상세한 헤더 정보는 Common Headers 문서를 참고하세요.

2.2 Request Data Schema #

depth Field Details & Description

-1

orderNo

depth	Field	Details & Description
-1	orderNo	`string` 🔴 Required EBP 주문번호

string

🔴 Required

EBP 주문번호

2.3 Request Examples #

JSON Example #

{
  "orderNo": "ORD-202511274242111"
}

3. Response Specification #

3.1 Response Data Schema #

depth	Field	Details & Description
-1	resultCode	`string` 🔴 Required 결과 코드 (성공 "0", 에러 시 "EBP-A-0001" 등)
-1	message	`string` 🔴 Required 결과 메시지 (성공 또는 에러 상세)
-1	requestId	`string` 🔴 Required 추적을 위한 고유 요청 ID
-1	timestamp	`string` 🔴 Required ISO 8601 형식의 응답 타임스탬프 e.g., 2025-12-19T14:24:00+09:00
-1	data	`object` 🔴 Required 응답 데이터
0	orderNo	`string` 🔴 Required 거래를 식별하는 고유 주문 번호
0	storeRequestNo	`string` 🔴 Required 상점 시스템 연동을 위한 스토어측 요청 번호
0	pgTransactionId	`string` ⚪ Optional 최초 결제에 대한 PG 거래 ID
0	pgCancelTransactionId	`string` ⚪ Optional 취소/환불에 대한 PG 거래 ID
0	buyerName	`string` ⚪ Optional 구매자/고객 이름
0	paymentStatus	`string` 🔴 Required 현재 결제 상태 e.g., REQUESTED, APPROVED, CANCELED, PARTIAL_CANCELED
0	countryCode	`string` ⚪ Optional 국가 코드 e.g., KR, US
0	countryName	`string` ⚪ Optional 국가명 (영문 또는 현지화)
0	paymentRequestedAt	`string` 🔴 Required 결제 요청 시각
0	approvedAt	`string` ⚪ Optional 결제 승인 시각
0	settlementCompletedAt	`string` ⚪ Optional 정산 완료 시각
0	canceledAt	`string` ⚪ Optional 결제 취소 시각
0	cancellationDetail	`string` ⚪ Optional 취소 상세 내용 또는 메모
0	paymentMethodName	`string` 🔴 Required 읽기 쉬운 결제 수단명 e.g., 신용카드, 토큰화된 카드
0	storeName	`string` 🔴 Required 스토어 또는 판매자 이름
0	purchaseChannel	`string` ⚪ Optional 구매 채널명 e.g., Online, POS
0	currencyCode	`string` 🔴 Required 통화 코드 e.g., USD, KRW
0	productAmount	`number` 🔴 Required 할인 전 상품 총액
0	discountAmount	`number` ⚪ Optional 주문에 적용된 할인 금액
0	deliveryFee	`number` ⚪ Optional 배송료
0	totalPaymentAmount	`number` 🔴 Required 할인 및 수수료 적용 후 총 결제 금액
0	productTaxAmount	`number` ⚪ Optional 상품에 적용된 세금 금액
0	deliveryFeeTaxAmount	`number` ⚪ Optional 배송료에 적용된 세금 금액
0	cancelAmount	`number` ⚪ Optional 취소 금액
0	items	`array` 🔴 Required 품목 목록
1	seq	`number` 🔴 Required 순번
1	itemType	`string` 🔴 Required 상품 유형 e.g., PHYSICAL, DIGITAL, SUBSCRIPTION, DELIVERY, SERVICE
1	itemId	`string` 🔴 Required 상품 고유 식별자
1	itemName	`string` 🔴 Required 상품명
1	sellerNo	`string` 🔴 Required 판매자 식별자
1	unitPrice	`number` 🔴 Required 원래 상품 금액
1	subtotalAmount	`number` 🔴 Required 총 상품 금액 (단가 × 수량
1	discountAmount	`number` ⚪ Optional 할인 금액
1	paymentAmount	`number` 🔴 Required 최종 결제 금액
1	quantity	`number` 🔴 Required 판매 수량
1	confirmedAt	`string` ⚪ Optional 구매 확정일
0	cancelItems	`array` 🔴 Required 취소 품목 목록
1	cancelNo	`string` 🔴 Required 취소 고유 식별자
1	pgTransactionId	`string` ⚪ Optional 취소에 대한 PG 거래 ID
1	canceledAt	`string` 🔴 Required 취소 일시
1	seq	`string` 🔴 Required 취소된 상품의 고유 식별자
1	seq	`number` 🔴 Required 순번
1	itemId	`string` 🔴 Required 상품 고유 식별자
1	itemName	`string` 🔴 Required 상품명
1	quantity	`number` 🔴 Required 취소 수량
1	paymentAmount	`number` 🔴 Required 총 결제 금액
1	cancelAmount	`number` 🔴 Required 총 취소 금액
0	histories	`array` ⚪ Optional 결제 처리 과정에 대한 감사 추적 로그 (audit trail)
1	seq	`number` 🔴 Required 로그 순번
1	processedAt	`string` 🔴 Required 처리 발생 시각
1	eventName	`string` 🔴 Required 발생한 이벤트 이름 e.g., Payment Requested
1	result	`string` 🔴 Required 처리 결과 e.g., SUCCESS, FAILURE
1	reason	`string` ⚪ Optional 처리 결과에 대한 상세 사유
1	processedBy	`string` ⚪ Optional 해당 처리를 수행한 시스템 또는 사용자 ID

3.2 Response Samples #

Success Response #

{
  "resultCode": "0",
  "message": "SUCCESS",
  "requestId": "1767146488599",
  "timestamp": "2025-12-31T02:01:28.600976Z",
  "data": {
    "orderNo": "ORD-202511274242111",
    "storeRequestNo": "P25112711771579",
    "pgTransactionId": "K202511277931269531",
    "pgCancelTransactionId": null,
    "buyerName": "성준호",
    "paymentStatus": "APPROVED",
    "countryCode": "KR",
    "countryName": "Republic of Korea",
    "paymentRequestedAt": "2025-11-27T12:19:34.0Z",
    "approvedAt": "2025-11-27T12:19:50.0Z",
    "settlementCompletedAt": "2025-11-27T12:19:50.0Z",
    "canceledAt": null,
    "cancellationDetail": null,
    "paymentMethodName": "신용카드(CNSPay)",
    "storeName": "엘지이닷컴",
    "purchaseChannel": "폰클라이언트",
    "currencyCode": "KRW",
    "productAmount": 1310000.0,
    "discountAmount": 0.0,
    "deliveryFee": 0.0,
    "totalPaymentAmount": 1310000.0,
    "productTaxAmount": 0.0,
    "deliveryFeeTaxAmount": 0.0,
    "cancelAmount": 0.0,
    "items": [
      {
        "seq": 1,
        "itemType": "PHYSICAL",
        "itemId": "75UT9300BW.AKRG",
        "itemName": "LG 울트라 HD TV (벽걸이형)",
        "sellerId": "CPKR810001",
        "productAmount": 1310000.0,
        "discountAmount": 0.0,
        "paymentAmount": 1310000.0,
        "taxAmount": 0.0,
        "quantity": 1,
        "confirmedAt": "2025-11-27T12:19:50.0Z",
        "confirmedAtLocal": "2025-11-27T21:19:50.0Z"
      }
    ],
    "cancelItems": [],
    "histories": [
      {
        "seq": 1,
        "processedAt": "2025-11-27T12:19:34.0Z",
        "processedAtLocal": "2025-11-27T21:19:34.0",
        "eventName": "Payment Requested",
        "result": "SUCCESS",
        "reason": "Client payment request initiated",
        "processedBy": "CORE"
      },
      {
        "seq": 2,
        "processedAt": "2025-11-27T12:19:50.0Z",
        "processedAtLocal": "2025-11-27T21:19:50.0",
        "eventName": "PG Approval Success",
        "result": "SUCCESS",
        "reason": "Payment gateway approved the transaction",
        "processedBy": "PG-GATEWAY"
      }
    ]
  }
}