Skip to main content
Configuration options for useTransfers hook

Properties

PropertyTypeDescription
accountAddress?stringAccount address to fetch transfers for If not provided, uses the authenticated account from context
enabled?booleanEnable or disable automatic fetching Default: true
refetchOnWindowFocus?booleanRefetch transfers when window regains focus Default: false
staleTime?numberTime in milliseconds that data is considered fresh Default: 30000 (30 seconds)
limit?numberMaximum number of transfers to return per page Default: 25
paymentRail?PaymentRailFilter transfers by payment rail type Options: ‘ach’, ‘wire’, ‘sepa’, ‘swift’, ‘solana’
status?TransferStateFilter transfers by status Options: ‘pending’, ‘confirmed’, ‘failed’, etc.
currency?BridgeCurrencyFilter transfers by currency Options: ‘usd’, ‘eur’
startDate?stringFilter transfers created after this date Format: ISO 8601 date string Example '2024-01-01T00:00:00Z'
endDate?stringFilter transfers created before this date Format: ISO 8601 date string Example '2024-12-31T23:59:59Z'
txHash?stringFilter by specific transaction hash