GET Get Statements

Get Statements Shop Required scope: seller.finance.info Retrieves the statements generated for a shop and the key statement information based on a specified date range or their payment status. Use this API to get an overview of your daily statements over a range of time, or to find out which statements have been paid or not. For the detailed transactions, refer to Get Statement Transactions

or Get Order Statement Transactions

. Applicable for all regions' sellers. Only data after 2023-07-01 is available. Version 202309

GET/finance/202309/statements

Request

Header

Properties	Type	Description
content-type Required	string	Allowed type: application/json
x-tts-access-token Required	string	The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

Properties	Type	Description
app_key Required	string	Every single app will have a unique key. Please use the specific key assigned to your app.
statement_time_lt	int	Filter statements to show only those that are generated before the specified date and time. Unix timestamp.Refer to notes in statement_time_ge for more usage information.
payment_status	string	Filter statements based on the payment status.Possible values:- PAID: Payment has been transferred to the seller.- FAILED: Payment transfer failed.- PROCESSING: Payment is currently being processed.Default: All statuses are returned.
page_size	int	The number of results to be returned per page. Default: 20Valid range: [1-100]
page_token	string	An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page.
sort_field Required	string	The returned results will be sorted by the specified field. Only supports statement_time.
sort_order	string	The sort order for the sort_field parameter. Default: ASC Possible values:- ASC: Ascending order- DESC: Descending order
statement_time_ge	int	Filter statements to show only those that are generated on or after the specified date and time. Unix timestamp.Note:statement_time_ge and statement_time_le together constitute the creation time filter condition.- If statement_time_ge is filled but statement_time_lt is empty, statement_time_lt will default to the current time.- If statement_time_lt is filled but statement_time_ge is empty, statement_time_ge will default to the earliest shop time.Example:As statements are generated daily at 00:00 UTC, to retrieve statements for the period from Oct 5 to Oct 10, configure the parameters as follows:- Set statement_time_ge to 00:00 on Oct 6 or any time on Oct 5 (excluding 00:00).- Set statement_time_lt to any time on Oct 11 (excluding 00:00).
sign Required	string	Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp Required	int	Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher Required	string	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

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

Properties	Type	Description
code	int	The success or failure status code returned in API response.
message	string	The success or failure messages returned in API response. Reasons of failure will be described in the message.
request_id	string	Request log
data	object	Specific return information

Example

JSONEnable word wrap

Error Code

View common error codes

| Code | Message | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |

Is this content helpful?Helpful

Not Helpful

PreviousNext