GET Get Withdrawals

Get Withdrawals Shop Required scope: seller.finance.info Get the list of the withdrawal records (when Seller's withdraw money from TikTokShop) based on the specified date range. Version 202309

GET/finance/202309/withdrawals

Request

Header

Properties	Type	Description
content-type Required	string	Allowed type: application/json
x-tts-access-token Required	string	The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

Properties	Type	Description
app_key Required	string	Every single app will have a unique key. Please use the specific key assigned to your app.
create_time_lt	int	Unix timestamp representing the end of transactions time range one wants to request
types Required	[]string	The type of transaction.Possible values:- WITHDRAW：The action of the seller to receive the settlement amount to the bank card through the action of withdrawal- SETTLE：The platform settles the amount to the seller- TRANSFER：Platform subsidies or deductions due to platform policies- REVERSE：Withdrawal failure due to incorrect bank card
page_size	int	The default is 20, it must be positive integer,the range is 1-100
page_token	string	The next page token
create_time_ge	int	Unix timestamp representing the start of transactions time range one wants to request
sign Required	string	Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp Required	int	Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher Required	string	Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

Properties	Type	Description
code	int	The success or failure status code returned in API response.
message	string	The success or failure messages returned in API response. Reasons of failure will be described in the message.
request_id	string	Request log
data	object	Specific return information

Example

JSONEnable word wrap

Error Code

View common error codes

| Code | Message | | --- | --- | | 22005007 | given merchant does not exist | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |

Is this content helpful?Helpful

Not Helpful

PreviousNext