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).

Đường dẫn Endpoint

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

Tham số chung

Name	Type	Sample	Description
partner_id	int	1	Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu.
timestamp	timestamp	1610000000	Dùng để chỉ định thời điểm gửi yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	Token dùng để truy cập API, xác định quyền của bạn. Có thể dùng nhiều lần và hết hạn sau 4 giờ.
shop_id	int	600000	Mã định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Chữ ký được tạo từ partner_id, đường dẫn api, timestamp, access_token, shop_id và partner_key qua thuật toán HMAC-SHA256. Chi tiết: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Tham số Request

Name	Type	Required	Sample	Description
date_from	string	True	2025-09-25	Ngày bắt đầu (YYYY-MM-DD) của kỳ tham chiếu thu nhập. Trường này chỉ dùng cho Trạng thái Thu nhập = Released.
date_to	string	True	2025-09-30	Ngày kết thúc (YYYY-MM-DD) của kỳ tham chiếu thu nhập. Phải sau date_from. Trường này chỉ dùng cho Trạng thái Thu nhập = Released.
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

Tham số Response

Name	Type	Sample	Description
error	string		Cho biết loại lỗi nếu xảy ra. Trống nếu không có lỗi.
message	string		Cho biết chi tiết lỗi nếu xảy ra. Trống nếu không có lỗi.
request_id	string		Mã định danh của yêu cầu API để theo dõi lỗi.
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.

}