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.

Overview

Request parameters

Response parameters

Common parameters

Request samples

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/payment/get_income_overview?access_token=access_token&income_status=1&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/payment/get_income_overview?access_token=access_token&income_status=1&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/payment/get_income_overview?access_token=access_token&income_status=1&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' 

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/payment/get_income_overview?access_token=access_token&income_status=1&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload={}
headers = {

}
response = requests.RPCRequest("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
    "error": "",
    "message": "",
    "request_id": "e3e3e7f34151e704736b612a6b9ae101",
    "total_income": {
        "pending_amount": 4010,
        "released_amount": 1545
    }
}

Error example

JSON

{
    "error": "error_param",
    "message": "The income_status provided is invalid or not applicable. Please use one of the supported values: 0 - To Release, 1 - Released, 2 - Pending. Local shops do not have the “To Release” status.",
    "request_id": "e3e3e7f341549a4efbbe99ba66b54501"
}

Errors

Common errors

Update log