# Purchase API - Get Payment Details ## 1. API Overview ### Purpose [context] This API retrieves detailed information about a specific payment request. It returns payment status, amount, buyer details, and transaction history based on `orderNo`. The response includes approval status, settlement completion, cancellation details, item-level payment amounts, and processing history. This API is useful for checking payment progress or providing detailed information for customer support. [/context] > **Note** > - `orderNo` is the **order number issued by EBP**. ### Details [table:key-value] | Item | Value | | :-------------- | :--------------------- | | **API Name** | Get Payment Details | | **API Path** | /api/v2/payment/detail | | **API ID** | EBP_API_237 | | **HTTP Method** | [badge:POST,blue,lg] | | **Region** | [badge:Global,green-subtle,lg] | [/table] ## 2. Request Specification ### 2.1 Request Header @@include:common-headers-link.md@@ ### 2.2 Request Data Schema | depth | Field | Details & Description | | :---- | :------ | :------------------------------- | | -1 | orderNo | [type:string] [req:Yes] [desc:EBP order number] | ### 2.3 Request Examples #### JSON Example ```json { "orderNo": "ORD-202511274242111" } ``` ## 3. Response Specification ### 3.1 Response Data Schema @@include:standard-response.md@@ | -1 | data | [type:object] [req:Yes] [desc:Response data] | | 0 | orderNo | [type:string] [req:Yes] [desc:Unique order number identifying the transaction] | | 0 | storeRequestNo | [type:string] [req:Yes] [desc:Store-side request number for merchant system correlation] | | 0 | pgTransactionId | [type:string] [req:Optional] [desc:Payment gateway transaction identifier for original payment] | | 0 | pgCancelTransactionId | [type:string] [req:Optional] [desc:Payment gateway transaction identifier for cancellation/refund] | | 0 | buyerName | [type:string] [req:Optional] [desc:Buyer/customer name] | | 0 | paymentStatus | [type:string] [req:Yes] [desc:Current payment status] [eg:REQUESTED, APPROVED, CANCELED, PARTIAL_CANCELED] | | 0 | countryCode | [type:string] [req:Optional] [desc:Country code, ISO 3166-1 alpha-2] [eg:KR, US] | | 0 | countryName | [type:string] [req:Optional] [desc:Country name (English or localized)] | | 0 | paymentRequestedAt | [type:string] [req:Yes] [desc:Timestamp when payment was requested[tooltip:UTC, ISO-8601]] | | 0 | approvedAt | [type:string] [req:Optional] [desc:Timestamp when payment was approved[tooltip:UTC, ISO-8601]] | | 0 | settlementCompletedAt | [type:string] [req:Optional] [desc:Timestamp when payment was approved[tooltip:UTC, ISO-8601]] | | 0 | canceledAt | [type:string] [req:Optional] [desc:Timestamp when payment was canceled[tooltip:UTC, ISO-8601]] | | 0 | cancellationDetail | [type:string] [req:Optional] [desc:Cancellation detail or notes[tooltip:reason, partial cancellation info]] | | 0 | paymentMethodName | [type:string] [req:Yes] [desc:Human-readable payment method name] [eg:Credit Card, Tokenized Card] | | 0 | storeName | [type:string] [req:Yes] [desc:Name of the store or merchant] | | 0 | purchaseChannel | [type:string] [req:Optional] [desc:Name of the purchase channel] [eg:Online, POS] | | 0 | currencyCode | [type:string] [req:Yes] [desc:Currency code ISO 4217] [eg:USD, KRW] | | 0 | productAmount | [type:string] [req:Yes] [desc:Total amount for products before discounts] | | 0 | discountAmount | [type:string] [req:Optional] [desc:Discount amount applied to the order] | | 0 | deliveryFee | [type:string] [req:Optional] [desc:Delivery/shipping fee] | | 0 | totalPaymentAmount | [type:string] [req:Yes] [desc:Total payment amount after discounts and fees] | | 0 | productTaxAmount | [type:string] [req:Optional] [desc:Tax amount applied to products] | | 0 | deliveryFeeTaxAmount | [type:string] [req:Optional] [desc:Tax amount applied to delivery fee] | | 0 | cancelAmount | [type:string] [req:Optional] [desc:-] | | 0 | items | [type:array] [req:Yes] [desc:List of items] | | 1 | seq | [type:number] [req:Yes] [desc:Sequence number] | | 1 | itemType | [type:string] [req:Yes] [desc:Product type] [eg:PHYSICAL, DIGITAL, SUBSCRIPTION, DELIVERY, SERVICE] | | 1 | itemId | [type:string] [req:Yes] [desc:Unique product identifier] | | 1 | itemName | [type:string] [req:Yes] [desc:Name of the product] | | 1 | sellerNo | [type:string] [req:Yes] [desc:Seller identifier] | | 1 | unitPrice | [type:number] [req:Yes] [desc:Original item amount] | | 1 | subtotalAmount | [type:number] [req:Yes] [desc:Total item amount (unitPrice × quantity] | | 1 | discountAmount | [type:number] [req:Optional] [desc:Discount amount] | | 1 | paymentAmount | [type:number] [req:Yes] [desc:Final payment amount] | | 1 | quantity | [type:number] [req:Yes] [desc:Quantity sold] | | 1 | confirmedAt | [type:string] [req:Optional] [desc:Purchase confirmation date[tooltip:UTC, ISO-8601]] | | 0 | cancelItems | [type:array] [req:Yes] [desc:List of canceled items] | | 1 | cancelNo | [type:string] [req:Yes] [desc:Unique identifier for the cancellation] | | 1 | pgTransactionId | [type:string] [req:Optional] [desc:PG transaction ID for the cancellation] | | 1 | canceledAt | [type:string] [req:Yes] [desc:Cancellation date and time[tooltip:UTC, ISO-8601]] | | 1 | seq | [type:string] [req:Yes] [desc:Product sequence number] | | 1 | itemType | [type:string] [req:Yes] [desc:Item type] [eg:PHYSICAL, DIGITAL, DELIVERY, SERVICE] | | 1 | itemId | [type:string] [req:Yes] [desc:Unique product identifier] | | 1 | itemName | [type:string] [req:Yes] [desc:Name of the product] | | 1 | quantity | [type:number] [req:Yes] [desc:Number of items canceled] | | 1 | paymentAmount | [type:number] [req:Yes] [desc:Total payment amount] | | 1 | cancelAmount | [type:number] [req:Yes] [desc:Total cancellation amount] | | 0 | histories | [type:array] [req:Optional] [desc:Payment processing audit trail] | | 1 | seq | [type:number] [req:Yes] [desc:Log sequence] | | 1 | processedAt | [type:string] [req:Yes] [desc:Processing timestamp[tooltip:UTC, ISO-8601]] | | 1 | eventName | [type:string] [req:Yes] [desc:Event name] [eg:Payment Requested] | | 1 | result | [type:string] [req:Yes] [desc:Processing result] [eg:SUCCESS, FAILURE] | | 1 | reason | [type:string] [req:Optional] [desc:Detailed reason for result] | | 1 | processedBy | [type:string] [req:Optional] [desc:ID of system or user who processed it] | ### 3.2 Response Samples #### Success Response ```json { "resultCode": "0", "message": "SUCCESS", "requestId": "1767146488599", "timestamp": "2025-12-31T02:01:28.600976Z", "data": { "orderNo": "ORD-202511274242111", "storeRequestNo": "P25112711771579", "pgTransactionId": "K202511277931269531", "pgCancelTransactionId": null, "buyerName": "Junho Sung", "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": "Credit Card(CNSPay)", "storeName": "LGE.COM", "purchaseChannel": "Phone Client", "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 Ultra HD TV (Wall-mounted)", "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" } ] } } ```