Skip to main content Link Menu Expand (external link) Document Search Copy Copied

TransactionFilter

Model getters

Method name Return type Description Notes
getId() string Account ID - source of transaction(s).
Example: 5e6be8e9e6aa436299950c41
 
getCounterAccount() string Counter account - transaction(s) destination account.
Example: 5e6be8e9e6aa436299950c41
[optional]
getFrom() int Starting date to search for transactions from in UTC millis. If not present, search all history.
Example: 1571833231000
[optional]
getTo() int Date until to search for transactions in UTC millis. If not present, search up till now.
Example: 1571833231000
[optional]
getCurrency() string Currency of the transactions.
Example: BTC
[optional]
getAmount() \Tatum\Model\TransactionFilterAmountInner[] Amount of the transaction. AND is used between filter options.
Example: null
[optional]
getCurrencies() string[] List of currencies of the transactions.
Example: null
[optional]
getTransactionType() string Type of payment
Example: null
[optional]
getTransactionTypes() string[] Types of payment
Example: null
[optional]
getOpType() string Type of operation
Example: PAYMENT
[optional]
getTransactionCode() string For bookkeeping to distinct transaction purpose.
Example: 1_01_EXTERNAL_CODE
[optional]
getPaymentId() string Payment ID defined in payment order by sender.
Example: 65426
[optional]
getRecipientNote() string Recipient note defined in payment order by sender.
Example: 65426
[optional]
getSenderNote() string Sender note defined in payment order by sender.
Example: 65426
[optional]