You can see the details of scheduled/finalized settlement based on the month of sales recognition.
Path
GET
/v2/providers/marketplace_openapi/apis/api/v1/settlement-histories
Example Endpoint
https://api-gateway.coupang.com/v2/providers/marketplace_openapi/apis/api/v1/settlement-histories?revenueRecognitionYearMonth=2019-10
Request Parameters
Query String Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| revenueRecognitionYearMonth | O | String |
Month of sales recognition
Format: YYYY-MM
|
||||
Request Example
not require body
Response Message
| Name | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| settlementType | String |
Settlement type
|
||||||||||||||
| settlementDate | String |
(Estimated) settlement date
|
||||||||||||||
| revenueRecognitionYearMonth | String |
Month of sales recognition
|
||||||||||||||
| revenueRecognitionDateFrom | String |
Start date of sales recognition
|
||||||||||||||
| revenueRecognitionDateTo | String |
End date of sales recognition
|
||||||||||||||
| totalSale | Number |
Total amount from sales
=Amount from sales + shipping fee for selling - (amount of cancellation + shipping fee for cancellation + discount coupon)
|
||||||||||||||
| serviceFee | Number |
Take rate
=Take rate + reimbursement for preferential rate
|
||||||||||||||
| settlementTargetAmount | Number |
Amount subject to settlement
=Total amount from sales - take rate
|
||||||||||||||
| settlementAmount | Number |
Settlement amount
|
||||||||||||||
| lastAmount | Number |
Final amount ( amount deferred for payment );
30% of the weekly settlement amount deferred
|
||||||||||||||
| pendingReleasedAmount | Number |
Pending (released) amount;
Amount to be included in the settlement after it is released from pending |
||||||||||||||
| sellerDiscountCoupon | Number |
Seller discount coupon (Instant discount coupon)
|
||||||||||||||
| downloadableCoupon | Number |
Seller discount coupon (Downloadable coupon)
|
||||||||||||||
| dedicatedDeliveryAmount | Number |
Dedicated courier fee;
Not used
|
||||||||||||||
| sellerServiceFee | Number |
Seller service fee (server fee)
|
||||||||||||||
| couranteeFee | Number |
Courantee fee
|
||||||||||||||
| couranteeCustomerReward | Number |
Courantee reward
|
||||||||||||||
| deductionAmount | Number |
Deductibles
|
||||||||||||||
| debtOfLastWeek | Number |
Payables from the past week;
Deduction for the loss incurred in the past week |
||||||||||||||
| finalAmount | Number |
Final amount to be paid or estimated amount to be paid
(Final amount to be paid to the seller) =Amount of settlement to be paid + pending (released) amount - (dedicated courier fee + seller service fee + deductibles + payables from the past week + Courantee fee + Courantee reward + seller discount coupon + store fee discount) |
||||||||||||||
| bankAccountHolder | String |
Bank account holder
|
||||||||||||||
| bankName | String |
Bank name
|
||||||||||||||
| bankAccount | String |
Bank account number to send the settlement amount;
**Last 4 digits masked
|
||||||||||||||
| status | String |
Payment status
|
||||||||||||||
| storeFeeDiscount | Number |
Amount of seller store fee discount
|
||||||||||||||
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
}
]Error Spec
| HTTP Status Code (Error Type) | Error Message | Solution |
|---|---|---|
| 400 (Check Request Parameter) |
Invalid revenueRecognitionYearMonth format (yyyy-MM) |
Make sure that the month of sales recognition is in correct format. |
| 400 (Check Request Parameter) |
You cannot query past this month. |
Make sure that the month of sales recognition is later than this month. |
URL API Name
SETTLEMENT_HISTORIES