Settlement statements

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

import requests

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

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/statements', 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/statements",
  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/statements"

	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/statements")

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

{
  "statements": [
    {
      "id": "7440000000000000001",
      "statementTime": 1758844800,
      "currency": "USD",
      "settlementAmount": 1234.56,
      "revenueAmount": 1580,
      "feeAmount": -310.44,
      "adjustmentAmount": 0,
      "netSalesAmount": 1580,
      "shippingCostAmount": -35,
      "paymentStatus": "PAID",
      "paymentId": "7440000000000000901",
      "paymentTime": 1758931200
    }
  ],
  "nextPageToken": "b2Zmc2V0PTIw"
}

{
  "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>"
}

Settlement statements

Returns the shop’s daily settlement statements from TikTok. TikTok cuts one statement each day at 00:00 UTC covering the previous day’s settled transactions, with data from 2023-07-01. Each row has id, statementTime, currency, settlementAmount, revenueAmount, feeAmount, adjustmentAmount, netSalesAmount, shippingCostAmount, paymentStatus (PAID, FAILED or PROCESSING), paymentId (null while processing) and paymentTime.

Filter with statement_time_ge (inclusive) and statement_time_lt (exclusive), both Unix seconds, and with payment_status. Results are newest first unless you set sort_order=ASC. page_size is 1 to 100 (TikTok’s default is 20). Pass nextPageToken back as page_token; it is null on the last page. To match a bank deposit, use settlementAmount and paymentId, then open the statement’s transactions. Amounts keep TikTok’s signs. Read live from TikTok on every call.

GET

tik_tok_shop

finance

statements

Settlement statements

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

import requests

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

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/statements', 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/statements",
  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/statements"

	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/statements")

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

{
  "statements": [
    {
      "id": "7440000000000000001",
      "statementTime": 1758844800,
      "currency": "USD",
      "settlementAmount": 1234.56,
      "revenueAmount": 1580,
      "feeAmount": -310.44,
      "adjustmentAmount": 0,
      "netSalesAmount": 1580,
      "shippingCostAmount": -35,
      "paymentStatus": "PAID",
      "paymentId": "7440000000000000901",
      "paymentTime": 1758931200
    }
  ],
  "nextPageToken": "b2Zmc2V0PTIw"
}

{
  "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

statement_time_ge

integer

Unix seconds, inclusive lower bound on statementTime. Absent = the shop's first statement.

Required range: 1 <= x <= 9999999999

statement_time_lt

integer

Unix seconds, exclusive upper bound. Absent = now. Must be after statement_time_ge.

Required range: 1 <= x <= 9999999999

payment_status

enum<string>

Only statements in this payment state. Absent = all.

Available options:

PAID,

FAILED,

PROCESSING

sort_order

enum<string>

default:DESC

DESC (newest first) unless set. TikTok's own default is ASC.

Available options:

ASC,

DESC

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

{ statements: [...], nextPageToken (null on the last page) }

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Settlement statements

Authorizations

Query Parameters

Response