v2.payment.get_payout_info

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 · 2026-09-06 12:14:07

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.payment.get_payout_info

This is a new API which applicable for Cross Border (CB) sellers only to get the shop's payout data, will be used for the original API v2.get_payout_details replacement, we provide data such as the payout amount, currency, FX rate, the payout's associated order income and adjustment records etc.

§2 Overview

Overview

Field	Value
Module	Payment
API type	Shop
HTTP method	GET
Path	/api/v2/payment/get_payout_info
Production URL	https://partner.shopeemobile.com/api/v2/payment/get_payout_info
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/payment/get_payout_info
Permission	ERP System; Seller In House System; Accounting And Finance; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
payout_time_from	timestamp	Yes	1643365068	Start time. Maximum time range is 15 days
payout_time_to	timestamp	Yes	1659003469	Payout End time
page_size	int	Yes	10	Number of pages returned max:100
cursor	string	Yes	""	Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.

§4 Response parameters

Response parameters

Name	Type	Sample	Description
message	string		Indicate error details if hit error. Empty if no error happened.
error	string		Indicate error type if hit error. Empty if no error happened.
request_id	string	10fff653c945a390f8e1323c6bdffff4	The identifier for an API request for error tracking.
response	object
response.payout_list	object
response.payout_list.from_currency	string	SGD	The settlement currency of orders.
response.payout_list.payout_currency	string	USD	The actual currency of payout.
response.payout_list.from_amount	float	1769.01	The settlement amount.
response.payout_list.payout_amount	float	1769.01	The actual amount of payout.
response.payout_list.exchange_rate	string	"1"	The exchange rate.
response.payout_list.payout_time	timestamp	1691050374	The time of payout.
response.payout_list.pay_service	string	Payoneer	The service provider of seller. Available value: payoneer, pingpong, lianlian.
response.payout_list.payee_id	string	"279016275538"	Seller's account to receive the payout.
response.payout_list.encrypted_payout_id	string	"16061973102097436445"	payout id used to query API "v2.get_billing_item_info" as request parameters. User can get detailed billing items under current payout
response.more	boolean	false	True or False
response.next_cursor	string	""	used for next batch data query. will return empty when all data been returned

§5 Common parameters

Common 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

§6 Request samples

Request samples

§7 Java

Java

{
    "shop_id": 1002640038,
    "payout_time_from": 1690848000,
    "payout_time_to": 1691971200,
    "page_size": 10,
    "cursor":""
}

§8 Response sample

Response sample

§9 JSON

JSON

{
    "response": {
        "payout_list": [
            {
                "from_currency": "SGD",
                "payout_currency": "SGD",
                "from_amount": 1,
                "payout_amount": 1,
                "exchange_rate": "1",
                "payout_time": 1691638015,
                "pay_service": "",
                "payee_id": "",
                "encrypted_payout_id": "11796795500890875355"
            },
            {
                "from_currency": "SGD",
                "payout_currency": "SGD",
                "from_amount": -594.78,
                "payout_amount": -594.78,
                "exchange_rate": "1",
                "payout_time": 1691637692,
                "pay_service": "",
                "payee_id": "",
                "encrypted_payout_id": "1037637926329180766"
            },
            {
                "from_currency": "SGD",
                "payout_currency": "SGD",
                "from_amount": 594.78,
                "payout_amount": 594.78,
                "exchange_rate": "1",
                "payout_time": 1691637245,
                "pay_service": "",
                "payee_id": "",
                "encrypted_payout_id": "17595368892219955875"
            },
            {
                "from_currency": "SGD",
                "payout_currency": "SGD",
                "from_amount": -1769.01,
                "payout_amount": -1769.01,
                "exchange_rate": "1",
                "payout_time": 1691050374,
                "pay_service": "",
                "payee_id": "",
                "encrypted_payout_id": "16061973102097436445"
            }
        ],
        "more": false,
        "next_cursor": ""
    },
    "error": "",
    "message": "",
    "request_id": "bdb077c90923be4527a374c1e6db2400"
}

§10 Error example

Error example

§11 JSON

JSON

{
    "error": "error_param",
    "message": "payout_time_to is required",
    "request_id": "b387729d0923c1290c32b2ca46978400"
}

§12 Errors

Errors

Error	Description	Solution
add_on.add_on_deal_item_under_btoc	There are B2C items that can't be added into your promotion
error_param	billing_transaction_info_type is required, format should be correct and input within 1-2
error_data	parse data failed
error_data	data not exist
error_param	parameter invalid
error_param	The information you queried is not found.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_shop	shopid is invalid
error_param	request not from gateway
error_param	Invalid or missing cursor parameter. Please enter an empty string i.e. "" for the first request or use the next_cursor value returned from the previous response for subsequent requests.
error_server	Internal server error
error_param	The request body is not a valid json format
error_param	This payment API is only applicable for cross boarder shop
error_param	Invalid or missing page_size parameter , please enter a valid value that is with 1-100, indicating the number of records within a page.
error_param	cursor is required and format should be correct. Please check
common.error_not_found	Unknown error: ***. Something wrong. Please try later.
error_param	page_size is required, format should be correct and input within 1-100
error_param	invalid payout_time format, please check
error_param	invalid time range, please ensure payout_time_to is greater than payout_time_from but within 15 days
error_param	shop_id is required
error_param	payout_time_to is required
error_param	payout_time_to is required
error_param	The selected payout start time is not supported. Please choose a start time no earlier than May 1, 2022.

§13 Common errors

Common errors

Error	Description	Solution
error_auth	partner_id is invalid
error_auth	The App is deleted, and you'll be unable to make any API call.
error_auth	App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_param	There is no partner_id in query.
error_param	Invalid partner_id.
error_param	no timestamp
error_param	Invalid timestamp
error_param	There is no sign in query.
error_sign	Wrong sign.
invalid_partner_id	Invalid partner_id, please have a check.
error_auth	No permission to current api.
error_api_call_restricted	The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspended	The API is offline. Please call v2 API instead.
error_limit	The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limit	Too many requests. You have reached the rate limit. Please try again later.
source_ip_undeclared	Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_param	Permission denied. This API is currently offline or the request path is incorrect.
error_param	Partner_id is invalid, should be an integer between 0 and 4294967295.
error_param	no timestamp.
error_param	Timestamp is invalid, should be an integer between 0 and 4294967295.
error_param	Timestamp is expired.
error_partner_key_expired	Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permission	This app type has no permission to this API.
error_param	There is no access_token in query.
error_auth	Invalid access_token.
error_auth	Invalid partner_id or shopid.
shop_no_linked	Partner and shop has no linked.
shop_banned	The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_token	Invalid access_token, please have a check.
partner_shop_no_link	Invalid partner_id or shop_id, please have a check.
error_ashop_api_permission	The shop is Affiliate shop has no permission to call this API.
error_kyc_auth	No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_auth	System error, please try again later.
error_param	There is no shop_id in query.
error_param	shop_id is invalid, should be an integer between 0 and 4294967295.

§14 Update log

Update log

Date	Change
2024-01-02	New API

这条内容对你有帮助吗？