Filtering by Query Parameter {#txn-filtering} ============================================= 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 ``` {#txn-filtering_codeblock_d33_wcl_byb} ``` reconciliationId:H74U3AD377ER921 ``` {#txn-filtering_codeblock_qct_xcl_byb} buyerInformation.merchantCustomerId : Your identifier for the customer. : Example: ``` buyerInformation.merchantCustomerId:0535439670 ``` {#txn-filtering_codeblock_vcl_1dl_byb} 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 ``` {#txn-filtering_codeblock_hjj_ddl_byb} clientReferenceInformation.partner.solutionId : Identifier for the partner that is integrated to our platform. : Example: ``` clientReferenceInformation.partner.solutionId:89012345 ``` {#txn-filtering_codeblock_bc2_gdl_byb} deviceInformation.ipAddress : IP address of the customer's device. : Example: ``` deviceInformation.ipAddress:23.45.35.29 ``` {#txn-filtering_codeblock_ex4_jdl_byb} id : A unique identification number generated by `Cybersource` to identify the submitted request. : Example: ``` id:6590834057836283403955 ``` {#txn-filtering_codeblock_qdk_ldl_byb} installmentInformation.identifier : Identifier for an installment payment transaction. : Example: ``` installmentInformation.identifier:1000000000 ``` {#txn-filtering_codeblock_sr2_4dl_byb} merchantId : `Cybersource` merchant ID. : Example: ``` merchantId:merchant10 ``` {#txn-filtering_codeblock_gfy_qdl_byb} merchantInformation.resellerId : Only for reseller. Query transactions for all merchants under the reseller portfolio. : Example: ``` merchantInformation.resellerId:1234 ``` {#txn-filtering_codeblock_nny_tdl_byb} merchantInformation.accountId : Query transactions for one of your merchant accounts. : Example: ``` merchantInformation.accountId:cybs_acct ``` {#txn-filtering_codeblock_x5v_wdl_byb} orderInformation.amountDetails.currency : ISO Standard Currency Codes. See [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf "") for more information. : Example: ``` orderInformation.amountDetails.currency:[USD] ``` {#txn-filtering_codeblock_bk1_zdl_byb} orderInformation.amountDetails.totalAmount : Grand total for the order. : Example: ``` orderInformation.amountDetails.totalAmount:100.00 ``` {#txn-filtering_codeblock_oyc_b2l_byb} orderInformation.billTo.email : Customer's email address. : Example: ``` orderInformation.billTo.email:null@example.com ``` {#txn-filtering_codeblock_qfj_d2l_byb} orderInformation.billTo.firstName : Customer's first name. This name must be the same as the name on the card. : Example: ``` orderInformation.billTo.firstName:John ``` {#txn-filtering_codeblock_fwl_f2l_byb} orderInformation.billTo.lastName : Customer's last name. This name must be the same as the name on the card. : Example: ``` orderInformation.billTo.lastName:Doe ``` {#txn-filtering_codeblock_rzs_h2l_byb} orderInformation.billTo.phoneNumber : Phone number associated with the customer's billing address. : Example: ``` orderInformation.billTo.phoneNumber:8394552567 ``` {#txn-filtering_codeblock_rfj_j2l_byb} orderInformation.shipTo.phoneNumber : Phone number associated with the customer's shipping address. : Example: ``` orderInformation.shipTo.phoneNumber:8394552567 ``` {#txn-filtering_codeblock_bvd_l2l_byb} paymentInformation.bank.account.number : Full bank account number. : Example: ``` paymentInformation.bank.account.number:1234567890 ``` {#txn-filtering_codeblock_jxg_n2l_byb} paymentInformation.bank.account.prefix : The initial six numbers of a bank account number. : Example: ``` paymentInformation.bank.account.prefix:1234 ``` {#txn-filtering_codeblock_rtw_42l_byb} paymentInformation.bank.account.suffix : Last four digits of the customer's bank account number. : Example: ``` paymentInformation.bank.account.suffix:4321 ``` {#txn-filtering_codeblock_lfz_q2l_byb} paymentInformation.card.number : Full payment account number. : Example: ``` paymentInformation.card.number:4111111111111111 ``` {#txn-filtering_codeblock_ymt_s2l_byb} paymentInformation.card.prefix : Initial six numbers on a payment account number. : Example: ``` paymentInformation.card.prefix:4111 ``` {#txn-filtering_codeblock_q4l_52l_byb} paymentInformation.card.suffix : Last four digits of the customer's card number. : Example: ``` paymentInformation.card.suffix:1111 ``` {#txn-filtering_codeblock_rwb_w2l_byb} paymentInformation.customer.customerId : Unique identifier for the customer's card and billing information. : Example: ``` paymentInformation.customer.customerId:548323 ``` {#txn-filtering_codeblock_wrl_y2l_byb} paymentInformation.paymentType.method : Indicates the payment method used in this payment transaction. See [Filtering by Payment Type](/docs/cybs/en-us/txn-search/developer/all/rest/txn-search/txn-search-intro/txn-filtering/txn-search-filter-paymentType-type.md "") for more information. : Example: ``` paymentInformation.paymentType.method:MC ``` {#txn-filtering_codeblock_y23_1fl_byb} paymentInformation.paymentType.type : Indicates the payment type used in this payment transaction. For example: credit card or check. See [Filtering by Payment Type](/docs/cybs/en-us/txn-search/developer/all/rest/txn-search/txn-search-intro/txn-filtering/txn-search-filter-paymentType-type.md "") for more information. : Example: ``` paymentInformation.paymentType.type:credit card ``` {#txn-filtering_codeblock_p23_cfl_byb} processingInformation.commerceIndicator : Type of transaction. Some payment card companies use this information when determining discount rates. : Example: ``` processingInformation.commerceIndicator:123abc ``` {#txn-filtering_codeblock_mjx_dfl_byb} processorInformation.approvalCode : Authorization code returned by the processor. : Example: ``` processorInformation.approvalCode:1234 ``` {#txn-filtering_codeblock_cn2_gfl_byb} processorInformation.retrievalReferenceNumber : Unique number that our platform generates to identify the transaction. : Example: ``` processorInformation.retrievalReferenceNumber:122908889379 ``` {#txn-filtering_codeblock_prb_3fl_byb} submitTimeUtc : The date and time a transaction was submitted, or a range of times. See [Filtering Using submitTimeUtc](/docs/cybs/en-us/txn-search/developer/all/rest/txn-search/txn-search-intro/txn-filtering/txn-search-filter-submitTimeUtc.md "") for more information. : Example: ``` submitTimeUtc:[2022-05-11T03:21:03Z] ``` {#txn-filtering_codeblock_rsv_jfl_byb} {#txn-filtering_dl_icb_scl_byb} The following examples show several ways of using these keywords in the query parameter. | 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}" | [Keyword Query Examples]