Get Seller Financial Transactions

GET

/finance/202309/withdrawals

Retrieves seller financial transaction records within an optional creation-time range, filtered by the required transaction types.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

create_time_lt

integer format: int64

Unix timestamp representing the end of transactions time range one wants to request

types

required

Array<string>

Allowed values: WITHDRAW SETTLE TRANSFER REVERSE PAYMENT REFUND

The transaction types to return. Possible values:

• WITHDRAW: The seller withdraws the settlement amount to a bank card.
• SETTLE: The platform settles the amount to the seller.
• TRANSFER: A platform subsidy or deduction due to platform policies.
• REVERSE: A withdrawal failure caused by incorrect bank card information.
• PAYMENT: A payment transaction.
• REFUND: A refund transaction.

page_size

integer format: int64

The default is 20, it must be positive integer,the range is 1-100

page_token

string

The next_page_token returned by the previous response. Omit this parameter when requesting the first page. When paginating, specify create_time_ge and create_time_lt in the first request, then reuse the same types, create_time_ge, and create_time_lt values for every page.

create_time_ge

integer format: int64

Unix timestamp representing the start of transactions time range one wants to request

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

next_page_token

Cursor used for searching for more information

string

total_count

The total num of the withdraws

integer format: int64

withdrawals

The list of transaction records matching the request filters.

Array<object>

object

id

A unique transaction ID generated by TikTok Shop.

string

type

The transaction type. Possible values:

• WITHDRAW: The seller withdraws the settlement amount to a bank card.
• SETTLE: The platform settles the amount to the seller.
• TRANSFER: A platform subsidy or deduction due to platform policies.
• REVERSE: A withdrawal failure caused by incorrect bank card information.
• POLICY_VIOLATION_DEDUCTION: A deduction for a policy violation.
• REWARD: A reward transaction.
• PAYMENT: A payment transaction.
• REFUND: A refund transaction.
• UNKNOWN: An unrecognized transaction type.

string

Allowed values: WITHDRAW SETTLE TRANSFER REVERSE POLICY_VIOLATION_DEDUCTION REWARD PAYMENT REFUND UNKNOWN

amount

The transaction amount, in the currency specified by currency.

string

currency

The three-letter ISO 4217 currency code for the transaction amount.

string

status

The processing status of the transaction. Possible values:

• SUCCESS: The transaction completed successfully. For a WITHDRAW transaction, this means that the withdrawal has been transferred to the seller.
• INIT: The withdrawal was initialized. This status applies only to WITHDRAW transactions.
• ORDERED: The transaction order was created.
• PROCESSING: The withdrawal is being processed.
• RECEIVED: The withdrawal was received.
• PROCESSED: The payout completed successfully.
• FAILED: The payout failed.
• REVERSED: The transaction was refunded.
• EXCEPTION: The transaction was partially refunded.
• CLOSED: The transaction was closed.
• UNKNOWN: The status could not be mapped.

string

Allowed values: SUCCESS INIT ORDERED PROCESSING RECEIVED PROCESSED FAILED REVERSED EXCEPTION CLOSED UNKNOWN

create_time

The transaction creation time, expressed as a Unix timestamp in seconds.

integer format: int64

Example

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