快工助手跨境电商知识与商机助手
快工云仓服务介绍

For All Markets : Get Payments API — Migrate from 202309 to 202605

TikTok Shop 官方资料 · TikTok Shop Partner Center 开发者文档 · 适合开发者

stable本次发布有变化全部展示

来自 TikTok Shop 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存，可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
TikTok Shop / profile.tiktok.docs_api
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/tiktok_shopaudience/developercategory/api_doctopic/compliancetopic/developer

资料正文

§1 For All Markets : Get Payments API — Migrate from 202309 to 202605

#

§2 1. Summary

1. Summary

The Get Payments API retrieves records of automated payments for a shop based on a specified date range, allowing sellers to verify and reconcile payments against the transactions in their bank account. A new version 202605 has been released. To keep integrations on a single supported version and to remove a deprecated response field, version 202309 will be sunset on <span style="color: #D83931"><strong>2026-08-15</strong></span>. All ISVs must migrate to 202605 by this date. Key Deadline — Sunset Date: 2026-08-15. Version 202309 of the Get Payments API will be sunset on 2026-08-15. All ISVs must complete migration to 202605 on or before this date. After 2026-08-15, calls to GET /finance/202309/payments will no longer be supported.

#

§3 2. Key Change Summary

Compared with 202309, version 202605 removes the reserve_amount field from each object in the payments[] list. All other request parameters and response fields remain identical. The only change is the endpoint version and the removal of reserve_amount.

#

§4 3. Version Comparison

#

§5 3.1 Endpoint

3.1 Endpoint

202309 (to be sunset)202605 (target)
Method & PathGET /finance/202309/paymentsGET /finance/202605/payments
Required scopeseller.finance.infoseller.finance.info (unchanged)
Request parametersapp_key, sign, timestamp, shop_cipher, sort_field, create_time_ge, create_time_lt, page_size, page_token, sort_orderIdentical to 202309 (no change)
#

§6 3.2 Response field comparison (payments[] object)

3.2 Response field comparison (payments[] object)

Field202309202605Note
create_timeYesYesUnchanged
idYesYesUnchanged
statusYesYesUnchanged
amount (value, currency)YesYesUnchanged
settlement_amount (value, currency)YesYesUnchanged
reserve_amount (value, currency)YesNo<span style="color: #D83931"><strong>Removed in 202605</strong></span>
payment_amount_before_exchange (value, currency)YesYesUnchanged
exchange_rateYesYesUnchanged
paid_timeYesYesUnchanged
bank_accountYesYesUnchanged

About reserve_amount: In 202309 this object represented "the reserved amount before currency exchange" (with value and currency sub-fields). It is no longer returned in 202605. ISVs that read, store, display, or reconcile against reserve_amount must remove this dependency before migrating.

#

§7 4. Impact & Affected Parties

4. Impact & Affected Parties

  • Who is affected: All ISVs / developers currently calling GET /finance/202309/payments.
  • Markets: All markets where the API is available.
  • Functional impact: After migration, the reserve_amount field will no longer be available in the response. Any reconciliation logic, data storage, or UI that depends on reserve_amount must be updated. All other fields are returned unchanged.
#

§8 5. Required Actions for ISVs

  1. Switch the endpoint from GET /finance/202309/payments to GET /finance/202605/payments.
  2. Remove any dependency on the reserve_amount field (parsing, storage, display, reconciliation logic).
  3. Keep all request parameters as-is — no parameter changes are required.
#