v2.payment.get_income_detail

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:14:03

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.payment.get_income_detail

Retrieves detailed order-level income information across various income statuses for a specified time period. This API enables partners to display granular transaction-level income data consistent with Seller Center’s “Income Details” view, segmented by income status and payout stage. The API dynamically adapts data fields based on the seller’s shop type (Local or Cross Border) and the selected income status (e.g., Pending, To Release, Released).

§2 Overview

Overview

Field	Value
Module	Payment
API type	Shop
HTTP method	GET
Path	/api/v2/payment/get_income_detail
Production URL	https://partner.shopeemobile.com/api/v2/payment/get_income_detail
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/payment/get_income_detail
Permission	ERP System; Seller In House System; Accounting And Finance

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
date_from	string	Yes	2025-09-25	Start date (YYYY-MM-DD) of the income reference period. This field is only used for Income Status = Released, the other statuses will display all records currently in that status.; For income Status = Released, For Released → Payout released date: 1. date_to must be later than date_from; 2. date range cannot exceed 14 days; 3. Input must follow valid date format.
date_to	string	Yes	2025-09-30	End date (YYYY-MM-DD) of the income reference period. Must be later than date_from. This field is only used for Income Status = Released, the other statuses will display all records currently in that status.; For income Status = Released, For Released → Payout released date: 1. date_to must be later than date_from; 2. date range cannot exceed 14 days; 3. Input must follow valid date format.
income_status	int32	Yes	1	Status of Seller Income payout (Enum - Desc); Local; 1 -Released; 2 - Pending; CB; 0 - To Release; 1 - Released; 2 - Pending
cursor	string	No	176714986216530	Pagination token for the next set of results. Use an empty string "" for the first request.
page_size	int64	Yes	30	Number of income detail records to retrieve per page

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string		Indicate error type if hit error. Empty if no error happened.
message	string		Indicate error details if hit error. Empty if no error happened.
request_id	string		The identifier for an API request for error tracking.; <path></path><path></path>
income_detail_list	object		List of income detail records returned for the specified time range and status.
income_detail_list.next_page	object		Contains pagination metadata for fetching the next page.
income_detail_list.next_page.cursor	string	176714986216530	Token to retrieve the next page of results. Returns empty if there is no more data.
income_detail_list.next_page.page_size	int32	30	Number of records returned per page.
income_detail_list.income_detail_list_item	object		List of income detail objects
income_detail_list.income_detail_list_item.payment_method	string	ATM Payment	Payment channel or method used for the order
income_detail_list.income_detail_list_item.order_sn	string	2510102F4S56JW	Unique order serial number associated with the income record.
income_detail_list.income_detail_list_item.description	string	Order Income	Type of income or billing item — e.g., Order Income, Adjustment etc
income_detail_list.income_detail_list_item.status	string	The payment has been successfully transferred.	Status description of the order income or payout.
income_detail_list.income_detail_list_item.currency	string	Thai Baht	Currency in which the income was transacted.
income_detail_list.income_detail_list_item.estimated_escrow_amount	float	4709353.87	Estimated escrow amount pending release for the order.
income_detail_list.income_detail_list_item.estimated_payout_time	int64	1755584911	Estimated payout time (Unix timestamp). Applicable for Pending/To Release status.
income_detail_list.income_detail_list_item.to_release_amount	float	4709353.87	Amount that is queued for release to seller (Cross Border only).
income_detail_list.income_detail_list_item.creation_date	int64	1694753463	Order creation timestamp (Unix format).
income_detail_list.income_detail_list_item.released_amount	float	4709353.87	Amount successfully released to the seller.
income_detail_list.income_detail_list_item.actual_payout_time	int64	1755584911	Actual payout time (Unix timestamp) when funds were transferred.

§5 Common parameters

Common parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

§6 Request samples

Request samples

§7 Java

Java

{
    "shop_id": 406906,
    "income_status": 1,
    "date_from": "2025-08-08",
    "date_to": "2025-08-20",
    "cursor": "",
    "limit": 5
    }
}

§8 Response sample

Response sample

§9 JSON

JSON

{
    "error": "",
    "income_detail_list": {
        "list": [
            {
                "actual_payout_time": 1762532978,
                "currency": "IDR",
                "order_sn": "251101MPY3RDD3",
                "payment_method": "Cash on Delivery",
                "released_amount": 19246,
                "status": "Dana telah dilepaskan"
            },
            {
                "actual_payout_time": 1762532566,
                "currency": "IDR",
                "order_sn": "251102PVD4RMNF",
                "payment_method": "Cash on Delivery",
                "released_amount": 19125,
                "status": "Dana telah dilepaskan"
            },
            {
                "actual_payout_time": 1762530072,
                "currency": "IDR",
                "order_sn": "251101KV5GUESA",
                "payment_method": "ShopeePay Balance",
                "released_amount": 21455,
                "status": "Dana telah dilepaskan"
            },
            {
                "actual_payout_time": 1762529568,
                "currency": "IDR",
                "order_sn": "251101MMCCDJ3N",
                "payment_method": "Cash on Delivery",
                "released_amount": 19246,
                "status": "Dana telah dilepaskan"
            },
            {
                "actual_payout_time": 1762529117,
                "currency": "IDR",
                "order_sn": "251103RVWNM3HC",
                "payment_method": "Cash on Delivery",
                "released_amount": 39743,
                "status": "Dana telah dilepaskan"
            },
            {
                "actual_payout_time": 1762528957,
                "currency": "IDR",
                "order_sn": "251103RBJT4SNQ",
                "payment_method": "Cash on Delivery",
                "released_amount": 31619,
                "status": "Dana telah dilepaskan"
            },
            {
                "actual_payout_time": 1762528198,
                "currency": "IDR",
                "order_sn": "251028ABKCKESK",
                "payment_method": "Cash on Delivery",
                "released_amount": 40993,
                "status": "Dana telah dilepaskan"
            },
            {
                "actual_payout_time": 1762527039,
                "currency": "IDR",
                "order_sn": "2510251MRCQ5NM",
                "payment_method": "Cash on Delivery",
                "released_amount": 21472,
                "status": "Dana telah dilepaskan"
            },
            {
                "actual_payout_time": 1762526637,
                "currency": "IDR",
                "order_sn": "251103SE7GQU1Y",
                "payment_method": "Online Payment",
                "released_amount": 224214,
                "status": "Dana telah dilepaskan"
            },
            {
                "actual_payout_time": 1762524417,
                "currency": "IDR",
                "order_sn": "251102PTG2QQNT",
                "payment_method": "Cash on Delivery",
                "released_amount": 19246,
                "status": "Dana telah dilepaskan"
            }
        ],
        "next_page": {
            "cursor": "216223606250140",
            "page_size": 10
        }
    },
    "message": "",
    "request_id": "956651be4362b78fb565545dcc83a400"
}

§10 Error example

Error example

§11 JSON

JSON

{
    "error": "error_param",
    "message": "release_time_from and/or release_time_to parameter is missing or invalid. Please provide both a valid start date and end date to query, where the start date cannot be later than the end date, and the date range must not exceed 14 days.",
    "request_id": "e3e3e7f341549a4efbbe99ba66b54501"
}

§12 Errors

Errors

Error	Description	Solution
error_param	parameter invalid
error_param	Invalid Time Range: Only records from the past 5 years are supported for the TW region.
error_param	release_time_from and/or release_time_to parameter is missing or invalid. Please provide both a valid start date and end date to query, where the start date cannot be later than the end date, and the date range must not exceed 14 days.
error_shop	shopid is invalid
error_param	Access blocked for Mart shops, please retrieve income details using Outlet Shop ID instead.
error_user_refresh_token	Your refresh token is error, please check refresh token or user_id.

§13 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_auth	Invalid partner_id or shopid.
shop_no_linked	Partner and shop has no linked.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
partner_shop_no_link	Invalid partner_id or shop_id, please have a check.
error_ashop_api_permission	The shop is Affiliate shop has no permission to call this API.
error_kyc_auth	No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_auth	System error, please try again later.
error_param	There is no shop_id in query.
error_param	shop_id is invalid, should be an integer between 0 and 4294967295.

§14 Update log

Update log

Date	Change
2025-10-31	-
2025-10-21	Update to add request and response example
2025-10-14	New API

这条内容对你有帮助吗？