Implemented filter mappings:
businessId - Account's businessId.
iban - Account's IBAN (e.g. "NL62RABO9688157082").
accountNumber - Account's number (e.g. "123456789").
currency - The 3-character ISO-4217 currency code indicating the operating currency of the bank account. For example, the currency code of United Kingdom is GBP.
accountType -CHECKING, SAVINGS, LOAN, OTHER, SALARY, CASHPAYMENT, CHARGES, CASH_TRADING, COMMISSION, MONEY_MARKET, GUARANTEED, COLLATERAL, CUSTODIAL, INVESTMENT, TAX.
generalLedgerNumber - General ledger number for the bank account.
description - Bank account full description.
shortDescription - Bank account short description.
status - INACTIVE, CREATED, IN_CHANGE, WAITING_FOR_APPROVAL, ACTIVE, CLOSED.
virtualAccount - Condition describing if a bank account is virtual, supports boolean value
bankBic - Bank account's BIC (e.g. "ANZBAU4M").
bankCode - Bank account's bank code (e.g. "ABCD").
legalEntityName - Account's Legal Entity (e.g. "Example Legal Entity").
For example, when you need to fetch all "active" bank accounts that belong to a bank with bic "ANZBAU4M" you need to run this query
filter=status=ACTIVE bic=ANZBAU4M
Condition values have to be escaped if they contain whitespace or operator symbols. To do so, enclose the whole value in double quotation marks
e.g. filter=legalEntityName="Example Legal Entity" status=active.
The following operators are supported in a filter term
| Operator | Name | Description | Example |
|---|
| = | Equal | Exact match of a single value | bankCode=ABCD |
| != | Not Equal | Negated equal | bankCode!=ABCD |
| : | In | Matches field against list of comma separated values | bankCode:ABCD,BPPA,BPAP |
| !: | Not In | Negated In | bankCode!:ABCD,BPPA,BPAP |
| <field> | Exists | A field without operator. Is true if the field is not null | bankCode |
| <field>! | Not Exists | Negated exists. Is true if field is null | bankCode! |
The Equal (=) and Not-Equal (!=) operators can be used together with wildcards to match partial strings. A single asterisk (*) can be placed at the very start or end of a value to match any number of characters there.
| Usage | Name | Description |
| iban=foo* or iban="foo"* | Starts with | Matches any string starting with the value. |
| iban=*foo or iban=*"foo" | Ends with | Matches any string ending with the value. |
| iban=*foo* or iban=*"foo"* | Like | Matches any string containing the value. |
