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
.
This list identifies the supported fields and how each filter can be used.
Query Parameters:
applicationInformation.applications.reconciliationId
OR
reconciliationId
Transaction reference number, returned by the original transaction response.
Examples:
applicationInformation.applications.reconciliationId:H74U3AD377ER921
reconciliationId:H74U3AD377ER921
buyerInformation.merchantCustomerId
Your identifier for the customer.
Example:
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.
Example:
clientReferenceInformation.code:12345
clientReferenceInformation.partner.solutionId
Identifier for the partner that is integrated to our platform.
Example:
clientReferenceInformation.partner.solutionId:89012345
deviceInformation.ipAddress
IP address of the customer's device.
Example:
deviceInformation.ipAddress:23.45.35.29
id
A unique identification number generated by
Visa Acceptance Solutions
to identify the submitted request.
Example:
id:6590834057836283403955
installmentInformation.identifier
Identifier for an installment payment transaction.
Example:
installmentInformation.identifier:1000000000
merchantId
Visa Acceptance Solutions
merchant ID.
Example:
merchantId:merchant10
merchantInformation.resellerId
Only for reseller. Query transactions for all merchants under the reseller portfolio.
Example:
merchantInformation.resellerId:1234
merchantInformation.accountId
Query transactions for one of your merchant accounts.
Example:
merchantInformation.accountId:cybs_acct
orderInformation.amountDetails.currency
ISO Standard Currency Codes.
Example:
orderInformation.amountDetails.currency:[USD]
orderInformation.amountDetails.totalAmount
Grand total for the order.
Example:
orderInformation.amountDetails.totalAmount:100.00
orderInformation.billTo.email
Customer's email address.
Example:
orderInformation.billTo.email:[email protected]
orderInformation.billTo.firstName
Customer’s first name. This name must be the same as the name on the card.
Example:
orderInformation.billTo.firstName:John
orderInformation.billTo.lastName
Customer’s last name. This name must be the same as the name on the card.
Example:
orderInformation.billTo.lastName:Doe
orderInformation.billTo.phoneNumber
Phone number associated with the customer's billing address.
Example:
orderInformation.billTo.phoneNumber:8394552567
orderInformation.shipTo.phoneNumber
Phone number associated with the customer's shipping address.
Example:
orderInformation.shipTo.phoneNumber:8394552567
paymentInformation.bank.account.number
Full bank account number.
Example:
paymentInformation.bank.account.number:1234567890
paymentInformation.bank.account.prefix
The initial six numbers of a bank account number.
Example:
paymentInformation.bank.account.prefix:1234
paymentInformation.bank.account.suffix
Last four digits of the customer’s bank account number.
Example:
paymentInformation.bank.account.suffix:4321
paymentInformation.card.number
Full payment account number.
Example:
paymentInformation.card.number:4111111111111111
paymentInformation.card.prefix
Initial six numbers on a payment account number.
Example:
paymentInformation.card.prefix:4111
paymentInformation.card.suffix
Last four digits of the customer’s card number.
Example:
paymentInformation.card.suffix:1111
paymentInformation.customer.customerId
Unique identifier for the customer's card and billing information.
Example:
paymentInformation.customer.customerId:548323
paymentInformation.paymentType.method
Indicates the payment method used in this payment transaction. See Filtering by Payment Type for more information.
Example:
paymentInformation.paymentType.method:MC
paymentInformation.paymentType.type
Indicates the payment type used in this payment transaction. For example: credit card or check. See Filtering by Payment Type for more information.
Example:
paymentInformation.paymentType.type:credit card
processingInformation.commerceIndicator
Type of transaction. Some payment card companies use this information when determining discount rates.
Example:
processingInformation.commerceIndicator:123abc
processorInformation.approvalCode
Authorization code returned by the processor.
Example:
processorInformation.approvalCode:1234
processorInformation.retrievalReferenceNumber
Unique number that our platform generates to identify the transaction.
Example:
processorInformation.retrievalReferenceNumber:122908889379
submitTimeUtc
The date and time a transaction was submitted, or a range of times. See Filtering Using submitTimeUtc for more information.
Example:
submitTimeUtc:[2022-05-11T03:21:03Z]
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}”

Filtering Using the paymentInformation.paymentType Field

The
paymentInformation.paymentType.type
field enables you to filter transactions by the payment type.
Possible values and descriptions for
paymentInformation.paymentType.type
and corresponding
paymentInformation.paymentType.method
values:
  • bank transfer
    : Bank transfer
    • mch
      : Bancontact
    • rbt
      : Bank Transfer
    • br
      : Brazil Bank Transfer
    • blf
      : Belfius
    • co
      : China Cash on Order
    • ct
      : China Bank Transfer
    • cw
      : China eWallet
    • eps
      : EPS
    • vks
      : Finland Bank Transfer
    • gpy
      : Giropay
    • ion
      : Interac Online
    • idl
      : iDeal
    • wpb
      : PayByBank
    • kbc
      : KBC
    • pzw
      : Przelewy24
    • sof
      : Sofort
    • dbb
      : Sweden Bank Transfer
  • cash payments
    : Cash payment
    • oxo
      : Oxxo
    • mlb
      : Multibanco
  • check
    : Check
    • c
      : Checking
    • x
      : Corporate Checking
    • u
      : Checking without Account Number
    • s
      : Savings
  • credit card
    : Credit card
    • ax
      : American Express
    • ar
      : Aura Card
    • bb
      : Bebe
    • bl
      : Bill Me Later
    • cn
      : Carnet
    • cs
      : Carta Si
    • cb
      : Carte Blanche
    • cl
      : Cartes Bancaires
    • cc
      : Casual Corner
    • cp
      : China UnionPay (CUP)
    • dk
      : Dankort
    • do
      : Delta Online
    • dc
      : Diners Club
    • di
      : Discover
    • ds
      : Dick's Sportswear
    • dn
      : Disney
    • ed
      : eDiscreet
    • el
      : ELO Card
    • en
      : Encoded Account
    • er
      : EnRoute
    • fb
      : Falabella
    • gm
      : GE Capital Money UK
    • ep
      : Eftpos
    • tc
      : GE TwinPay Credit
    • td
      : GE TwinPay Debit
    • hc
      : Hipercard
    • hd
      : Home Depot Consumer
    • hr
      : Household
    • ja
      : JAL
    • jc
      : JCB
    • jw
      : Jcrew
    • kr
      : Korean Cards
    • la
      : Laser
    • lw
      : Lowe's Consumer
    • mb
      : MBNA
    • mc
      : Mastercard
    • mg
      : MagnaCash
    • mo
      : Maestro
    • mr
      : Meijer
    • md
      : Mada
    • nc
      : Nicos
    • or
      : Orico Card
    • rc
      : Redecard
    • dp
      : Pinless Debit
    • rp
      : RuPay
    • rh
      : Restoration Hardware
    • sb
      : Sam's Club Business
    • sc
      : Sam's Club Consumer
    • sr
      : Sears
    • st
      : Style Cards
    • ua
      : UATP
    • unk
      : Unknown Card
    • ve
      : Visa Electron
    • vi
      : Visa
    • wm
      : Walmart
  • direct debit
    : Direct debit
    • dd
      : Direct Debit
    • sdd
      : Adyen SEPA Direct Debit
  • ewallet
    : eWallet
    • abr
      : Alipay Barcode
    • adm
      : Alipay Domestic (mobile)
    • apd
      : Alipay Domestic
    • apy
      : Alipay International
    • aym
      : Alipay International (mobile)
    • aqr
      : Alipay QR Code
    • acc
      : Alipay Credit Card
    • ctp
      : Common Transaction Processing
    • rbt
      : Bank transfer
    • mbp
      : Mobile Billing
    • vme
      : V.me
  • gift card
    : Gift card
    • vl
      : ValueLink
  • invoice payments
    : Invoice payments
    • kli
      : Klarna
    • afm
      : Affirm
  • paypal
    : PayPal
    • paypal
      : PayPal
  • switch card
    : Switch card
    • so
      : Solo
    • sw
      : Switch

Filtering Using the submitTimeUtc Field

The
submitTimeUtc
field uses date math expressions and enables you to use dates and times relative to a fixed moment, including the current time, which is represented by
NOW
.
You can also use UNIX Epoch Time for the start and end time. For example,
submitTimeUtc:[1556712000000 TO 1556757600000]
.
Date Math Syntax:
Date math expressions consist of adding some quantity of time in a specified unit, or rounding the current time by a specified unit. Expressions can be joined and are evaluated left to right.
A slash (
/
) is used to indicate rounding.
NOW/HOUR
represents the beginning of the current hour. If the current time is 4:12 p.m. (
NOW
), then
NOW/HOUR
would be the start of that hour, 4:00 p.m. Valid values in date math are:
  • DAY
    or
    DAYS
  • MONTH
    or
    MONTHS
  • MINUTE
    or
    MINUTES
Date Math Range:
Date math supports date range searches. The syntax is
[startDate TO endDate}
.
A square bracket (
[
) indicates that the date is included in the range; a curly bracket (
}
) indicates that the date is excluded.
For example, to search transactions from the previous day, and the current date is May 3, 2019,
[NOW/DAY-1DAY TO NOW/DAY}
would search for transactions with a date between May 2, 2019, 12:00 AM to May 2, 2019, 11:59 PM.
More Examples:
  • Last hour:
    [NOW/HOUR-1HOUR TO NOW/HOUR}
  • Today:
    [NOW/DAY TO NOW/DAY+1DAY}
  • Yesterday:
    [NOW/DAY-1DAY TO NOW/DAY}
  • Past 7 days:
    [NOW/DAY-7DAYS TO NOW/DAY+1DAY}
  • Month-to-Date:
    [NOW/MONTH TO NOW/DAY+1DAY}
  • Past month:
    [NOW/MONTH-1MONTH TO NOW/MONTH}
  • Past 6 months:
    [NOW/DAY-6MONTHS TO NOW/DAY+1DAY}
  • Past 12 months:
    [NOW/DAY-12MONTHS TO NOW/DAY+1DAY]
  • Past 13 months:
    [NOW/DAY-13MONTHS TO NOW/DAY+1DAY]