---
title: "View transaction by transaction ID"
method: GET
path: "/transaction/v3/{transactionId}"
tags: ["Transactions"]
---

# View transaction by transaction ID

`GET /transaction/v3/{transactionId}`

Searches for transactions with the given transaction ID. You get the transaction ID in the [webhook](https://docs.nexiopay.com/docs/webhook-body-examples#transaction-eventtype) with the `transactionId` (note that this parameter is not returned for legacy webhooks) or in the `id` returned in this endpoint or in the [View transaction by payment ID](https://docs.nexiopay.com/reference/viewtransactionpaymentid) or [View transactions](https://docs.nexiopay.com/reference/viewtransactions) endpoints.

You can use this endpoint instead of [View transactions](https://docs.nexiopay.com/reference/viewtransactions) when you only need to get information about a single transaction and in order to get all response parameters related to the transaction without needing to request them specifically.

<!-- 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.**
> - Transaction ID is <i>not</i> the same as the Nexio Payment ID, which is returned as `id` in the [Run card transaction](https://docs.nexiopay.com/reference/runcardtransaction) response.
> - Certain transaction data will be returned as numerical values. The definitions are provided in the [Constant transaction values tables](https://docs.nexiopay.com/docs/constant-transaction-values).

<!-- 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/>Include the transaction ID in the path parameter of the request.

<div style="display:none;">

## Request parameters
- transactionId

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

</div>

## Path parameters

- `transactionId` string, required

## Response `200`

Success

- object — Transaction information.
  - `id` integer — The transaction identifier. This is the same as the main ID of the transaction, also known as the Transaction ID. You can use this value in the [View transaction by transaction ID](https://docs.nexiopay.com/reference/viewtransactiontransactionid) endpoint. Or, you can use it in the [View transactions](https://docs.nexiopay.com/reference/viewtransactions) endpoint by incluing the value in the `id` or `transactionId` (within any object) query parameter.
  - `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` string — Represents a successfully authorized payment request. Not all [gateways or connections](https://docs.nexiopay.com/docs/connections) return a value for `authCode`, so Nexio recommends against using this for reconciliation or bookkeeping.
  - `transactionType` integer — The Nexio transaction type code.
  - `cardType` unknown
  - `cardNumber` string — The card number, with all but the first six and the last four digits masked.
  - `cardHolder` string — The cardholder's name as it appears on the card.
  - `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` string — The currency ID.
  - `reportDate` string, date-time — The date and time the transaction was reported.
  - `settledDate` string — The date and time the transaction was settled.
  - `capturedDate` string — The date and time the transaction was captured.
  - `originalTransactionId` integer — The original transaction ID of a refunded transaction. This is only available for refunded transactions.
  - `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` integer — Nexio's unique customer identifier.
    - `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` object — Fraud data and rules.
    - `id` integer — Nexio's unique identifier.
    - `status` string — Will be one of four possible statuses: `success`, `review`, `decline`, or `error`. See [Kount response status](https://docs.nexiopay.com/docs/understanding-the-kount-response) in Guides for more information.
    - `rules` string — Kount-specific information, including rules triggered. See our [Fraud tutorial](https://docs.nexiopay.com/docs/kount-verification) for more information.
    - `refNumber` string — The transaction reference number.
    - `merc` string — The Kount merchant ID (Different from Nexio's Merchant ID).
    - `score` string — The Kount fraud score.
    - `ruleCount` integer — The number of rules triggered.
    - `warningCount` integer — The number of warnings triggered.
    - `counterCount` integer — Custom Kount counter. For more information, see the [Kount documentation](https://support.kount.com/hc/en-us/articles/360045195372-Rule-and-Delta-Counters).
    - `wasDeviceFingerprinted` boolean — Will be `true` if the device was fingerprinted.
    - `mode` string — The Kount inquiry mode.
    - `velo` integer — The 14 day velocity. See [Kount's documentation](https://support.kount.com/hc/en-us/articles/360045237572-VELO-and-VMAX-Explained-) for more information.
    - `vmax` integer — The 6 hour rolling velocity. See [Kount's documentation](https://support.kount.com/hc/en-us/articles/360045237572-VELO-and-VMAX-Explained-) for more information.
    - `transactionId` integer — Kount's transaction ID.
  - `bankTransfer` object — The bank transfer data for the transaction.
    - `account` string — The masked account number for the bank record associated with an echeck payment used for the transaction. Only the last four numbers of the account display.
    - `checkNumber` string — The check number associated with an echeck payment used for the transaction.
    - `id` integer — The Nexio-generated unique identifier for the bank record associated with an echeck payment. This value is used for internal purposes.
    - `routing` string — The masked routing number for the bank record associated with an echeck payment used for the transaction.
    - `transactionId` Id — unresolved $ref
  - `foreignProcessingCurrency` object — The processing currency information for the transaction.
    - `amount` number — The amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point.
    - `currencyId` string — The [three-digit ISO numeric currency code](https://en.wikipedia.org/wiki/ISO_4217). For information about valid values, see the [currency table](https://docs.nexiopay.com/docs/constant-transaction-values#currency-id-currencyid) in Guides.
    - `id` Id — unresolved $ref
    - `transactionId` Id — unresolved $ref
  - `threeDS` object — Information used by the 3DS protocol to authenticate cardholder identity.
    - `id` Id — unresolved $ref
    - `ECI` string — The Electronic Commerce Indicator used to notify a merchant of cardholder authentication status.
    - `type` integer — The gateway type for 3DS.
    - `transactionId` Id — unresolved $ref
  - `gateway` object — Gateway-specific information. <b>Details will vary by gateway. Do NOT code to any information included in this object</b>.
    - `gatewayName` string — The name of the gateway.
    - `refNumber` string — The gateway's reference number.
    - `nsu` string — The system only returns this code for a transaction that uses the BRL currency through specific gateways or connections. If the system returns this parameter, you must save the value for compliance purposes.
  - `processor` object — Processor-specific information. Will appear if `processor.` is included as a query parameter in the request. <b>Details will vary by processor. Do NOT code to any information included in this object</b>.
    - `id` string — The Nexio-specific unique identifier for processor information about the transaction.
  - `customerAddresses` object — Billing and shipping address information for the customer.
    - `billingAddressOne` string — The street address for the customer.
    - `billingAddressTwo` string — Additional street address information.
    - `billingCity` string — The city for the address record.
    - `billingCountry` string — The country for the billing address.
    - `billingPhone` string — The billing phone number. This value is cached in the one-time-use token.
    - `billingPostal` string — The postal code on file with the card provider. This value is cached in the one-time-use token.
    - `billingState` string — The state or province on file.
    - `shippingAddressOne` string — The shipping address, if different from the billing address. This value is cached in the one-time-use token.
    - `shippingAddressTwo` BillingAddressTwo — unresolved $ref
    - `shippingCity` string — The shipping city. This value is cached in the one-time-use token.
    - `shippingCountry` string — The country for the shipping address.
    - `shippingPhone` string — The shipping phone number. This value is cached in the one-time-use token.
    - `shippingPostal` ShippingPhone — unresolved $ref
    - `shippingState` string — The shipping state or province.
    - `id` integer — Nexio's unique identifier for the customer address record.
    - `transactionId` Id — unresolved $ref
  - `subscription` object — The subscription data for the transaction.
    - `id` integer — Nexio's unique identifier for the subscription.
    - `accountId` string — Identifier for the Nexio account running the subscription.
    - `initialBalance` number — The starting balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.
    - `interval` string — The schedule's time period.
    - `intervalCount` integer — **Conditionally required**. The number of times the `interval` will pass between transactions. The maximum schedule interval length is one year. An `intervalCount` of `0` means that only one transaction runs. This value must be greater than or equal to 0. If not specified in the request, the system defaults to `0`. See the [subscription schedule examples table](https://docs.nexiopay.com/docs/getting-started-with-subscriptions#subscription-schedule-examples-table) for examples of how the interval and interval count create the subscription schedule.
    - `remainingBalance` number — The current balance of the pay plan. The maximum value has 16 digits total, including up to two of those digits after the decimal point.
    - `scheduleType` integer — Type of schedule, given as an integer for whether the schedule is for a subscription (10) or a payment plan (20). For more information on how recurring billing works, see the [Recurring billing overview](https://docs.nexiopay.com/docs/recurring-billing-overview) in Guides.
    - `subscriptionRef` string — Reference number from the merchant for the subscription.
    - `transactionId` Id — unresolved $ref
  - `cardMetaData` object — The metadata for the card used in the transaction.
    - `id` integer — Nexio's unique identifier for the card.
    - `bin` string — The first six digits of the card.
    - `cardBrand` string — The brand of the card.
    - `class` integer — Nexio's identifier for the type of card. For information about valid values, see the [class](https://docs.nexiopay.com/docs/constant-transaction-values#class-class) table in Guides.
    - `countryCode` string — The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the card.
    - `currencyCode` string — The [three-character ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) for the card.
    - `issuingBank` string — The bank that issued the card.
    - `transactionId` Id — unresolved $ref
  - `plugin` object — Plugin-specific details. Will appear if `plugin.` is included as a query parameter in the request.
    - `id` integer — Nexio's plugin ID.
    - `originalId` string — The Payment ID of the transaction.
    - `invoice` string — The invoice number.
    - `orderNumber` string — The order number.
    - `description` string — The order description.
    - `userId` string — The user ID.
    - `pluginType` integer — Nexio's plugin type.
    - `paymentOptionTag` string — A custom value used to route transactions to a specific gateway or merchant account. This value is cached in the one-time-use token. Contact [Integrations Support](https://docs.nexiopay.com/page/contact-us) to designate a `paymentOptionTag` for a given merchant account.
    - `transactionId` Id — unresolved $ref
  - `transactionDetails` object — The details for the transaction.
    - `id` integer — The unique identifier for the transaction details.
    - `clientIp` string — The IP address of where the transaction occurred.
    - `customFields` string — Stringified version of the `customFields` object for the transaction.
    - `description` string — The description of the transaction.
    - `installments` integer — The number of installment periods.
    - `installmentUnit` string — The time frame of installment periods.
    - `paymentType` 'initialScheduled' | 'initialUnscheduled' | 'scheduled' | 'unscheduledCit' | 'unscheduledMit' | 'initialMoto' — The type of transaction being processed using stored payment credentials. For more information about this parameter and when to use each option, see the [Payment type (paymentType) reference table](https://docs.nexiopay.com/docs/constant-transaction-values#payment-type-paymenttype) in Guides.
    - `retryCount` integer — The number of retries for the transaction.
    - `shoppingCart` string — Stringified version of the `shoppingCart` object for the transaction.
    - `userName` string — User name of the API user for the transaction.
    - `transactionId` Id — unresolved $ref
  - `linkedChargebackId` integer — Indicates the chargeback ID, if applicable. The value is `NULL` if the system does not find a chargeback for the transaction. However, if the system does find an associated chargeback, the system returns the chargeback ID in this parameter. Find out more about the chargeback with the [View a chargeback](https://docs.nexiopay.com/reference/viewchargeback) endpoint.

## Other responses

- `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)