Purchase API - Get Tax Info #
1. API Overview #
Purpose #
This API calculates the estimated tax based on product and shipping information.
It retrieves tax details using the provided delivery and billing addresses, item amounts, discounts, and shipping charges.
The response includes the total tax amount and detailed tax breakdown per item.
The API is used to confirm tax information before payment to ensure accurate billing.
Note: The TAX calculation feature is dependent on the PG. Please contact the Billing Team (ebp-server@lge.com) to check if TAX calculation is supported for your PG.
Details #
| Item | Value |
|---|---|
| API Name | Get Tax Info |
| API Path | /api/v2/payment/taxes |
| API ID | EBP_API_227 |
| 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 |
|---|---|---|
| 0 | userNo |
π΄ Required Unique identifier for user |
| 0 | isTaxIncluded |
π΄ Required Indicates whether tax is included in product price |
| 0 | deliveryAddress |
π΄ Required Delivery address information |
| 1 | recipientLocalName |
π΄ Required Recipient's local name |
| 1 | recipientLocalFirstName |
βͺ Optional Recipient's local first name |
| 1 | countryCode |
π‘ Conditional Delivery country code (ISO standard) |
| 1 | streetAddress |
βͺ Optional Street name for delivery address |
| 1 | addressLine1 |
βͺ Optional Primary delivery address line |
| 1 | addressLine2 |
βͺ Optional Secondary delivery address line |
| 1 | city |
βͺ Optional City or province for delivery |
| 1 | postalCode |
βͺ Optional Postal code for delivery address |
| 0 | billingAddress |
- Billing address information (required for tax invoice) |
| 1 | billingEmail |
βͺ Optional Billing contact email address |
| 1 | billingLastName |
π‘ Conditional Billing contact last name (local language) |
| 1 | billingFirstName |
π‘ Conditional Billing contact first name (local language) |
| 1 | billingCountry |
π‘ Conditional ISO 3166-1 alpha-3 country code |
| 1 | billingStreet |
π‘ Conditional Street name for billing address |
| 1 | billingAddressLine1 |
π‘ Conditional Primary billing address line |
| 1 | billingAddressLine2 |
βͺ Optional Secondary billing address line |
| 1 | billingCity |
π‘ Conditional City for billing address |
| 1 | billingPostalCode |
π‘ Conditional Postal code for billing address |
| 1 | billingState |
π‘ Conditional State or province for billing address |
| 0 | items |
π΄ Required - |
| 1 | seq |
π΄ Required Sequence |
| 1 | itemId |
π΄ Required Product ID |
| 1 | productCode |
π΄ Required Product Code |
| 1 | amount |
βͺ Optional Product amount |
| 1 | discountAmount |
βͺ Optional Discount Amount |
| 1 | deliveryAmount |
βͺ Optional Delivery Amount |
| 1 | deliveryProductCode |
βͺ Optional Delivery Product Code |
2.3 Request Examples #
JSON Example #
{
"userNo": "U123456789",
"isTaxIncluded": "Y",
"deliveryAddress": {
"recipientLocalName": "νκΈΈλ",
"recipientLocalFirstName": "κΈΈλ",
"countryCode": "KR",
"streetAddress": "123 κ°λ¨λλ‘",
"addressLine1": "κ°λ¨κ΅¬ μμΌλ",
"addressLine2": "μΌμ±νμ 101νΈ",
"city": "μμΈ",
"postalCode": "06236"
},
"billingAddress": {
"billingEmail": "billing@example.com",
"billingLastName": "Kim",
"billingFirstName": "Minsoo",
"billingCountry": "KOR",
"billingStreet": "456 ν
ν€λλ‘",
"billingAddressLine1": "κ°λ¨κ΅¬ μΌμ±λ",
"billingAddressLine2": "λΉλ© 202νΈ",
"billingCity": "μμΈ",
"billingPostalCode": "06164",
"billingState": "μμΈνΉλ³μ"
},
"items": [
{
"seq": 1,
"productCode": "",
"amount": "",
"discountAmount": 0,
"deliveryAmount": 0,
"deliveryProductCode": "24643"
}
]
}
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 | totalTaxAmount |
π΄ Required Total tax amount for the user |
| 0 | taxItems |
π΄ Required List of tax item objects |
| 1 | itemSeq |
π΄ Required Sequence number of the tax item |
| 1 | itemId |
π΄ Required Unique product identifier |
| 1 | taxAmount |
π΄ Required Tax amount for the corresponding product |
| 1 | taxDetails |
π΄ Required List of tax details |
| 2 | detailSeq |
π΄ Required Detail sequence number |
| 2 | taxType |
π΄ Required Tax type e.g., VAT, Service |
| 2 | taxName |
π΄ Required Tax name |
| 2 | taxAmount |
π΄ Required Tax amount for the corresponding detail |
3.2 Response Samples #
Success Response #
{
"resultCode": "0",
"message": "SUCCESS",
"requestId": "1767142829863",
"timestamp": "2025-12-31T01:00:29.865421800Z",
"data": {
"totalTaxAmount": 0.41,
"taxItems": [
{
"itemSeq": 1,
"itemId": "PD_20250000000003",
"taxAmount": 0.41,
"taxDetails": [
{
"detailSeq": 1,
"taxType": "Sales And Use Taxes",
"taxName": "NY Local Transit Tax",
"taxAmount": 0.0225
},
{
"detailSeq": 2,
"taxType": "Sales And Use Taxes",
"taxName": "NY Sales Tax",
"taxAmount": 0.1875
},
{
"detailSeq": 3,
"taxType": "Sales And Use Taxes",
"taxName": "NY Sales Tax",
"taxAmount": 0.2
}
]
}
]
}
}