구매 API - Tax 조회 #
1. API Overview #
Purpose #
상품 및 배송지 정보를 기반으로 예상 세금을 계산하는 API입니다.
사용자가 제공한 배송지와 청구지 주소, 상품 금액, 할인 및 배송비 정보를 바탕으로 세금 내역을 조회합니다.
결과에는 총 세액과 항목별 세금 상세 정보가 포함됩니다.
이 API는 결제 전에 세금 정보를 확인하여 정확한 결제 금액을 산출하는 데 사용됩니다.
참고: TAX 조회 기능은 PG사에 의존적입니다. TAX 조회 지원 여부는 빌링팀에 문의하시기 바랍니다. (ebp-server@lge.com)
Details #
| 항목 | 값 |
|---|---|
| API Name | Tax 조회 |
| API Path | /api/v2/payment/taxes |
| API ID | EBP_API_227 |
| HTTP Method | POST |
| Region | Global |
2. Request Specification #
2.1 Request Header #
상세한 헤더 정보는 Common Headers 문서를 참고하세요.
2.2 Request Data Schema #
| depth | Field | Details & Description |
|---|---|---|
| 0 | userNo |
🔴 Required 사용자 식별을 위한 고유 번호 |
| 0 | isTaxIncluded |
🔴 Required 상품 가격에 세금(TAX)이 포함 여부 |
| 0 | deliveryAddress |
🔴 Required 배송지 주소 정보 |
| 1 | recipientLocalName |
🔴 Required 수령인 현지 이름 |
| 1 | recipientLocalFirstName |
⚪ Optional 수령인 현지 퍼스트 이름 |
| 1 | countryCode |
🟡 Conditional 배송 국가 코드 (ISO 기준) |
| 1 | streetAddress |
⚪ Optional 배송지 도로명 |
| 1 | addressLine1 |
⚪ Optional 배송지 주소1 |
| 1 | addressLine2 |
⚪ Optional 배송지 주소2 |
| 1 | city |
⚪ Optional 배송지 시/도 |
| 1 | postalCode |
⚪ Optional 배송지 우편번호 |
| 0 | billingAddress |
- 세금계산서 발행을 위한 청구지 주소 정보 |
| 1 | billingEmail |
⚪ Optional 청구 담당자 이메일 주소 |
| 1 | billingLastName |
🟡 Conditional 청구 담당자 성(현지 언어) |
| 1 | billingFirstName |
🟡 Conditional 청구 담당자 이름(현지 언어) |
| 1 | billingCountry |
🟡 Conditional ISO 3166-1 alpha-3 국가 코드 |
| 1 | billingStreet |
🟡 Conditional 청구지 도로명 |
| 1 | billingAddressLine1 |
🟡 Conditional 청구지 주소1 |
| 1 | billingAddressLine2 |
⚪ Optional 청구지 주소2 |
| 1 | billingCity |
🟡 Conditional 청구지 도시 |
| 1 | billingPostalCode |
🟡 Conditional 청구지 우편번호 |
| 1 | billingState |
🟡 Conditional 청구지 주/도 |
| 0 | items |
🔴 Required - |
| 1 | seq |
🔴 Required 일련번호 |
| 1 | itemId |
🔴 Required 상품 ID |
| 1 | productCode |
🔴 Required 상품 코드 |
| 1 | amount |
⚪ Optional 상품금액 |
| 1 | discountAmount |
⚪ Optional 할인금액 |
| 1 | deliveryAmount |
⚪ Optional 배송금액 |
| 1 | deliveryProductCode |
⚪ Optional 배송비 상품 코드 |
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 결과 코드 (성공 "0", 에러 시 "EBP-A-0001" 등) |
| -1 | message |
🔴 Required 결과 메시지 (성공 또는 에러 상세) |
| -1 | requestId |
🔴 Required 추적을 위한 고유 요청 ID |
| -1 | timestamp |
🔴 Required ISO 8601 형식의 응답 타임스탬프 e.g., 2025-12-19T14:24:00+09:00 |
| -1 | data |
🔴 Required 응답 데이터 |
| 0 | totalTaxAmount |
🔴 Required 사용자 전체 세금 금액 |
| 0 | taxItems |
🔴 Required 세금 항목 객체 리스트 |
| 1 | itemSeq |
🔴 Required 세금 항목의 순번 |
| 1 | itemId |
🔴 Required 상품 고유 식별자 |
| 1 | taxAmount |
🔴 Required 해당 상품의 세금 금액 |
| 1 | taxDetails |
🔴 Required 세금 상세 내역 리스트 |
| 2 | detailSeq |
🔴 Required 상세 내역 순번 |
| 2 | taxType |
🔴 Required 세금 유형 (예: VAT, Service) |
| 2 | taxName |
🔴 Required 세금 이름 |
| 2 | taxAmount |
🔴 Required 해당 상세 내역의 세금 금액 |
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
}
]
}
]
}
}