Searching
Search Fields
We support three types of search fields:
- Text fields
- Multiple value fields
- Range fields
Learn more about working with search results.
Text fields
Text Fields can be searched using 5 operators: Is
, IsNot
, StartsWith
, EndsWith
, and Contains
. Each search Text Field can't exceed 255 characters. Here is an example searching for customer email on a transaction.
- C#
var searchRequest = new TransactionSearchRequest().
CustomerEmail.Is("john.smith@example.com");
var searchRequest = new TransactionSearchRequest().
CustomerEmail.IsNot("john.smith@example.com");
var searchRequest = new TransactionSearchRequest().
CustomerEmail.StartsWith("john.smith");
var searchRequest = new TransactionSearchRequest().
CustomerEmail.EndsWith("example.com");
var searchRequest = new TransactionSearchRequest().
CustomerEmail.Contains("smith");
Multiple value fields
Search fields that accept multiple values support two operators: Is
and IncludedIn
.
- C#
var searchRequest = new TransactionSearchRequest()
.Status.Is(TransactionStatus.AUTHORIZED);
var searchRequest = new TransactionSearchRequest()
.Status.IncludedIn(TransactionStatus.AUTHORIZED,
TransactionStatus.SUBMITTED_FOR_SETTLEMENT);
Range fields
Ranges support four operators: Is
, Between
, GreaterThanOrEqualTo
, and LessThanOrEqualTo
. Between
is inclusive.
- C#
var searchRequest = new TransactionSearchRequest().
Amount.Is(15.00M);
var searchRequest = new TransactionSearchRequest().
Amount.GreaterThanOrEqualTo(10.00M);
var searchRequest = new TransactionSearchRequest().
Amount.LessThanOrEqualTo(20.00M);
var searchRequest = new TransactionSearchRequest().
Amount.Between(10.00M, 20.00M);