跳轉到主要內容
整個 API 的清單操作使用偏移量輸入進行分頁,並回傳 connection 風格的物件。根據介面不同,存在兩種頁面大小規則。

請求結構

在操作的 paginate 參數傳入偏移量輸入:

回應結構

分頁查詢會回傳一個包含項目與分頁中繼資料的 connection 物件——例如 TransactionConnection:
  • 項目列表(例如 transactions)
  • totalCount — 符合篩選條件的項目總數
  • hasNextPage — 是否還有更多結果可用
其他 connection 類型遵循相同模式:UserCashBalanceConnection、DeclinedTransactionConnection、以及 PlaidBankTransactionPage。

走訪完整結果集

當 hasNextPage 為 true 時,每次將 offset 增加 limit:
  1. 請求 { limit: 20, offset: 0 }。
  2. 若 hasNextPage 為 true,則請求 { limit: 20, offset: 20 },接著是 40,以此類推。
  3. 當 hasNextPage 為 false 時停止。
如果在分頁過程中建立了新紀錄,結果可能會在頁面之間移動——交易清單以最新在前排序。針對大型匯出,請以固定的日期範圍進行篩選,以確保在走訪期間基礎集合保持穩定。