Withdrawal records

curl --request GET \
  --url https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "totalCount": 14,
  "withdrawals": [
    {
      "id": "7443000000000000001",
      "type": "SETTLE",
      "amount": 1234.56,
      "currency": "USD",
      "status": "SUCCESS",
      "createTime": 1758931200
    }
  ],
  "nextPageToken": null
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Withdrawal records

Lists money moving in and out of the shop’s TikTok balance. type is WITHDRAW (the seller withdrew to a bank card), SETTLE (TikTok settled to the seller), TRANSFER (a platform subsidy or deduction) or REVERSE (a withdrawal failed on a bad bank card). Each row has id, type, amount, currency, status (PROCESSING, SUCCESS or FAILED) and createTime. No bank account data is returned.

Pass types as a comma-separated list to filter (default: all four). create_time_ge (inclusive) and create_time_lt (exclusive) take Unix seconds. page_size is 1 to 100; pass nextPageToken back as page_token. Read live from TikTok.

GET

tik_tok_shop

finance

withdrawals

Withdrawal records

curl --request GET \
  --url https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tik_tok_shop/finance/withdrawals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "totalCount": 14,
  "withdrawals": [
    {
      "id": "7443000000000000001",
      "type": "SETTLE",
      "amount": 1234.56,
      "currency": "USD",
      "status": "SUCCESS",
      "createTime": 1758931200
    }
  ],
  "nextPageToken": null
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

types

string

Comma list of WITHDRAW, SETTLE, TRANSFER, REVERSE. Absent = all four (TikTok requires at least one).

create_time_ge

integer

Unix seconds, inclusive lower bound on createTime.

Required range: 1 <= x <= 9999999999

create_time_lt

integer

Unix seconds, exclusive upper bound. Must be after create_time_ge.

Required range: 1 <= x <= 9999999999

page_size

integer

Rows per page, 1 to 100. TikTok's default is 20.

Required range: 1 <= x <= 100

page_token

string

The nextPageToken from the previous page. Omit on the first page.

organization_id

integer

Use the TikTok Shop of this child brand (organization id) of your API key's organization

Response

{ totalCount, withdrawals: [...], nextPageToken }

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Withdrawal records

Authorizations

Query Parameters

Response