v2.payment.get_income_detail

GET /api/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).

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/payment/get_income_detail

Common Request 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

Request Parameters

Name	Type	Required	Sample	Description
date_from	string	True	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	True	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	True	1	Status of Seller Income payout (Enum - Desc) Local 1 -Released 2 - Pending CB 0 - To Release 1 - Released 2 - Pending
cursor	string	False	176714986216530	Pagination token for the next set of results. Use an empty string "" for the first request.
page_size	int64	True	30	Number of income detail records to retrieve per page

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

}