---
title: "Search Query"
method: POST
path: "/reports"
tags: ["Reports"]
---

# Search Query

`POST /reports`

Query for transactions using a date range and optional search criteria. This method allows you to page your search results if you are expecting a lot of results to be returned. The page start value begins at 1 and the results will be limited to 500 rows. If no records are found the API will return a 200 response message with an empty array. For details on the parameters and allowed values for Criteria please [visit the documentation](https://docs.na.worldline-solutions.com/build-your-integration/reporting-apis/payment_search_query)

## Request body

- SearchQuery
  - `name` 'Search' | 'TransHistoryMinimal', required — Can be either 'Search' for all fields or 'TransHistoryMinimal' for a subset of the fields returned in the results.
  - `start_date` string, required — The start date (inclusive) '2015-04-22T10:03:19' in the timezone of your merchant account.
  - `end_date` string, required — The end date (inclusive) '2015-04-22T10:03:19' in the timezone of your merchant account.
  - `start_row` number, required — Used to page the results. 1-based
  - `end_row` number, required — Used to page the results. 1-based. This should always be 1 larger than start_row with a maximum difference of 500 between them.
  - `criteria` Criteria[] — Optional search criteria. All criteria are ANDed together.
    - `field` number — Refer to the [table on this page](https://docs.na.worldline-solutions.com/build-your-integration/reporting-apis/payment_search_query) for the searchable fields
    - `operator` '%3D' | '%3C' | '%3E' | '%3C%3D' | '%3E%3D' | 'START%20WITH' — URL encoded comparators such as less than, greater than, equals... Refer to the [table on this page](https://docs.na.worldline-solutions.com/build-your-integration/reporting-apis/payment_search_query) for the full list of comparators
    - `value` string — The value you want to match against.

## Response `200`

A transaction object.

- SearchResult
  - `records` SearchRecord[]
    - `row_id` number
    - `trn_id` number
    - `trn_date_time` string — 2015-04-22T10:03:19.323-07:00
    - `trn_type` string
    - `trn_order_number` string
    - `trn_payment_method` string
    - `trn_comments` string
    - `trn_masked_card` string — The credit card with the middle digits redacted with X's
    - `trn_amount` number
    - `trn_returns` number
    - `trn_completions` number
    - `trn_voided` number
    - `trn_response` number
    - `trn_card_type` string — MC VI etc
    - `trn_batch_no` number
    - `trn_avs_result` string — Address Verification Service
    - `trn_cvd_result` number
    - `trn_cavv_result` string — 3D Secure Code Result
    - `trn_card_expiry` string
    - `message_id` number
    - `message_text` string
    - `trn_card_owner` string
    - `trn_ip` string
    - `trn_approval_code` string
    - `trn_reference` number
    - `b_name` string
    - `b_email` string
    - `b_phone` string
    - `b_phone_type` 'm' | 'h' | 'w' — The phone type of the phone number provided - m (Mobile), h (Home), or w (Work).
    - `b_address1` string
    - `b_address2` string
    - `b_city` string
    - `b_province` string
    - `b_postal` string
    - `b_country` string
    - `s_name` string
    - `s_email` string
    - `s_phone` string
    - `s_address1` string
    - `s_address2` string
    - `s_city` string
    - `s_province` string
    - `s_postal` string
    - `s_country` string
    - `ref1` string
    - `ref2` string
    - `ref3` string
    - `ref4` string
    - `ref5` string
    - `product_name` string
    - `product_id` string
    - `customer_code` string — The Payment Profile ID used in this transaction, if appropriate.
    - `currency_abbr` string — The currency for this transaction.
    - `merchant_id` integer — The id of the merchant for this transaction.
    - `merchant_name` string — The name of the merchant for this transaction.
    - `entry_method` 'N' | 'A' | 'D' | 'P' | 'V' | 'T' — How the transaction was initiated. N = Standard Entry, A = Apple Pay, D = Apple Pay (External Decryption), P = Google Pay, V = Visa Checkout, T = TD Token
    - `authorizing_merchant_id` integer — The id of the merchant that authorized this transaction.
    - `version_3ds` integer — The version of 3D Secure being used. This should return 2 since 1 is no longer supported. 0 is returned if not 3D Secure.
    - `flow_type_3ds` 'F' | 'C' — The 3D Secure authenication flow type. F = Frictionless, C = Challenge
    - `status_3ds` 'Success' | 'Attempted' | 'Rejected' | 'Failed' | 'Unavailable' — The result returned back from the 3D Secure authenication.
    - `cof_type` 'first_installment' | 'subsequent_installment' | 'first_recurring' | 'subsequent_recurring' | 'first_unscheduled' | 'subsequent_customer_initiated' | 'subsequent_unscheduled' — The type of credential-on-file transaction.
    - `reason_merchant_3ds` string — For merchant use only. Provides a category which identifies the reason for the rejection. [See list of reasons](https://docs.na.worldline-solutions.com/build-your-integration/security-and-fraud-APIs/3ds-20/)
    - `reason_cardholder_3ds` string — The reason for the rejection and instructions on what to do. This can be returned to the cardholder.
    - `downgraded_3ds` boolean — Indicates whether or not the 3DS transaction was downgraded. A downgraded transaction does not provide a liability shift to the merchant, even if the 3DS authentication result was "Success" or "Attempted".
    - `device_channel` string — Type of channel used to initiate the transaction. 02 = Browser, 03 = 3DS Requestor.
    - `method_url_3ds` string — The outcome of a 3DS Method URL operation performed during the course of a transaction. Either Succeeded (3DS Method URL was initiated and was successful), Failed (3DS Method URL was initiated but failed. The transaction will proceed but without the support of Method URL.)or NotAttempted (3DS Method URL was not requested for this transaction or a validation error existed in the supplied threeDS_server_transaction_id).

## Other responses

- `400` — Bad Request
- `401` — Authentication Failure
- `402` — Business Rule Violation or Decline
- `403` — Authorization Failure
- `405` — Invalid Request Method
- `500` — Internal Server Error

---

[API](https://skmtc.net/worldline-solutions/apis/worldline-payment-apis.md) · [All operations](https://skmtc.net/worldline-solutions/apis/worldline-payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/worldline-solutions/worldline-payment-apis/versions/d661d9e357a1/schema)