Querying and Filtering
Find the information you need through the API or Virtual Terminal
Last updated
Was this helpful?
Find the information you need through the API or Virtual Terminal
Last updated
Was this helpful?
If you need to find a specific record in our database (such as a transaction or saved consent) or you need to find all records matching your criteria, you can either query our APIs programatically or use the Virtual Terminal to view and filter the records from its user interface.
To query records, you'll need to find a relevant method in the REST API or SOAP API reference.
When querying, you'll need to prepare the Query string. It should consist of variables that correspond to fields on the records and logical terms built using those variables.
All Query string variable options are fully described in the API reference under specific API methods and in the Querying reference. You can use the variables to build logical terms, and you can build and join logical terms using "&&" for a logical AND or "||" for a logical OR.
Read about Number's query language in our Querying reference.
Depending on the type of record you're querying (transaction, consent, ...), the variables you can use inside of a Query string will differ. The formatting rules do not change.
Each variable which requires an enum includes a description of valid values. Settled transactions have a transaction status of '2', and Verifone transactions have an origin of 'SDK'. To format the date correctly, follow the examples given for the variable.
You can combine the filters to build your Query string like so:
You can filter consents, transactions, and other records through the Virtual Terminal user interface.
To log into the Virtual Terminal, you need to have a user account created through the Client Admin Portal as described in the Authentication quickstart guide.
Once you're logged in, see the navigation on the left and click on Scheduled to view scheduled payments, click on Settlement to view settlements, or expand Reports to find other reports. There, you'll be able to search and filter records using the user interface.
You can read more about using the Virtual Terminal in the Virtual Terminal guide.
As an example, if want to find settled ACH transactions made in January 2025 made using Verifone card readers, you can call or depending on which API you are using.
You can check the description of the Query string parameter or check the Querying reference for section to find out that variable 'B' corresponds to transaction status, variable 'C' corresponds to date created, and 'U' corresponds to the transaction origin.
Never request a query without a limiting date factor. As the account grows, you may attempt to return an excessive number of past records and cause an error.
