stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /finance/202309/withdrawals
#§2 Method: [GET]
#§3 Function Description
Get the list of the withdrawal records (when Seller's withdraw money from TikTokShop) based on the specified date range.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | 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 | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| create_time_lt | int | N | 1623812664 | Unix timestamp representing the end of transactions time range one wants to request |
| types | []string | Y | WITHDRAW,SETTLE | 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 |N |20 |The default is 20, it must be positive integer,the range is 1-100 | page_token |string |N |6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA+7D1ud64MPNz5OaT |The next page token | create_time_ge |int |N |1623812664 |Unix timestamp representing the start of transactions time range one wants to request | sign |string |Y |5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c |Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. | timestamp |int |Y |1623812664 |Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/finance/202309/withdrawals?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&create_time_lt=1623812664&types=WITHDRAW,SETTLE&page_size=20&page_token=6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA+7D1ud64MPNz5OaT&create_time_ge=1623812664
§7 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^next_page_token | string | 6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA+7D1ud64MPNz5OaT | Cursor used for searching for more information |
| ^total_count | int | 1 | The total num of the withdraws |
| ^withdrawals | []object | Withdraw list | |
| ^^id | string | EFASDFSAFDA23432DFAFDSA | A unique transaction id generated by TTS for the withdrawal. |
| ^^type | string | WITHDRAW | 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 | |||
| ^^amount | string | 100 | Withdraw amount |
| ^^currency | string | IDR | The three-digit currency code in ISO 4217 format. |
| ^^status | string | PROCESSING | The processing status of the withdrawal indicates whether the withdrawal is transferred. Possible values: |
- PROCESSING：the withdrawal is currently processing. If the withdrawal is successful, the status will transition to PAID. If not, it will be FAILED.
- SUCCESS：the withdrawal has been transferred to the Seller
- FAILED：the withdrawal failed | ^^create_time |int |1623812664 |Withdraw create time |
§8 Response Sample
{"code":0,"data":{"next_page_token":"6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA+7D1ud64MPNz5OaT","total_count":1,"withdrawals":[{"id":"EFASDFSAFDA23432DFAFDSA","type":"WITHDRAW","amount":"100","currency":"IDR","status":"PROCESSING","create_time":1623812664}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§9 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| 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. |