總覽
交易 API 可讓您取得與帳戶相關的完整財務交易紀錄,涵蓋購買、存款、提款、轉帳、帳單繳費及所有其他財務活動。 端點類型:GraphQL Query驗證方式:必要(JWT Bearer Token)
所需權限範圍:
LIST_PAYMENT 與 LIST_PURCHASES速率限制:適用標準 GraphQL 速率限制
快速開始
基本查詢
查詢結構
參數
回應結構
TransactionConnection
篩選選項
TransactionFilterInput
篩選欄位詳情
紀錄與狀態篩選
recordId
類型:[UUID]說明:依特定交易紀錄 ID 篩選。 範例:
status
類型:[TransactionStatus]說明:依交易狀態篩選。 選項:
PENDING- 交易處理中SETTLED- 交易已成功完成
金額篩選
amount, amountGte, amountLte
類型:Float說明:依確切金額或美元金額範圍篩選。
amount- 精確金額比對amountGte- 最小金額(大於或等於)amountLte- 最大金額(小於或等於)
finalAmount, finalAmountGte, finalAmountLte
類型:Float說明:依最終金額篩選(金額 + 手續費)。 範例:
現金回饋篩選
cashbackAmount, cashbackAmountGte, cashbackAmountLte
類型:Float說明:依獲得的現金回饋金額篩選。 範例:
cashbackPercentage, cashbackPercentageGte, cashbackPercentageLte
類型:Float說明:依現金回饋比例篩選。 範例:
手續費篩選
feeAmount, feeAmountGte, feeAmountLte
類型:Float說明:依交易手續費金額篩選。 範例:
日期篩選
createdGte, createdLte
類型:DateTime格式:ISO 8601(例如:
2025-01-01T00:00:00Z)說明:依交易建立日期範圍篩選。 範例:
updatedGte, updatedLte
類型:DateTime說明:依交易最後更新日期範圍篩選。
商家篩選
merchantId
類型:[UUID]說明:依特定商家 ID 篩選。 範例:
merchant
類型:[String]說明:依商家名稱篩選(比對 destination 欄位)。 範例:
交易屬性
transactionType
類型:[String]說明:依特定交易類型篩選。 常見值:
Add Money- 存款Gift Card Purchase- 禮品卡購買Transfer - In- 轉入Transfer - Out- 轉出Virtual Card Purchase- 虛擬卡購買Withdrawal
範例:
channel
類型:[String!]說明:依平台管道篩選。 常見值:
WEB- 網頁瀏覽器MOBILE- 行動應用程式API- API 請求
category
類型:[String]說明:依交易類別篩選。 範例:
虛擬卡篩選
virtualCardProgram
類型:[String]說明:依虛擬卡方案/發卡機構篩選。 範例:
virtualCard
類型:[UUID]說明:依特定虛擬卡 ID 篩選。 範例:
其他篩選
fundingSource
類型:[String]說明:搜尋資金來源名稱(比對來源或目的地欄位的部分內容)。 範例:
referenceId
類型:String說明:依外部參照 ID 篩選(例如:購買顯示 ID)。 範例:
liabilityId
類型:UUID說明:依負債 ID 篩選(用於帳單繳費)。
分頁
OffsetInput
範例 - 第 1 頁:
Transaction 型別
欄位說明
核心交易欄位
財務詳情
餘額快照
重要:所有餘額欄位顯示的皆為此交易套用之後的餘額。交易詳情
商家資訊
虛擬卡資訊
貨幣換算
中繼資料
範例
範例 1:基本交易清單
查詢:範例 2:依日期範圍篩選
查詢:範例 3:僅購買項目(含餘額)
查詢:範例 4:高現金回饋交易
查詢:範例 5:金額範圍篩選
查詢:範例 6:虛擬卡交易
查詢:範例 7:分頁範例
查詢 - 取得第一頁並檢查是否還有更多:錯誤處理
常見錯誤
缺少或無效的權杖
權限不足
無效的篩選參數
超出速率限制
errors 陣列。請參閱速率限制以了解封鎖時間。
最佳實務
1. 有效使用分頁
務必檢查hasNextPage 以判斷是否還有更多結果:
2. 僅請求所需欄位
只指定您需要的欄位,以縮小回應大小:3. 針對歷史查詢使用日期篩選
查詢較舊的交易時,請務必使用日期篩選:4. 快取已結清的交易
status: SETTLED 的交易為不可變更,可以快取:
5. 有效組合篩選條件
在套用其他篩選條件前,先使用範圍篩選縮小結果:速率限制
此查詢與 GraphQL API 共用相同的限制。詳細數字及請求遭拒時的回應內容請參閱速率限制。程式碼範例
JavaScript/TypeScript
Python
cURL
常見問題
問:一次請求最多可以取得多少筆交易?
答:每次請求最多可取得 20 筆交易。請使用hasNextPage 欄位來實作分頁。
問:交易紀錄可以回溯多久?
答:自帳戶建立以來的所有交易皆可無限期查詢。問:是否包含處理中的交易?
答:是,處理中的交易預設會包含在內。若要排除,請使用status: [SETTLED] 篩選。
問:時間戳記使用什麼時區?
答:所有時間戳記皆為 UTC(ISO 8601 格式)。問:我需要哪些權限範圍?
答:您需要同時具備LIST_PAYMENT 與 LIST_PURCHASES 這兩個權限範圍。
問:我可以在帳戶內依使用者 ID 篩選嗎?
答:不行,此 API 一律回傳您帳戶的所有交易,並不支援使用者層級的篩選。問:amount 與 finalAmount 篩選有什麼差異?
答:
amount篩選基礎交易金額finalAmount篩選金額 + 手續費(向使用者收取的總額)
問:如何依日期範圍篩選?
答:使用createdGte 與 createdLte 篩選建立日期:
支援
- API 狀態:https://status.fluz.app
- 開發者入口網站:https://developers.fluz.app
- 支援信箱:api-support@fluz.app
- Slack 社群:https://fluz-dev.slack.com
變更紀錄
v1.0.0(分支:13-fluz-15659-add-transactions-query-and-webhook-to-api)
- 初次發布交易查詢 API
- 支援完整的篩選功能(15+ 種篩選類型)
- 使用
TransactionConnection回應型別進行分頁 - 交易紀錄包含餘額快照
- 需要
LIST_PAYMENT與LIST_PURCHASES權限範圍 - 僅提供帳戶層級的交易存取權限
**需要協助?**請透過 api-support@fluz.app 聯絡我們的開發者支援團隊,或造訪我們的開發者入口網站。