Overview
The Transactions API allows you to retrieve a comprehensive history of all financial transactions associated with your account. This includes purchases, deposits, withdrawals, transfers, bill payments, and all other financial activities. Endpoint Type: GraphQL QueryAuthentication: Required (JWT Bearer Token)
Required Scopes:
LIST_PAYMENT AND LIST_PURCHASESRate Limit: Standard GraphQL rate limits apply
Quick Start
Basic Query
Query Structure
Parameters
Response Structure
TransactionConnection
Filter Options
TransactionFilterInput
Filter Field Details
Record & Status Filters
recordId
Type: [UUID]Description: Filter by specific transaction record IDs. Example:
status
Type: [TransactionStatus]Description: Filter by transaction status. Options:
PENDING- Transaction is being processedSETTLED- Transaction completed successfully
Amount Filters
amount, amountGte, amountLte
Type: FloatDescription: Filter by exact amount or amount range in USD.
amount- Exact amount matchamountGte- Minimum amount (greater than or equal)amountLte- Maximum amount (less than or equal)
finalAmount, finalAmountGte, finalAmountLte
Type: FloatDescription: Filter by final amount (amount + fees). Example:
Cashback Filters
cashbackAmount, cashbackAmountGte, cashbackAmountLte
Type: FloatDescription: Filter by cashback amount earned. Example:
cashbackPercentage, cashbackPercentageGte, cashbackPercentageLte
Type: FloatDescription: Filter by cashback rate percentage. Example:
Fee Filters
feeAmount, feeAmountGte, feeAmountLte
Type: FloatDescription: Filter by transaction fee amount. Example:
Date Filters
createdGte, createdLte
Type: DateTimeFormat: ISO 8601 (e.g.,
2025-01-01T00:00:00Z)Description: Filter by transaction creation date range. Example:
updatedGte, updatedLte
Type: DateTimeDescription: Filter by transaction last update date range.
Merchant Filters
merchantId
Type: [UUID]Description: Filter by specific merchant IDs. Example:
merchant
Type: [String]Description: Filter by merchant names (matches against destination field). Example:
Transaction Properties
transactionType
Type: [String]Description: Filter by specific transaction types. Common Values:
Add Money- DepositsGift Card Purchase- Gift card purchasesTransfer - In- Incoming transfersTransfer - Out- Outgoing transfersVirtual Card Purchase- Virtual card purchasesWithdrawal
Example:
channel
Type: [String!]Description: Filter by platform channel. Common Values:
WEB- Web browserMOBILE- Mobile appAPI- API requests
category
Type: [String]Description: Filter by transaction category. Example:
Virtual Card Filters
virtualCardProgram
Type: [String]Description: Filter by virtual card program/issuer. Example:
virtualCard
Type: [UUID]Description: Filter by specific virtual card IDs. Example:
Other Filters
fundingSource
Type: [String]Description: Search for funding source names (partial match on source or destination). Example:
referenceId
Type: StringDescription: Filter by external reference ID (e.g., purchase display ID). Example:
liabilityId
Type: UUIDDescription: Filter by liability ID (for bill payments).
Pagination
OffsetInput
Example - Page 1:
Transaction Type
Field Descriptions
Core Transaction Fields
Financial Details
Balance Snapshots
Important: All balance fields show the balance after this transaction was applied.Transaction Details
Merchant Information
Virtual Card Information
Currency Conversion
Metadata
Examples
Example 1: Basic Transaction List
Query:Example 2: Filtered by Date Range
Query:Example 3: Purchases Only with Balances
Query:Example 4: High-Cashback Transactions
Query:Example 5: Amount Range Filter
Query:Example 6: Virtual Card Transactions
Query:Example 7: Pagination Example
Query - Get first page and check for more:Error Handling
Common Errors
Missing or Invalid Token
Insufficient Permissions
Invalid Filter Parameters
Rate Limit Exceeded
errors array. See Rate limits for how long the block lasts.
Best Practices
1. Use Pagination Effectively
Always checkhasNextPage to determine if more results exist:
2. Request Only Needed Fields
Specify only the fields you need to reduce response size:3. Use Date Filters for Historical Queries
When querying older transactions, always use date filters:4. Cache Settled Transactions
Transactions withstatus: SETTLED are immutable and can be cached:
5. Combine Filters Efficiently
Use range filters to narrow results before applying other filters:Rate Limits
This query shares the GraphQL API’s limits. See Rate limits for the numbers and what a rejected request looks like.Code Examples
JavaScript/TypeScript
Python
cURL
FAQ
Q: What’s the maximum number of transactions I can retrieve in one request?
A: The maximum limit is 20 transactions per request. Use thehasNextPage field to implement pagination.
Q: How far back does transaction history go?
A: All transactions from account creation are available indefinitely.Q: Are pending transactions included?
A: Yes, pending transactions are included by default. Filter bystatus: [SETTLED] to exclude them.
Q: What timezone are the timestamps in?
A: All timestamps are in UTC (ISO 8601 format).Q: What scopes do I need?
A: You need bothLIST_PAYMENT AND LIST_PURCHASES scopes.
Q: Can I filter by user ID within my account?
A: No, the API always returns all transactions for your account. There is no user-level filtering.Q: What’s the difference between amount and finalAmount filters?
A:
amountfilters the base transaction amountfinalAmountfilters amount + fees (the total charged to the user)
Q: How do I filter by date range?
A: UsecreatedGte and createdLte for creation date:
Support
- API Status: https://status.fluz.app
- Developer Portal: https://developers.fluz.app
- Support Email: api-support@fluz.app
- Slack Community: https://fluz-dev.slack.com
Changelog
v1.0.0 (Branch: 13-fluz-15659-add-transactions-query-and-webhook-to-api)
- Initial release of Transactions Query API
- Support for comprehensive filtering (15+ filter types)
- Pagination with
TransactionConnectionresponse type - Balance snapshots included in transaction records
- Requires
LIST_PAYMENTandLIST_PURCHASESscopes - Account-level transaction access only
Need help? Contact our developer support team at api-support@fluz.app or visit our Developer Portal.