---
title: "View transactions"
method: GET
path: "/transaction/v3"
tags: ["Transactions"]
---

# View transactions

`GET /transaction/v3`

The endpoint returns all transactions that meet the specified parameters and that are associated with the Nexio account used to [authenticate](https://docs.nexiopay.com/docs/authentication). 

You request (or filter) on fields of the query parameters as in the following example:

  <code>/transaction/v3?kount.&plugin.&customer.&processor.&gateway.</code>

See the [Finding a transaction](https://docs.nexiopay.com/docs/finding-a-transaction) topic in Guides for a full tutorial.

The default response only includes a small number of parameters. If you want additional objects and parameters, you must specify them in the request. For more information about how to do this, see the [Requesting additional response parameters](https://docs.nexiopay.com/docs/requesting-additional-response-parameters) topic in Guides.

<!-- theme: warning -->
> 🛑 Warning
> 
> You must specify at least one parameter. Failing to submit one results in an Internal Server Error. Also, it is **not** possible to send a request with all parameters. Doing so results in a 400 error and the system does not return a response.

<!-- theme: info -->
> 📘 Notes
> 
> - **It may take up to a minute after a transaction is run before you can see it in the response for this endpoint.**
> - If you want to search for a transaction by `paymentId`, you should use the [View transaction by payment ID](https://docs.nexiopay.com/reference/viewtransactionpaymentid) endpoint so that you get all the details for the transaction. Alternately, include the value of the `paymentId` in the `plugin.originalId` query parameter in this endpoint along with any [additional response parameters](https://docs.nexiopay.com/docs/requesting-additional-response-parameters).
> - If you want to search for a transaction by `transactionId`, you should use the [View transaction by transaction ID](https://docs.nexiopay.com/reference/viewtransactiontransactionid) endpoint so that you get all the details for the transaction. Alternately, include the transaction ID value in the `id` or `transactionId` (within any object) query parameter in this endpoint along with any [additional response parameters](https://docs.nexiopay.com/docs/requesting-additional-response-parameters).

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).<br/><br/>You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.
> username: `docs@nexiopay.com`
> password: `JZdzoXpdDeH6VA`<br/><br/>When you use the test account, in order to avoid potential security issues, the system returns a set of test transactions. No other transactions that you may have run previously display in the results.


<div style="display:none;">

## Request parameters
- achDetailId
- amount
- authCode
- bankTransfer
- bankTransfer.account
- bankTransfer.checkNumber
- bankTransfer.id
- bankTransfer.routing
- bankTransfer.transactionId
- capturedDate
- cardNumber
- cardHolder
- cardType
- createdAt
- currencyId
- customer
- customer.company
- customer.customerRef
- customer.email
- customer.firstName
- customer.id
- customer.lastName
- customer.postalCode
- customer.phone
- customer.transactionId
- customerAddresses
- customerAddresses.billingAddressOne
- customerAddresses.billingAddressTwo
- customerAddresses.billingCity
- customerAddresses.billingCountry
- customerAddresses.billingPhone
- customerAddresses.billingPostalCode
- customerAddresses.billingState
- customerAddresses.shippingAddressOne
- customerAddresses.shippingAddressTwo
- customerAddresses.shippingCity
- customerAddresses.shippingCountry
- customerAddresses.shippingPhone
- customerAddresses.shippingPostalCode
- customerAddresses.shippingState
- customerAddresses.id
- customerAddresses.transactionId
- endDate
- foreignProcessingCurrency
- foreignProcessingCurrency.amount
- foreignProcessingCurrency.currencyId
- foreignProcessingCurrency.id
- foreignProcessingCurrency.transactionId
- gateway
- gateway.additionalRefNumber
- gateway.batchRef
- gateway.gatewayType
- gateway.id
- gateway.merchantId
- gateway.message
- gateway.trackingCode
- gateway.refNumber
- gateway.transactionId
- gateway.nsu
- id
- kount
- kount.counterCount
- kount.id
- kount.merc
- kount.mode
- kount.refNumber
- kount.ruleCount
- kount.rules
- kount.score
- kount.status
- kount.transactionId
- kount.velo
- kount.vmax
- kount.warningCount
- kount.wasDeviceFingerprinted
- linkedChargebackId
- merchantIds
- originalTransactionId
- plugin
- plugin.description
- plugin.id
- plugin.invoice
- plugin.orderNumber
- plugin.originalId
- plugin.paymentOptionTag
- plugin.pluginType
- plugin.transactionId
- plugin.userId
- processMethod
- processor
- processor.batchRef
- processor.id
- processor.originalId
- processor.processorType
- processor.transactionId
- processor.transactionRef
- reportDate
- settledDate
- startDate
- subscription
- subscription.accountId
- subscription.id
- subscription.initialBalance
- subscription.interval
- subscription.intervalCount
- subscription.remainingBalance
- subscription.scheduleType
- subscription.subscriptionRef
- subscription.transactionId
- transactionDate
- transactionDetails
- transactionDetails.clientIp
- transactionDetails.customFields
- transactionDetails.description
- transactionDetails.id
- transactionDetails.paymentType
- transactionDetails.retryCount
- transactionDetails.shoppingCart
- transactionDetails.transactionId
- transactionDetails.userName
- transactionStatus
- transactionType
- updatedAt
- limit
- offset

## Response parameters
- offset
- limit
- rows
- rows.id
- rows.merchantId
- rows.amount
- rows.transactionDate
- rows.transactionStatus
- rows.authCode
- rows.transactionType
- rows.cardType
- rows.cardNumber
- rows.cardHolder
- rows.processMethod
- rows.achDetailId
- rows.currencyId
- rows.reportDate
- rows.settledDate
- rows.capturedDate
- rows.originalTransactionId
- rows.createdAt
- rows.updatedAt
- rows.customer
- rows.customer.id
- rows.customer.firstName
- rows.customer.lastName
- rows.customer.postalCode
- rows.customer.phone
- rows.customer.email
- rows.customer.company
- rows.customer.customerRef
- rows.customer.transactionId
- rows.kount
- rows.kount.id
- rows.kount.status
- rows.kount.rules
- rows.kount.refNumber
- rows.kount.merc
- rows.kount.score
- rows.kount.ruleCount
- rows.kount.warningCount
- rows.kount.counterCount
- rows.kount.wasDeviceFingerprinted
- rows.kount.mode
- rows.kount.velo
- rows.kount.vmax
- rows.kount.transactionId
- rows.bankTransfer
- rows.bankTransfer.account
- rows.bankTransfer.checkNumber
- rows.bankTransfer.id
- rows.bankTransfer.routing
- rows.bankTransfer.transactionId
- rows.foreignProcessingCurrency
- rows.foreignProcessingCurrency.amount
- rows.foreignProcessingCurrency.currencyId
- rows.foreignProcessingCurrency.id
- rows.foreignProcessingCurrency.transactionId
- rows.threeDS
- rows.threeDS.id
- rows.threeDS.ECI
- rows.threeDS.type
- rows.threeDS.transactionId
- rows.gateway
- rows.gateway.gatewayName
- rows.gateway.refNumber
- rows.gateway.nsu
- rows.processor
- rows.processor.id
- rows.customerAddresses
- rows.customerAddresses.billingAddressOne
- rows.customerAddresses.billingAddressTwo
- rows.customerAddresses.billingCity
- rows.customerAddresses.billingCountry
- rows.customerAddresses.billingPhone
- rows.customerAddresses.billingPostal
- rows.customerAddresses.billingState
- rows.customerAddresses.shippingAddressOne
- rows.customerAddresses.shippingAddressTwo
- rows.customerAddresses.shippingCity
- rows.customerAddresses.shippingCountry
- rows.customerAddresses.shippingPhone
- rows.customerAddresses.shippingPostal
- rows.customerAddresses.shippingState
- rows.customerAddresses.id
- rows.customerAddresses.transactionId
- rows.subscription
- rows.subscription.id
- rows.subscription.accountId
- rows.subscription.initialBalance
- rows.subscription.interval
- rows.subscription.intervalCount
- rows.subscription.remainingBalance
- rows.subscription.scheduleType
- rows.subscription.subscriptionRef
- rows.subscription.transactionId
- rows.cardMetaData
- rows.cardMetaData.id
- rows.cardMetaData.bin
- rows.cardMetaData.cardBrand
- rows.cardMetaData.class
- rows.cardMetaData.countryCode
- rows.cardMetaData.currencyCode
- rows.cardMetaData.issuingBank
- rows.cardMetaData.transactionId
- rows.plugin
- rows.plugin.id
- rows.plugin.originalId
- rows.plugin.invoice
- rows.plugin.orderNumber
- rows.plugin.description
- rows.plugin.pluginType
- rows.plugin.paymentOptionTag
- rows.plugin.transactionId
- rows.transactionDetails
- rows.transactionDetails.id
- rows.transactionDetails.clientIp
- rows.transactionDetails.customFields
- rows.transactionDetails.description
- rows.transactionDetails.installments
- rows.transactionDetails.installmentUnit
- rows.transactionDetails.paymentType
- rows.transactionDetails.retryCount
- rows.transactionDetails.shoppingCart
- rows.transactionDetails.userName
- rows.transactionDetails.transactionId
- hasMore

</div>

## Query parameters

- `limit` integer
- `offset` integer
- `startDate` string
- `endDate` string
- `id` string
- `merchantIds` string
- `amount` number
- `authCode` string
- `transactionStatus` integer
- `transactionType` integer
- `cardType` 10 | 20 | 30 | 40 | 50
- `cardNumber` string
- `cardHolder` string
- `processMethod` integer
- `achDetailId` string
- `currencyId` string
- `originalTransactionId` integer
- `customer.` string
- `customer.id` integer
- `customer.firstName` string
- `customer.lastName` string
- `customer.postalCode` string
- `customer.phone` string
- `customer.email` string
- `customer.company` string
- `customer.customerRef` string
- `kount.` string
- `kount.id` integer
- `kount.status` string
- `kount.rules` string
- `kount.refNumber` string
- `kount.merc` string
- `kount.score` string
- `kount.ruleCount` integer
- `kount.warningCount` integer
- `kount.counterCount` integer
- `kount.wasDeviceFingerprinted` boolean
- `kount.mode` string
- `kount.velo` integer
- `kount.vmax` integer
- `bankTransfer.` string
- `bankTransfer.id` integer
- `bankTransfer.account` string
- `bankTransfer.routing` string
- `bankTransfer.checkNumber` string
- `plugin.` string
- `plugin.id` integer
- `plugin.originalId` string
- `plugin.invoice` string
- `plugin.orderNumber` string
- `plugin.description` string
- `plugin.userId` string
- `plugin.pluginType` integer
- `plugin.paymentOptionTag` string
- `foreignProcessingCurrency.` string
- `foreignProcessingCurrency.id` integer
- `foreignProcessingCurrency.amount` number
- `foreignProcessingCurrency.currencyId` string
- `gateway.` string
- `gateway.id` integer
- `transaction_gateway.nsu` string
- `gateway.merchantId` string
- `gateway.batchRef` string
- `gateway.refNumber` string
- `gateway.additionalRefNumber` string
- `gateway.trackingCode` string
- `gateway.gatewayType` integer
- `gateway.message` string
- `processor.` string
- `processor.id` integer
- `processor.transactionRef` string
- `processor.batchRef` string
- `processor.originalId` integer
- `processor.processorType` integer
- `customerAddresses.` string
- `customerAddresses.id` integer
- `customerAddresses.billingAddressOne` string
- `customerAddresses.billingAddressTwo` string
- `customerAddresses.billingCity` string
- `customerAddresses.billingState` string
- `customerAddresses.billingPostalCode` string
- `customerAddresses.billingCountry` string
- `customerAddresses.billingPhone` string
- `customerAddresses.shippingAddressOne` string
- `customerAddresses.shippingAddressTwo` string
- `customerAddresses.shippingCity` string
- `customerAddresses.shippingState` string
- `customerAddresses.shippingPostalCode` string
- `customerAddresses.shippingCountry` string
- `customerAddresses.shippingPhone` string
- `transactionDetails.` string
- `transactionDetails.id` integer
- `transactionDetails.description` string
- `transactionDetails.clientIp` string
- `transactionDetails.userName` string
- `transactionDetails.shoppingCart` string
- `transactionDetails.customFields` string
- `transactionDetails.retryCount` integer
- `transactionDetails.paymentType` string
- `subscription.` string
- `subscription.id` integer
- `subscription.remainingBalance` number
- `subscription.initialBalance` number
- `subscription.interval` 'day' | 'week' | 'month' | 'year'
- `subscription.intervalCount` integer
- `subscription.subscriptionRef` string
- `subscription.accountId` string
- `subscription.scheduleType` '10' | '20'

## Response `200`

Success

- object
  - `offset` integer — The starting point within the list of transactions. This is used in conjunction with the `limit` parameter to control which subset of transactions the API returns. For example, if `offset` is `10` and `limit` is `20`, the API skips the first 10 transactions and returns the next 20 transactions (in other words, transactions 11 to 30).
  - `limit` integer — The maximum number of transactions returned in the API response. For example, if `limit` is `20`, the API returned up to 20 transactions starting from the position indicated by the `offset` parameter.
  - `rows` object[] — An array of transactions
    - `id` Id — unresolved $ref
    - `merchantId` string — The merchant ID.
    - `amount` number — The transaction amount.
    - `transactionDate` string — The date and time, expressed in UTC, when the authorization happened.
    - `transactionStatus` integer — The Nexio [transaction status code](https://docs.nexiopay.com/docs/constant-transaction-values#transaction-status-transactionstatus).
    - `authCode` AuthCode — unresolved $ref
    - `transactionType` TransactionType — unresolved $ref
    - `cardType` CardType — unresolved $ref
    - `cardNumber` CardNumber — unresolved $ref
    - `cardHolder` CardHolder — unresolved $ref
    - `processMethod` integer — The process method code. For information about valid values, see the [processMethod table](https://docs.nexiopay.com/docs/constant-transaction-values#process-method-processmethod).
    - `achDetailId` string — The Deposit Detail ID that corresponds to this transaction.
    - `currencyId` CurrencyId — unresolved $ref
    - `reportDate` ReportDate — unresolved $ref
    - `settledDate` string — The date and time the transaction was settled.
    - `capturedDate` string — The date and time the transaction was captured.
    - `originalTransactionId` OriginalTransactionId — unresolved $ref
    - `createdAt` string — The date and time the transaction record was created in Nexio.
    - `updatedAt` string — The date and time at which the transaction record was most recently updated in Nexio.
    - `customer` object — Customer information, if provided when the transaction was processed. Will appear if `customer.` is included as a query parameter in the request.
      - `id` Id — unresolved $ref
      - `firstName` string — The customer's first name.
      - `lastName` string — The customer's last name.
      - `postalCode` string — The customer's postal code.
      - `phone` string — The customer's phone number.
      - `email` string — The customer's email address.
      - `company` string — The customer's company.
      - `customerRef` string — The merchant's unique identifier for a customer.
      - `transactionId` Id — unresolved $ref
    - `kount` Kount — unresolved $ref
    - `bankTransfer` BankTransfer — unresolved $ref
    - `foreignProcessingCurrency` ForeignProcessingCurrency — unresolved $ref
    - `threeDS` ThreeDS — unresolved $ref
    - `gateway` Gateway — unresolved $ref
    - `processor` Processor — unresolved $ref
    - `customerAddresses` CustomerAddresses — unresolved $ref
    - `subscription` Subscription — unresolved $ref
    - `cardMetaData` CardMetaData — unresolved $ref
    - `plugin` Plugin — unresolved $ref
    - `transactionDetails` TransactionDetails — unresolved $ref
  - `hasMore` boolean — Will be `true` if there are more records not included in the current response.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized. For help with this error and other error codes, see [Common errors](https://docs.nexiopay.com/docs/common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/payments-api-reference.md) · [All operations](https://skmtc.dev/nexiopay/apis/payments-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nexiopay/payments-api-reference/revisions/b414b73979e5/schema)
