v2.payment.get_escrow_list

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.payment.get_escrow_list

Use this API to fetch the accounting list of order.

§2 Overview

Overview

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

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
release_time_from	timestamp	Yes	1651680000	Query start time
release_time_to	timestamp	Yes	1651939200	Query end time
page_size	int32	No	40	Number of pages returned max:100 default:40
page_no	int32	No	1	The page number min:1 default:1

§4 Response parameters

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	8d7de8c04b4cd5f3df9e4aa98c2d87d1	The identifier for an API request for error tracking.
response	object		The business content of the response
response.escrow_list	object[]		The list of escrow order sn.
response.escrow_list.order_sn	string	220415N6SB140P	Shopee's unique identifier for an order.
response.escrow_list.payout_amount	float	5733.04	The settlement amount
response.escrow_list.escrow_release_time	timestamp	1651849648	The release time
response.more	boolean	true	This is to indicate whether the escrow list is more than one page. If this value is true, you may want to continue to check next page to retrieve escrow orders.

§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

{
    "release_time_from": "1651680000",
    "release_time_to": "1651939200",
    "page_size": 40,
    "page_no": 1
}

§8 Response sample

Response sample

§9 JSON

JSON

{
    "request_id": "8d7de8c04b4cd5f3df9e4aa98c2d87d1",
    "error": "",
    "message": "",
    "response": {
        "more": true,
        "escrow_list": [
            {
                "order_sn": "220415N6SB140P",
                "payout_amount": 57334,
                "escrow_release_time": 1651849648
            },
            {
                "order_sn": "220415M9J6GHBP",
                "payout_amount": 5930,
                "escrow_release_time": 1651849648
            },
            {
                "order_sn": "220415K6R91FDM",
                "payout_amount": 5241,
                "escrow_release_time": 1651849648
            },
            {
                "order_sn": "220415MHVS4FC5",
                "payout_amount": 21221,
                "escrow_release_time": 1651849648
            },
            {
                "order_sn": "220415MD350XCE",
                "payout_amount": 12028,
                "escrow_release_time": 1651849648
            }
        ]
    }
}

§10 Error example

Error example

§11 JSON

JSON

{
    "error": "error_param",
    "message": "release_time_to: Invalid type. Expected: integer, given: string",
    "request_id": "89fa9542fe619a6f8978d63268603914"
}

§12 Errors

Errors

Error	Description	Solution
error_param	shop_id is required
error_network	Inner http call failed
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
get_item_error_server	Get item failed.
income_error_server	Get escrow income failed.
decoded_failed_error	The escrow item extinfo decoded failed.
income_not_found	The escrow income not found.
order_error_server	The escrow order extinfo decoded failed.
order_not_found	Order SN provided is invalid or does not belong to you. Please enter a valid Order SN.
order_shopid_invalid	The escrow order's shopid is invalid.
return_info_error_server	Get return or refund info failed.
error_server	Internal server error
error_param	The request body is not a valid json format
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	Invalid page_size parameter. Please provide a valid value between 1 and 100. If left empty, the default value of 40 will be applied.
error_param	release_time_from and/or release_time_to parameter is missing or invalid. Please provide both a valid start date, and end date to query.
error_param	release_time_from and/or release_time_to parameter is invalid. Please provide both a valid start date, and end date to query where start date cannot be later than the end date.
error_param	release_time_from and/or release_time_to parameter is missing or invalid. Please provide both a valid start date, and end date to query.
internal_error_server	The inner server err when warp http req.
error_param	shop_id parameter is missing or invalid. Please include a valid shop_id in the request to retrieve escrow records.
shopid_invalid	Shopid is invalid.
userid_invalid	Userid is invalid.

§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
2025-09-08	select type for some parameters

这条内容对你有帮助吗？