Menu

Filtering by Query Parameter

You can use the supported API fields in the table below as query parameters in the
query
field of the search request.
Supported operators are
AND
and
OR
.
Use the format
field:value AND field2:value
.
Field hierarchy uses the dotted format
object.field
or
object.field.subfield
.
The table below lists the supported fields and how each filter can be used.
Query Parameters
Field/Parameter
Description
Example
applicationInformation.applications.reconciliationId
Transaction reference number, returned by the original transaction response.
reconciliationId:H74U3AD377ER921
buyerInformation.merchantCustomerId
Your identifier for the customer.
buyerInformation.merchantCustomerId:0535439670
clientReferenceInformation.code
Client-generated order reference or tracking number. We recommend that you send a unique value for each transaction so that you can perform meaningful searches for the transaction.
clientReferenceInformation.code:12345
clientReferenceInformation.partner.solutionId
Identifier for the partner that is integrated to our platform.
clientReferenceInformation.partner.solutionId: 89012345
deviceInformation.ipAddress
IP address of the customer's device.
deviceInformation.ipAddress:23.45.35.29
merchantInformation.resellerId
Only for reseller. Query transactions for all merchants under the reseller portfolio.
merchantInformation.resellerId:1234
merchantInformation.accountId
Query transactions for one of your merchant accounts.
merchantInformation.accountId:cybs_acct
orderInformation.amountDetails.currency
ISO Standard Currency Codes.
orderInformation.amountDetails.currency:[USD]
orderInformation.amountDetails.totalAmount
Grand total for the order.
orderInformation.amountDetails.totalAmount:100.00
orderInformation.billTo.email
Customer's email address.
orderInformation.billTo.email:null@example.com
orderInformation.billTo.firstName
Customer’s first name. This name must be the same as the name on the card.
orderInformation.billTo.firstName:John
orderInformation.billTo.lastName
Customer’s last name. This name must be the same as the name on the card.
orderInformation.billTo.lastName:Doe
orderInformation.billTo.phoneNumber
Phone number associated with the customer's billing address.
orderInformation.billTo.phoneNumber:8394552567
orderInformation.shipTo.phoneNumber
Phone number associated with the customer's billing address.
orderInformation.shipTo.phoneNumber:8394552567
paymentInformation.bank.account.prefix
The initial six numbers of a bank account number.
paymentInformation.bank.account.prefix:1234
paymentInformation.bank.account.suffix
Last four digits of the customer’s bank account number.
paymentInformation.bank.account.suffix:4321
paymentInformation.card.number
Full payment account number.
paymentInformation.card.number:4111111111111111
paymentInformation.card.prefix
Initial six numbers on a payment account number.
paymentInformation.card.prefix:4111
paymentInformation.card.suffix
Last four digits of the customer’s card number.
paymentInformation.card.suffix:1111
paymentInformation.customer.customerId
Unique identifier for the customer's card and billing information.
paymentInformation.customer.customerId:548323
paymentInformation.paymentType.method
Indicates the payment method used in this payment transaction.
paymentInformation.paymentType.method:MC
paymentInformation.paymentType.type
Indicates the payment type used in this payment transaction. For example: credit card or check.
paymentInformation.paymentType.type:credit card
proccessorInformation.approvalCode
Authorization code returned by the processor.
proccessorInformation.approvalCode:1234
proccessorInformation.retrievalReferenceNumber
Unique number that our platform generates to identify the transaction.
processorInformation.retrievalReferenceNumber:122908889379
submitTimeUtc
The date and time a transaction was submitted, or a range of times.
For more information, see Time Filtering.
The following examples show several ways of using these keywords in the query parameter.
Keyword Query Examples
Type of Search
Example
Two filters, using AND.
“query”: “clientReferenceInformation.code:1111 AND submitTimeUtc:[NOW/DAY-1DAYS TO NOW/DAY+1DAY}"
Three values for one filter, using OR.
“query”: “clientReferenceInformation.code:(1111 OR 2222 OR 3333)”
Multiple filters and values, using both AND and OR.
“query”: “clientReferenceInformation.code:(1111 OR 2222 OR 3333) AND submitTimeUtc:[NOW/DAY-1DAYS TO NOW/DAY+1DAY}”
Back to top