Getting Started #
1. Introduction #
The Integrated Billing System provides comprehensive functionalities for processing customer purchases, handling payment transactions with Payment Gateways (PG), and managing settlement and statistical reporting.
The APIs provided by the system follow a RESTful protocol, enabling flexible implementation regardless of device type. All communication operates on a server-client model.
By design, the billing system responds to requests sent by clients (such as CP, Store, ...) with result data, ensuring reliable interaction between the client and the system.
2. Basic Information #
The EBP REST API is based on the HTTP protocol and has the following characteristics:
- Data Format: JSON (Content-Type:
application/json; charset=utf-8) - Character Set: UTF-8
- API Base Path:
/api/v2
Server Information (Domain/Host) #
| Environment | Region | Domain (Host) |
|---|---|---|
| DEV | KIC | devkic-payapi-int.nebp.lge.com |
| AIC | devaic-payapi-int.nebp.lge.com | |
| EIC | deveic-payapi-int.nebp.lge.com | |
| QA | KIC | qakic-payapi-int.nebp.lge.com |
| AIC | qaaic-payapi-int.nebp.lge.com | |
| EIC | qaeic-payapi-int.nebp.lge.com | |
| PRD | KIC | kic-payapi-int.nebp.lge.com |
| AIC | aic-payapi-int.nebp.lge.com | |
| EIC | eic-payapi-int.nebp.lge.com |
3. Authentication & Common Headers #
All API requests must include the following common headers for authentication and integrity verification.
| Header Name | Description | Required |
|---|---|---|
X-Access-Key | API key issued by EBP for system access | Yes |
X-EBP-Signature | Signature (payload + Hash Key) for integrity verification | Yes |
X-Division-Code | Business division code | Yes |
X-Store-Id | Store ID | Yes |
X-Channel-Code | Channel code (system classification) | Yes |
X-Ric-Code | Regional Integration Code (e.g., KIC, AIC, EIC) | Yes |
X-Country-Code | ISO country code | Yes |
For detailed header information, please refer to the Common Headers documentation.
4. Standard Response Structure #
Responses from the API follow a consistent structure regardless of success or failure.
4.1. Standard Response Field Specification #
| 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 |
4.2. Field Attribute Icon Guide #
| Icon | Description |
|---|---|
| String Type | |
| Number Type | |
| Boolean Type | |
| Object Type | |
| Array Type | |
🔴 Required | Required Field |
⚪ Optional | Optional Field |
🟡 Conditional | Conditional Field |
JSON
{
"resultCode": "0",
"message": "SUCCESS",
"requestId": "1767079168322",
"timestamp": "2025-12-30T07:19:28.323457100Z",
"data": { ... }
}
5. Key API Groups #
- Billing Account API: Token registration, lookup, deletion, and PIN management.
- Purchase API: Payment readiness, token payment, cancellation, and receipt inquiry.
- Settlement API: Seller info management and settlement/payment log retrieval.
6. Payment Flow #
For detailed information on the payment status flowchart and step-by-step processes, please refer to the following document.