Purchase API - Get Payment Details #
1. API Overview #
Purpose #
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.
Note
orderNois the order number issued by EBP.
Details #
| Item | Value |
|---|---|
| API Name | Get Payment Details |
| API Path | /api/v2/payment/detail |
| API ID | EBP_API_237 |
| 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 |
|---|---|---|
| -1 | orderNo |
🔴 Required EBP order number |
2.3 Request Examples #
JSON Example #
{
"orderNo": "ORD-202511274242111"
}
3. Response Specification #
3.1 Response Data Schema #
| depth | Field | Details & Description |
|---|---|---|
| -1 | resultCode |
🔴 Required Result code e.g., "0" for success, "EBP-A-0001" for error |
| -1 | message |
🔴 Required Result message |
| -1 | requestId |
🔴 Required Unique request identifier for tracking |
| -1 | timestamp |
🔴 Required Response timestamp in ISO 8601 format e.g., 2025-12-19T14:24:00+09:00 |
| -1 | data |
🔴 Required Response data |
| 0 | orderNo |
🔴 Required Unique order number identifying the transaction |
| 0 | storeRequestNo |
🔴 Required Store-side request number for merchant system correlation |
| 0 | pgTransactionId |
⚪ Optional Payment gateway transaction identifier for original payment |
| 0 | pgCancelTransactionId |
⚪ Optional Payment gateway transaction identifier for cancellation/refund |
| 0 | buyerName |
⚪ Optional Buyer/customer name |
| 0 | paymentStatus |
🔴 Required Current payment status e.g., REQUESTED, APPROVED, CANCELED, PARTIAL_CANCELED |
| 0 | countryCode |
⚪ Optional Country code, ISO 3166-1 alpha-2 e.g., KR, US |
| 0 | countryName |
⚪ Optional Country name (English or localized) |
| 0 | paymentRequestedAt |
🔴 Required Timestamp when payment was requested |
| 0 | approvedAt |
⚪ Optional Timestamp when payment was approved |
| 0 | settlementCompletedAt |
⚪ Optional Timestamp when payment was approved |
| 0 | canceledAt |
⚪ Optional Timestamp when payment was canceled |
| 0 | cancellationDetail |
⚪ Optional Cancellation detail or notes |
| 0 | paymentMethodName |
🔴 Required Human-readable payment method name e.g., Credit Card, Tokenized Card |
| 0 | storeName |
🔴 Required Name of the store or merchant |
| 0 | purchaseChannel |
⚪ Optional Name of the purchase channel e.g., Online, POS |
| 0 | currencyCode |
🔴 Required Currency code ISO 4217 e.g., USD, KRW |
| 0 | productAmount |
🔴 Required Total amount for products before discounts |
| 0 | discountAmount |
⚪ Optional Discount amount applied to the order |
| 0 | deliveryFee |
⚪ Optional Delivery/shipping fee |
| 0 | totalPaymentAmount |
🔴 Required Total payment amount after discounts and fees |
| 0 | productTaxAmount |
⚪ Optional Tax amount applied to products |
| 0 | deliveryFeeTaxAmount |
⚪ Optional Tax amount applied to delivery fee |
| 0 | cancelAmount |
⚪ Optional - |
| 0 | items |
🔴 Required List of items |
| 1 | seq |
🔴 Required Sequence number |
| 1 | itemType |
🔴 Required Product type e.g., PHYSICAL, DIGITAL, SUBSCRIPTION, DELIVERY, SERVICE |
| 1 | itemId |
🔴 Required Unique product identifier |
| 1 | itemName |
🔴 Required Name of the product |
| 1 | sellerNo |
🔴 Required Seller identifier |
| 1 | unitPrice |
🔴 Required Original item amount |
| 1 | subtotalAmount |
🔴 Required Total item amount (unitPrice × quantity |
| 1 | discountAmount |
⚪ Optional Discount amount |
| 1 | paymentAmount |
🔴 Required Final payment amount |
| 1 | quantity |
🔴 Required Quantity sold |
| 1 | confirmedAt |
⚪ Optional Purchase confirmation date |
| 0 | cancelItems |
🔴 Required List of canceled items |
| 1 | cancelNo |
🔴 Required Unique identifier for the cancellation |
| 1 | pgTransactionId |
⚪ Optional PG transaction ID for the cancellation |
| 1 | canceledAt |
🔴 Required Cancellation date and time |
| 1 | seq |
🔴 Required Product sequence number |
| 1 | itemType |
🔴 Required Item type e.g., PHYSICAL, DIGITAL, DELIVERY, SERVICE |
| 1 | itemId |
🔴 Required Unique product identifier |
| 1 | itemName |
🔴 Required Name of the product |
| 1 | quantity |
🔴 Required Number of items canceled |
| 1 | paymentAmount |
🔴 Required Total payment amount |
| 1 | cancelAmount |
🔴 Required Total cancellation amount |
| 0 | histories |
⚪ Optional Payment processing audit trail |
| 1 | seq |
🔴 Required Log sequence |
| 1 | processedAt |
🔴 Required Processing timestamp |
| 1 | eventName |
🔴 Required Event name e.g., Payment Requested |
| 1 | result |
🔴 Required Processing result e.g., SUCCESS, FAILURE |
| 1 | reason |
⚪ Optional Detailed reason for result |
| 1 | processedBy |
⚪ Optional ID of system or user who processed it |
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": "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"
}
]
}
}