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.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/payment/get_income_overview
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 |
|---|---|---|---|---|
| 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 |
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. | |
| response | object | ||
| latest_payout_date | string | 2025-08-19 | The latest payout date for the released income. Format: YYYY-MM-DD. Only for CN shops. |
| 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> |