> ## Documentation Index
> Fetch the complete documentation index at: https://growi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml api-reference/tik-tok-shop-openapi.json GET /tik_tok_shop/finance/withdrawals
openapi: 3.0.3
info:
  title: 'Growi API: TikTok Shop'
  version: 1.0.0
  description: >-
    Generated by scripts/gen_tik_tok_shop.rb from Growi's TikTok Shop route
    table.
servers:
  - url: https://api.growi.io/api/public/v1
security:
  - bearerAuth: []
paths:
  /tik_tok_shop/finance/withdrawals:
    get:
      summary: Withdrawal records
      description: >-
        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.
      parameters:
        - name: types
          in: query
          required: false
          schema:
            type: string
            pattern: >-
              ^(WITHDRAW|SETTLE|TRANSFER|REVERSE)(,(WITHDRAW|SETTLE|TRANSFER|REVERSE))*$
          description: >-
            Comma list of WITHDRAW, SETTLE, TRANSFER, REVERSE. Absent = all four
            (TikTok requires at least one).
        - name: create_time_ge
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 9999999999
          description: Unix seconds, inclusive lower bound on createTime.
        - name: create_time_lt
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 9999999999
          description: Unix seconds, exclusive upper bound. Must be after create_time_ge.
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: Rows per page, 1 to 100. TikTok's default is 20.
        - name: page_token
          in: query
          required: false
          schema:
            type: string
          description: The nextPageToken from the previous page. Omit on the first page.
        - name: organization_id
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Use the TikTok Shop of this child brand (organization id) of your
            API key's organization
      responses:
        '200':
          description: '{ totalCount, withdrawals: [...], nextPageToken }'
          content:
            application/json:
              example:
                totalCount: 14
                withdrawals:
                  - id: '7443000000000000001'
                    type: SETTLE
                    amount: 1234.56
                    currency: USD
                    status: SUCCESS
                    createTime: 1758931200
                nextPageToken: null
        '400':
          description: >-
            Invalid params: an unknown type, a bad window, page_size out of
            range
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '403':
          description: >-
            The shop's TikTok authorization doesn't include this data (`code:
            scope_not_granted`), so the seller has to re-authorize the shop
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '404':
          description: >-
            `organization_id` isn't an active child brand of your organization,
            or the record you asked for doesn't exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '422':
          description: >-
            No TikTok Shop is connected for this organization. A parent
            organization whose shops sit on its child brands has to pass
            `organization_id`. Also returned when the shop isn't connected
            through TikTok's official API (`code: unsupported_on_web_only_shop`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '429':
          description: >-
            Rate limited: one call every 2 seconds and an hourly cap per API
            key. See `Retry-After` and the `X-RateLimit-*` headers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
        '502':
          description: >-
            TikTok refused or failed. `error` is a fixed message and `code`
            names the failure when there is one
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokShopError'
components:
  schemas:
    TikTokShopError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: What went wrong
        code:
          type: string
          description: Machine-readable reason, when there is one
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.