---
title: "Get Transaction Data"
method: POST
path: "/v4/transactions/reports"
tags: ["Gateway Features", "Transactions"]
---

# Get Transaction Data

`POST /v4/transactions/reports`

> ❗️ Never Use Real API Keys
>
> Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.
<details>
<summary>Usage</summary>
This is a query to find live transactions by merchants under your partner account. The query will respond in Universal Time Coordinated (UTC).

If you provide a specific transaction id, then it will return that transaction.

If you provide a sub-affiliates' merchant id in the merchant id list, it will return that merchant's transactions.
</details>

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Request body

- GetTransactionDataRequest
  - `merchantId` string — The merchant gateway ID to which the transactions belong.
  - `merchantIds` string[] — The merchants gateway IDs to which the transactions belong.
  - `maxResults` string, required — Maximum number of results per page.
  - `offset` string — Offset value for pagination, or null if not used.
  - `orderId` string — The order ID of the transaction.
  - `par` string — The Payment Account Reference ID to search for.
  - `hmac` string — The Hash-based Message Authentication Code ID to search for.
  - `serviceId` string — The ID of the processor platform you want to search for.
  - `platformId` string — The ID of the platform.
  - `firstName` string — The first name of the merchant's company contact.
  - `lastName` string — The last name of the merchant's company contact.
  - `email` string — The email of the merchant's company contact.
  - `accountNumber` string — Account Number.
  - `transactionType` string — Transaction type.
  - `customerId` string — Customer ID.
  - `phone` string — The phone number of the merchant's company contact.
  - `transactionIds` string[] — Transactions IDs to search.
  - `statuses` string[] — The list of statuses to query.
  - `actionTypes` string[] — The type of transaction to query.
  - `amount` object — Min and max amount for transactions to search.
    - `min` number — Min amount.
    - `max` number — Max amount.
  - `date` object — Start and End date for query transactions.
    - `start` string — Start date.
    - `end` string — End date.

## Response `200`

Success

- GetTransactionDataResponse
  - `objectType` 'serviceConfig' — The type of object that was returned as a result of the request.
  - `reportId` number — The ID of the report.
  - `offset` number — The first N skipped results.
  - `maxResults` number — The max number results.
  - `totalResults` number — The total number of results.
  - `hasMore` boolean — Indicates if there are more results available beyond the current page.
  - `links` object — Pagination links for navigating through the report results.
    - `first` string, uri — URL to the first page of results.
    - `last` string, uri — URL to the last page of results.
    - `next` string, uri — URL to the next page of results.
    - `previous` string, uri — URL to the previous page of results.
  - `results` object[] — Results for the search.
    - `objectType` string — Type of the returned response object.
    - `id` string — The ID for the transaction.
    - `created` string, date-time — The timestamp indicating when the transaction was created.
    - `updated` string, date-time — The timestamp indicating when the transaction was last updated.
    - `billingAddress` object — Billing Address details.
      - `first_name` string — The first name of the person associated with the billing address.
      - `last_name` string — The last name of the person associated with the billing address.
      - `address_1` string — The first line of the street address.
      - `address_2` string — The second line of the street address.
      - `company` string — The name of the company associated with the billing address.
      - `city` string — The name of the city associated with the billing address.
      - `state` string — The name of the state or province associated with the billing address. Format: `CC`.
      - `postal_code` string — The postal code or zip code associated with the billing address.
      - `country` string — The name of the country associated with the billing address. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC`.
      - `email` string, email — The email address associated with the billing address.
      - `phone` string, phone — The phone number associated with the billing address.
      - `cell_phone` string, phone — The cell phone number associated with the billing address.
      - `fax` string, phone — The fax number associated with the billing address.
    - `shippingAddress` object — Shipping Address details.
      - `first_name` string — The first name of the person associated with the shipping address.
      - `last_name` string — The last name of the person associated with the shipping address.
      - `address_1` string — The first line of the street address.
      - `address_2` string — The second line of the street address.
      - `company` string — The name of the company associated with the shipping address.
      - `city` string — The city of the shipping address.
      - `state` string — The state or province of the shipping address. Format: `CC`.
      - `postal_code` string — The postal or zip code of the shipping address.
      - `country` string — The country of the shipping address. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC`.
      - `email` string — The email address associated with the shipping address.
      - `phone` string — The phone number associated with the shipping address.
      - `fax` string — The fax number associated with the shipping address.
    - `shipping` object — The shipping details associated with the transaction.
      - `objectType` string — The type of the object, representing shipping details.
      - `carrier` string — The carrier used for shipping.
      - `trackingNumber` string — The tracking number provided by the shipping carrier.
      - `date` string, date-time, nullable — The date the item was shipped.
      - `fromPostalCode` string — The postal code from where the item was shipped.
      - `amount` object — The amount details for shipping.
        - `objectType` string — The type of the object, representing the shipping amount.
        - `amount` string — The monetary amount for shipping.
        - `currency` string — The currency of the shipping amount.
    - `merchantId` string — The ID for the merchant involved in the transaction.
    - `platformId` string — The ID for the platform facilitating the transaction.
    - `customerId` string — The ID for the customer involved in the transaction.
    - `orderId` string — The order ID associated with the transaction.
    - `orderDescription` string, nullable — A description of the order associated with the transaction.
    - `processorId` string — The ID for the payment processor handling the transaction.
    - `poNumber` string — The purchase order number associated with the transaction.
    - `refId` string — A reference identifier for the transaction.
    - `authorizationCode` string — The authorization code for the transaction, provided by the payment processor.
    - `status` string — The current status of the transaction.
    - `driversLicense` object — The driver's license details associated with the transaction.
      - `objectType` string — The type of the object, representing a driver's license.
      - `dateOfBirth` string, date — The birth date of the individual associated with the driver's license.
      - `number` string — The unique number of the driver's license.
      - `state` string — The state or province that issued the driver's license.
    - `tax` object — The tax details associated with the transaction.
      - `objectType` string — The type of the object, representing the tax amount.
      - `amount` string — The monetary amount for tax.
      - `currency` string — The currency of the tax amount.
    - `tip` object — The tip details associated with the transaction.
      - `objectType` string — The type of the object, representing the tip amount.
      - `amount` string — The monetary amount for the tip.
      - `currency` string — The currency of the tip amount.
    - `merchantDefinedFields` object — Custom fields defined by the merchant for additional information related to the transaction.
    - `vat` object — The VAT details associated with the transaction.
      - `objectType` string — The type of the object, representing the VAT details.
      - `taxRate` object — The VAT rate details.
        - `objectType` string — The type of the object, representing the tax rate.
        - `amount` string — The VAT rate applied.
        - `currency` string — The currency of the VAT rate.
      - `invoiceReferenceNumber` string — The reference number for the invoice related to the VAT.
      - `customerVatRegistration` string — The VAT registration number of the customer.
      - `merchantVatRegistration` string — The VAT registration number of the merchant.
    - `summaryCommodityCode` string — The summary commodity code related to the transaction.
    - `orderDate` string, date-time, nullable — The date when the order was placed.
    - `installmentBilling` object — The installment billing details associated with the transaction.
      - `objectType` string — The type of the object, representing installment billing details.
      - `billingNumber` string — The current installment number being billed.
      - `billingTotal` object — The total billing amount details for the installment.
        - `objectType` string — The type of the object, representing the total billing amount for the installment.
        - `amount` string — The monetary amount for the total installment billing.
        - `currency` string — The currency of the installment billing amount.
    - `alternateTaxId` string — An alternate tax identifier for the transaction.
    - `customerTaxId` string — The tax identifier for the customer associated with the transaction.
    - `website` string — The website associated with the transaction.
    - `socialSecurityNumber` string — The social security number of the individual involved in the transaction.
    - `serviceId` string — The ID for the service used in the transaction.
    - `surcharge` object — The surcharge details associated with the transaction.
      - `objectType` string — The type of the object, representing the surcharge amount.
      - `amount` string — The monetary amount for the surcharge.
      - `currency` string — The currency of the surcharge amount.
    - `partialPayment` object — The partial payment details associated with the transaction.
      - `objectType` string — The type of the object, representing partial payment details.
      - `id` string — The ID for the partial payment.
      - `balance` object — The balance details for the partial payment.
        - `objectType` string — The type of the object, representing the balance amount.
        - `amount` string — The remaining balance for the partial payment.
        - `currency` string — The currency of the remaining balance amount.
    - `refundableBalance` object — The refundable balance details for the transaction.
      - `objectType` string — The type of the object, representing the refundable balance.
      - `amount` string — The monetary amount available for refund.
      - `currency` string — The currency of the refundable balance.
    - `actions` object[] — A list of actions associated with the transaction.
      - `objectType` string — The type of the object, representing an action.
      - `amount` object — The amount details for the action.
        - `objectType` string — The type of the object, representing the action amount.
        - `amount` string — The monetary amount for the action.
        - `currency` string — The currency of the action amount.
      - `actionType` string — The type of action performed, such as 'sale' or 'refund'.
      - `date` string, date-time — The timestamp when the action was performed.
      - `success` boolean — Indicates whether the action was successful.
      - `ipAddress` string — The IP address from where the action was initiated.
      - `source` string — The source from which the action was performed, such as 'virtualTerminal'.
      - `apiMethod` string — The API method used to perform the action.
      - `username` string — The username of the individual who performed the action.
      - `responseText` string — The response text returned by the system for the action.
      - `batchId` string — The identifier for the batch in which the action was included.
      - `platformBatchId` string — The platform-specific batch identifier for the action.
      - `responseCode` string — The response code returned by the system for the action.
      - `platformResponseText` string — The platform-specific response text for the action.
      - `platformResponseCode` string — The platform-specific response code for the action.
      - `deviceLicenseNumber` string, nullable — The license number of the device used for the action.
      - `deviceNickname` string, nullable — The nickname of the device used for the action.
    - `items` object[] — A list of items associated with the transaction.
    - `emv` object — The EMV details associated with the transaction.
      - `objectType` string — The type of the object, representing EMV (Europay, Mastercard, and Visa) details.
      - `applicationId` string — The ID for the EMV application.
      - `applicationPreferredName` string — The preferred name of the EMV application.
      - `applicationLabels` string — Labels associated with the EMV application.
      - `terminalStatusId` string — The status identifier of the terminal processing the EMV transaction.
    - `paymentInfo` object
      - `objectType` string — The type of the object, representing payment card information.
      - `cardNumber` string — The masked card number used for the transaction.
      - `cardExp` string — The expiration date of the card used for the transaction.
      - `cardHash` string — A hash value of the card information used for transaction security.
      - `avsResponse` string — The response from the Address Verification System (AVS) for the card.
      - `cardholderAuth` string — The authentication response for the cardholder.
      - `cscResponse` string — The response from the Card Security Code (CSC) verification.
      - `cardStartDate` string — The start date of the card, if applicable.
      - `cardIssueNumber` string — The issue number of the card, if applicable.
      - `cardBalance` string — The balance available on the card, if applicable.
      - `cardAvailableBalance` string — The available balance on the card, if applicable.
      - `entryMode` string — The mode used to enter the card information, such as 'swiped' or 'keyed'.
      - `cardBin` string — The Bank Identification Number (BIN) of the card used for the transaction.
      - `cardType` string — The type of card used, such as 'visa' or 'mastercard'.
      - `cardHolderAuthentication` object
        - `objectType` string — The type of the object, representing cardholder authentication details.
        - `xid` string — The transaction identifier for cardholder authentication.
        - `eci` string — The electronic commerce indicator for cardholder authentication.
        - `cavv` string — The cardholder authentication verification value.
        - `cavvResult` string — The result of the cardholder authentication verification.
        - `directoryServerId` string, nullable — The identifier for the directory server involved in cardholder authentication.
        - `threeDsVersion` string, nullable — The version of the 3D Secure protocol used for authentication.
    - `storedCredentials` object — The stored credentials details associated with the transaction.
      - `objectType` string — The type of the object, representing stored credentials.
      - `initiatedBy` string — The initiator of the transaction, indicating whether it was 'merchant' or 'cardholder' initiated.
      - `initialTransactionId` string — The ID of the initial transaction for stored credentials.
      - `storedIndicator` string — Indicates whether the credentials are stored, typically 'true' or 'false'.
      - `credentialOnFileSupported` boolean — Indicates whether the system supports storing credentials on file.
    - `authorizationState` string — The state of authorization for the transaction.
    - `cardholderVerificationMethod` string — The method used for cardholder verification during the transaction.

---

[API](https://skmtc.net/nmi/apis/embedded-components-api.md) · [All operations](https://skmtc.net/nmi/apis/embedded-components-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmi/embedded-components-api/versions/45c2ecda3685/schema)