Skip to main content

GET Get Payments

Get Payments Shop Required scope: seller.finance.info This API is currently unavailable to SEA markets. Retrieves records of automated payments for a shop based on a specified date range. Use the returned list to verify and reconcile payments with the transactions in the seller's bank account. Version 202309

GET/finance/202309/payments

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
create_time_ltintFilter payments to show only those that occurred before the specified date and time. Unix timestamp.Refer to notes in create_time_ge for more usage information.
page_sizeintThe number of results to be returned per page. Default: 20Valid range: [1-100]
page_tokenstringAn 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 RequiredstringThe returned results will be sorted by the specified field. Only supports create_time.
sort_orderstringThe sort order for the sort_field parameter. Default: ASC Possible values:- ASC: Ascending order- DESC: Descending order
create_time_geintFilter payments to show only those that occurred on or after the specified date and time. Unix timestamp.Note:create_time_ge and create_time_lt together constitute the creation time filter condition.- If create_time_ge is filled but create_time_lt is empty, create_time_lt will default to the current time.- If create_time_lt is filled but create_time_ge is empty, create_time_ge will default to the earliest shop time.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse 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

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific 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