Sign in
Retail

Process transaction from terminal

Initiates a transaction through a terminal through the Nexio API rather than using the retail iframe. For more information on how to use this endpoint, see the steps in Processing a transaction with a terminal in Guides.

You can also specify to save the card token from the terminal transaction so that you can use it for future transactions (through the Run card transaction endpoint).

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

You must also have a terminal connected to the Nexio account. For more information, see the Pair terminal or Register terminal endpoints.

<div style="display:none;">

Request parameters

  • data
  • data.amount
  • data.currency
  • data.customFields
  • data.customer
  • data.customer.customerRef
  • data.customer.orderNumber
  • data.customer.orderDate
  • data.customer.invoice
  • data.customer.firstName
  • data.customer.lastName
  • data.customer.birthDate
  • data.customer.nationalIdentificationNumber
  • data.customer.email
  • data.customer.phone
  • data.customer.billToAddressOne
  • data.customer.billToAddressTwo
  • data.customer.billToCity
  • data.customer.billToState
  • data.customer.billToPostal
  • data.customer.billToCountry
  • data.customer.billToPhone
  • data.customer.shipToAddressOne
  • data.customer.shipToAddressTwo
  • data.customer.shipToCity
  • data.customer.shipToState
  • data.customer.shipToPostal
  • data.customer.shipToCountry
  • data.customer.shipToPhone
  • data.description
  • data.lodging
  • data.lodging.advanceDeposit
  • data.lodging.checkInDate
  • data.lodging.checkOutDate
  • data.lodging.noShow
  • data.lodging.roomNumber
  • data.lodging.roomRate
  • terminalId
  • processingOptions.saveCardToken
  • isAuthOnly
  • card
  • card.cardHolderName

Response parameters

  • terminalRequestId
  • terminalRequestStatus
</div>
post/pay/v3/processFromTerminal

Request body

terminalIdstring required

An ID used to identify a specific terminal. For a list of terminal IDs, see the View terminal list endpoint.

isAuthOnlyboolean

Set to true to run an auth only transaction for the terminal.

clientIpstring

Specifies the IP address of where the request is coming from.

Response

Success

terminalRequestIdstring

An ID used to identify a transaction initiated using a terminal.

terminalRequestStatus'initialized' | 'pending' | 'success' | 'failed'

The status of the request to the terminal. This is not the same as the transactionStatus. For example, the terminalRequestStatus can be success but the transactionStatus can be declined because the system successfully sent and received a response from the terminal even though the gateway connection declined the payment.

randomRandomNnnn — unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.