---
title: "View terminal transaction status"
method: GET
path: "/pay/v3/processFromTerminal/{terminalRequestId}"
tags: ["Retail"]
---

# View terminal transaction status

`GET /pay/v3/processFromTerminal/{terminalRequestId}`

Checks the status of a transaction run through a terminal.

<!-- theme: warning -->
> ⚠️ Try It
> 
> To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](https://docs.nexiopay.com/docs/sandbox-environments).

<div style="display:none;">

## Request parameters
- terminalRequestId

## Response parameters
- gatewayResponse
- gatewayResponse.gatewayName
- currency
- transactionStatus
- terminal.token
- terminalRequestId
- authCode
- transactionType
- card
- card.cardType
- card.cardHolder
- card.cardNumber
- card.firstSix
- card.lastFour
- card.expirationMonth
- card.expirationYear
- processingOptions
- processingOptions.merchantId
- terminalRequestStatus
- data
- data.description
- data.amount
- data.currency
- data.cart
- data.cart.items
- data.cart.items.item
- data.cart.items.description
- data.cart.items.quantity
- data.cart.items.price
- data.cart.items.type
- data.customFields
- data.customFields.exampleKey
- data.customer
- data.customer.firstName
- data.customer.lastName
- data.customer.customerRef
- data.customer.orderNumber
- data.customer.invoice
- data.customer.email
- data.customer.phone
- data.customer.billToPhone
- data.customer.billToAddressOne
- data.customer.billToAddressTwo
- data.customer.billToCity
- data.customer.billToState
- data.customer.billToPostal
- data.customer.billToCountry
- data.customer.shipToPhone
- data.customer.shipToAddressOne
- data.customer.shipToAddressTwo
- data.customer.shipToCity
- data.customer.shipToState
- data.customer.shipToPostal
- data.customer.shipToCountry
- data.lodging
- data.lodging.advanceDeposit
- data.lodging.checkInDate
- data.lodging.checkOutDate
- data.lodging.noShow
- data.lodging.roomNumber
- data.lodging.roomRate
- amount
- transactionDate
- id (this is the paymentId)


</div>

## Path parameters

- `terminalRequestId` string, required

## Response `200`

Success.

- object
  - `terminalRequestId` TerminalRequestId — unresolved $ref
  - `terminalRequestStatus` TerminalRequestStatus — unresolved $ref
  - `id` Id — unresolved $ref
  - `transactionStatus` TransactionStatus — unresolved $ref
  - `transactionType` TransactionType — unresolved $ref
  - `transactionDate` TransactionDate — unresolved $ref
  - `dateCreated` string — The date and time when the record of this retail transaction was created, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.v
  - `dateLastModified` string — The date and time at which the record of this retail transaction was last modified, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.
  - `authCode` AuthCode — unresolved $ref
  - `currency` string — The [three-character ISO code](https://en.wikipedia.org/wiki/ISO_4217) for the currency used in the transaction. Retail transactions only support terminals wiithin the United States.
  - `amount` number — The transaction amount.
  - `card` object — Card information.
    - `cardHolder` string — May display the cardholder name or indicate that the name was manually entered. This value is returned directly from the gateway. **Note:** For terminal-based tokens, not all connectors return this value.
    - `cardNumber` string — The card number, with all but the first six and the last four digits masked.
    - `firstSix` string — The first six digits of the card number. This parameter only gets returned here if the retail transaction was through a terminal.
    - `lastFour` string — The last four digits of the card number. This parameter only gets returned here if the retail transaction was through a terminal.
    - `expirationMonth` string — The two-digit month in which the card will expire. This parameter only gets returned here if the retail transaction was through a terminal.
    - `expirationYear` string — The two-digit year in which the card will expire. This parameter only gets returned here if the retail transaction was through a terminal.
    - `cardType` CardType — unresolved $ref
  - `data` object — Transaction and customer data.
    - `amount` number — The transaction amount. The maximum value has 16 digits total, including up to two of those digits after the decimal point. If including a `surcharge`, this value needs to include the transaction amount plus the surcharge amount.
    - `currency` Currency — unresolved $ref
    - `customer` object — Customer information returned when checking fraud or from the processing gateway, when applicable.
      - `orderNumber` OrderNumber — unresolved $ref
      - `customerRef` CustomerRef — unresolved $ref
      - `invoice` Invoice — unresolved $ref
      - `firstName` FirstName — unresolved $ref
      - `lastName` LastName — unresolved $ref
      - `email` Email — unresolved $ref
      - `phone` Phone — unresolved $ref
      - `billToAddressOne` BillToAddressOne — unresolved $ref
      - `billToAddressTwo` BillToAddressTwo — unresolved $ref
      - `billToCity` BillToCity — unresolved $ref
      - `billToState` BillToState — unresolved $ref
      - `billToPostal` BillToPostal — unresolved $ref
      - `billToCountry` BillToCountry — unresolved $ref
      - `billToPhone` BillToPhone — unresolved $ref
      - `shipToAddressOne` ShipToAddressOne — unresolved $ref
      - `shipToAddressTwo` ShipToAddressTwo — unresolved $ref
      - `shipToCity` ShipToCity — unresolved $ref
      - `shipToState` ShipToState — unresolved $ref
      - `shipToPostal` ShipToPostal — unresolved $ref
      - `shipToCountry` ShipToCountry — unresolved $ref
      - `shipToPhone` ShipToPhone — unresolved $ref
    - `cart` object — Items purchased in the transaction.
      - `items` object[] — Details about items in the shopping cart.
        - `item` string — Item number or code.
        - `description` string — A description of the item.
        - `quantity` integer — The quantity sold.
        - `price` number — The price per item.
        - `type` TransactionType — unresolved $ref
    - `customFields` object — Information that was passed in custom fields in the request. Not all gateways or connections support custom fields.
      - `exampleKey` ExampleKey — unresolved $ref
      - `exampleRefNumber` ExampleRefNumber — unresolved $ref
    - `description` Description — unresolved $ref
    - `lodging` object — Lodging data (related to hotels, motels, inns, and so forth). For a tutorial on using lodging data, see [Getting started with hospitality](getting-started-with-hospitality) in Guides.
      - `advanceDeposit` boolean — Set to true if the customer paid a deposit in advance of their reservation.
      - `checkInDate` string — The customer's check-in date. Format YYYY-MM-DD.
      - `checkOutDate` string — The customer's check-out date. Format YYYY-MM-DD.
      - `noShow` boolean — Set to `true` if the customer failed to show up to their reservation.
      - `roomNumber` number — The customer's room number.
      - `roomRate` number — The room's rate, per day.
  - `processingOptions` object — Processing Options
    - `merchantId` MerchantId — unresolved $ref
  - `terminal` object — This object is only returned when `processingOptions.saveCardToken` is sent for the terminal transaction.
    - `token` string — The terminal token to be used for future payments with the retail payment flow. This parameter is only returned when `processingOptions.saveCardToken` is sent for the terminal transaction. For information about running that future transaction with this value, see the [Run card transaction](https://docs.nexiopay.com/reference/runcardtransaction) endpoint.
  - `gatewayResponse` 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.
  - `random` RandomNnnn — unresolved $ref

## 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.
- `490` — Error

---

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