coupang
GET/v2/providers/marketplace_openapi/apis/api/v1/settlement-histories2609170000

지급내역조회

KRTW
# 01

요약

지급내역조회

# 02

상세

API 적용 가능한 구매자 사용자 지역: 한국

매출인식월을 기준으로 지급 확정/예정된 내역을 확인합니다.

경로

GET/v2/providers/marketplace_openapi/apis/api/v1/settlement-histories

예시 엔드포인트

https://api-gateway.coupang.com/v2/providers/marketplace_openapi/apis/api/v1/settlement-histories?revenueRecognitionYearMonth=2019-10

URL API Name

SETTLEMENT_HISTORIES
# 03

Query 파라미터

NameTypeDescription
revenueRecognitionYearMonth*string
매출인식월. 형식: YYYY-MM
# 04

응답 본문

응답 메시지

NameTypeDescription
settlementTypestring
정산유형
Parameter Name Status
MONTHLY 월 정산 내역
WEEKLY 주 정산 내역
ADDITIONAL 추가 지급
RESERVE 최종액 지급
settlementDatestring
정산(예정)일
revenueRecognitionYearMonthstring
매출인식월
revenueRecognitionDateFromstring
매출인식시작일
revenueRecognitionDateTostring
매출인식종료일
totalSalenumber
총판매액
=판매액+판매배송료-(취소액+취소배송료+할인쿠폰)
serviceFeenumber
판매수수료
=판매수수료+우대수수료 환급액
settlementTargetAmountnumber
정산대상액
=총판매액-판매수수료
settlementAmountnumber
지급액
유형 정책
주정산 정산대상액의 70%
월정산 정산대상액의 100%
lastAmountnumber
최종액 ( 유보성격의 금액 )
주정산 30% 유보금액
pendingReleasedAmountnumber
보류(해제)금액
보류가 해제 되면서 이번 지급에 포함될 금액
sellerDiscountCouponnumber
판매자 할인쿠폰 (즉시할인쿠폰)
downloadableCouponnumber
판매자 할인쿠폰 (다운로드쿠폰)
dedicatedDeliveryAmountnumber
전담택배비
사용안함
sellerServiceFeenumber
판매자서비스이용료(서버이용료)
couranteeFeenumber
쿠런티이용료
couranteeCustomerRewardnumber
쿠런티보상금
deductionAmountnumber
정산차감
debtOfLastWeeknumber
전주채권
전주에 발생한 손실 관련 차감액
finalAmountnumber
최종지급액 or 지급예정액
(최종적으로 셀러에게 입금될 금액)

=지급액+보류(해제)금액
-(전담택배비+판매자서비스이용료+정산차감+전주채권+쿠런티이용료+쿠런티보상금+판매자할인쿠폰+스토어이용료할인금액)
bankAccountHolderstring
예금주
bankNamestring
은행명
bankAccountstring
정산대금 입금 계좌번호
**뒤 4자리 마스킹 처리
statusstring
지급 상태
Parameter Name Status
DONE 지급 완료
SUBJECT 지급 예정
storeFeeDiscountnumber
셀러 스토어 이용료 할인 금액

Response Example

{
 "settlementType": "DAILY",
 "settlementDate": "2019-10-10",
 "revenueRecognitionYearMonth": "2019-10",
 "revenueRecognitionDateFrom": "2019-10-01",
 "revenueRecognitionDateTo": "2019-10-01",
 "totalSale": ***58150,
 "serviceFee": ***8782,
 "settlementTargetAmount": ***39368,
 "settlementAmount": ***39368,
 "lastAmount": 0,
 "pendingReleasedAmount": 0,
 "sellerDiscountCoupon": 0,
 "downloadableCoupon": 0,
 "dedicatedDeliveryAmount": 0,
 "sellerServiceFee": 0,
 "couranteeFee": 0,
 "couranteeCustomerReward": 0,
 "deductionAmount": 0,
 "debtOfLastWeek": 0,
 "finalAmount": ***39368,
 "bankAccountHolder": "*********",
 "bankName": "**",
 "bankAccount": "100560****",
 "status": "DONE",
 "storeFeeDiscount": 0
 }
# 05

에러 코드

HTTP코드메시지
400HTTP_400Bad Request

오류 사양

HTTP유형오류 메시지해결 방법
400400 (요청변수확인)

Invalid revenueRecognitionYearMonth format (yyyy-MM)

매출인식월을 올바른 형식으로 입력했는지 확인합니다.

400400 (요청변수확인)

해당월까지만 조회할 수 있습니다.

매출인식월을 당월 이후로 입력했는지 확인합니다.