Skip to main content

Deposittransactionfiltercriteria

The unit that composes the list used for Deposit transactions client directed searching

fieldstringrequired

The fields to search can be the enumerated values or a custom field using the format [customFieldSetId].[customFieldId].

Field with limited capabilitiesData TypeOperators
originalTransactionKeyKEYEQUALS, IN
transactionDetails.transactionChannelIdSTRINGEQUALS
originalTransactionIDSTRINGEQUALS

Possible values: [encodedKey, id, externalId, holdExternalReferenceId, productID, currencyCode, branchID, branchKey, centreID, centreKey, tillID, tillKey, amount, affectedAmounts.fundsAmount, affectedAmounts.interestAmount, affectedAmounts.feesAmount, parentAccountKey, parentAccountID, parentAccountHolderKey, productTypeKey, paymentOrderId, userKey, adjustmentTransactionID, adjustmentTransactionKey, originalTransactionKey, originalTransactionID, transactionDetails.transactionChannelKey, transactionDetails.transactionChannelId, type, creationDate, accountBalances.totalBalance, valueDate, taxes.taxRate, terms.interestSettings.interestRate, fees.trigger, fees.name, fees.predefinedFeeKey, wasAdjusted, typeIsAdjustment, affectedAmounts.overdraftAmount, affectedAmounts.overdraftInterestAmount, affectedAmounts.overdraftFeesAmount, affectedAmounts.technicalOverdraftAmount, affectedAmounts.technicalOverdraftInterestAmount, terms.overdraftInterestSettings.interestRate, terms.overdraftInterestSettings.indexInterestRate]

operatorstringrequired
OperatorAffected valuesAvailable for
EQUALSONE_VALUEBIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
EQUALS_CASE_SENSITIVEONE_VALUEBIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
MORE_THANONE_VALUEBIG_DECIMAL,NUMBER,MONEY
LESS_THANONE_VALUEBIG_DECIMAL,NUMBER,MONEY
BETWEENTWO_VALUESBIG_DECIMAL,NUMBER,MONEY,DATE,DATE_TIME
ONONE_VALUEDATE,DATE_TIME
AFTERONE_VALUEDATE,DATE_TIME
BEFOREONE_VALUEDATE,DATE_TIME
BEFORE_INCLUSIVEONE_VALUEDATE,DATE_TIME
STARTS_WITHONE_VALUESTRING
STARTS_WITH_CASE_SENSITIVEONE_VALUESTRING
INLISTENUM,KEY
TODAYNO_VALUEDATE,DATE_TIME
THIS_WEEKNO_VALUEDATE,DATE_TIME
THIS_MONTHNO_VALUEDATE,DATE_TIME
THIS_YEARNO_VALUEDATE,DATE_TIME
LAST_DAYSONE_VALUENUMBER
EMPTYNO_VALUEBIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_TIME
NOT_EMPTYNO_VALUEBIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_TIME

Possible values: [EQUALS, EQUALS_CASE_SENSITIVE, DIFFERENT_THAN, MORE_THAN, LESS_THAN, BETWEEN, ON, AFTER, AFTER_INCLUSIVE, BEFORE, BEFORE_INCLUSIVE, STARTS_WITH, STARTS_WITH_CASE_SENSITIVE, IN, TODAY, THIS_WEEK, THIS_MONTH, THIS_YEAR, LAST_DAYS, EMPTY, NOT_EMPTY]

secondValuestring

The second value to match the searching criteria, when the BETWEEN operator is used.

valuestring

The value to match the searching criteria.

valuesstring[]

List of values when the IN operator is used.

Deposittransactionfiltercriteria
{
"field": "encodedKey",
"operator": "EQUALS",
"secondValue": "string",
"value": "string",
"values": [
"string"
]
}