v2.payment.get_income_overview
GET /api/v2/payment/get_income_overview
Retrieves a consolidated snapshot of the seller’s income amounts categorized by income status for a specified shop. This API provides a holistic overview similar to Seller Center’s “Income Overview” section, allowing external systems to reflect the same current payout view. Data is dynamically determined based on the shop type (Local or Cross Border) and the income status requested. Historical income results are not retrievable, providing consistent information as Seller Centre.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/payment/get_income_overview
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 |
|---|---|---|---|---|
| income_status | int32 | False | 1 | Status of Seller Income payout (Enum - Desc) Local Shop 1 -Released 2 - Pending CB Shop 0 - To Release 1 - Released 2 - Pending Note: By default, if Income Status was not provided in the request params (non mandatory), API response will return all values for all Income status based on either Local/CB |
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 dùng để theo dõi lỗi. | |
| response | object | ||
| latest_payout_date | string | 2025-08-19 | Ngày chi trả gần nhất cho thu nhập đã giải phóng. Định dạng: YYYY-MM-DD. Chỉ dành cho cửa hàng CN. |
| total_income | object | Object containing total income components. | |
| pending_amount | float | 330598.87 | Total amount pending release (Local: orders before ESCROW_PAID; CB: orders before ESCROW_PAYOUT). <path></path> |
| to_release_amount | float | 330598.87 | Amount queued for release in the next payout cycle (CB only). Not applicable for Local shops. <path></path> |
| released_amount | float | 330598.87 | Total amount successfully released to the seller. <path></path> |