Configuring your terminal for USAePay

In order to process a card present transaction with a terminal through USAePay, you need to set up your terminal and then pair it and process the transaction either with the iframe or with the API.

Setting up your terminal for pairing

📘

Note

After you have completed these steps once, you do not need to complete them again unless you want to change the terminal mode or reconfigure the internet connection.

  1. Power on the terminal.

    • If the terminal is not connected to the internet and is not paired, the main menu displays.
    • If the terminal is connected to the internet and is not paired, the pairing screen displays.

      Exit the pairing screen by pressing the red button until the main menu displays.
  2. From the main menu, press the correct buttons to go to Settings and then Mode Select. A menu with options for Production and SANDBOX displays.

  3. Select the mode.

    • If you are processing test transactions, select SANDBOX. An icon of a flask displays in the upper-left corner of the main menu screen.
    • If you are processing live transactions, select Production.

    After you select the mode, the system returns you to the Settings menu.

  4. From the Settings menu, select Connection Type. A menu with options for WiFi and Ethernet displays.

  5. Select WiFi or Ethernet.

    • If you select WiFi, return to the Settings menu by pressing the red button and select Rescan WiFi. When the terminal finds your desired network, select it and type the password. After you have connected to the WiFi, if the terminal is rebooted, it connects to the chosen network automatically.
    • If you select Ethernet and the cable is plugged in, the terminal is ready for pairing. Press the red button to get to the main screen.
  6. From the main screen, press the red button to get to the pairing screen.

You have successfully set up your terminal. Now that your terminal is connected to the internet, you can pair it and process a transaction with the iframe or with the API.

Pairing the terminal

With the iframe

In order to pair your terminal using Nexio's retail iframe, you must have completed setup.

📘

Note

After pairing completes, the connection is permanent until the device is unpaired or the pairing is removed in the USAePay portal.

  1. Authenticate through either of the following options:

  2. Load the retail iframe.

    • The retail iframe loads by default.
    • You may also select additional UI options as shown in the UI options table.
  3. From the Payment Method menu of the iframe, select Card (terminal).

  4. Click Add Terminal at the bottom of the iframe to open the Add Terminal dialog.

  5. Type the terminal name you want to use. If the name is longer than 12 characters, the terminal only displays 12 characters after the name is saved.

  6. Click Submit to save the name and close the dialog.

  7. Type the pairing code that appears in the iframe into your terminal.

  8. Wait until the iframe displays "Pairing Complete".

Now that you have paired your terminal via iframe, you can process a transaction by following the process below.

With the API

In order to pair your terminal using Nexio's retail iframe, you must have completed setup.

📘

Note

After pairing completes, the connection is permanent until the device is unpaired or the pairing is removed in the USAePay portal.

  1. Send a POST request to the Pair terminal endpoint. A successful request returns a response including a pairingCode.

    Example Request
    curl -X POST https://api.nexiopaysandbox.com/pay/v3/processFromTerminal \
      -H 'Content-Type: application/json' \
      -H 'Accept: application/json' \
      -H 'Authorization: Basic [Base64_encoded_login]'
      -d '{
      "data": {
        "merchantId": "100111",
        "terminalName": "FrontDesk1"
    }'
    
    Example 200 Response
    [
      {
        "terminalName": "FrontDesk1",
        "pairingCode": 712677,
        "expirationDate": "2022-01-31T10:09:33.000Z",
        "key": "sa_a04ZF6U2J99wwvAOzHtMOVzOm9WSb",
        "random-4611765": "6fec4a03-3a9f-40de-90bc-23a513ac904c"
      }
    ]
    

  2. Type the pairingCode from the response into the pairing screen of the terminal. If successful, the terminal displays the WELCOME screen and up to 12 characters of the terminalName.

  3. Send a GET request to the View terminal list endpoint. A successful request returns an array of terminal objects. These are the terminals currently enabled on your merchant ID.

    Example Request
    curl -X GET https://api.nexiopaysandbox.com/pay/v3/getTerminalList \
      -H 'Accept: application/json' \
      -H 'Authorization: Basic [Base64_encoded_login]'
    
    Example 200 Response
    [
      {
        "merchantId": "100111",
        "merchantName": "Merchant Name",
        "gatewayName": "usaepay",
        "gatewayType": 10,
        "gatewayLabel": "...5tjb",
        "terminalName": "FrontDesk1",
        "terminalSerialNumber":"000118205206486",
        "terminalKey": "sa_a04ZF6U2J99wwvAOzHtMOVzOm9WSb",
        "terminalStatus": "connected",
        "terminalId": "eyJtZXJjaGFudElkIjoiMTAwODg4IiwiZ2F0ZXdheUxhYmVsIjoiLi4uNXRqYiIsInRlcm1pbmFsIjp7ImlkIjoic2FfYTA0WkY2VTJKOTl3d3ZBT3pIdE1PVnpPbTlXU2IiLCJsb2NhdGlvbklkIjoiZm40eHJ2YmRyZzNqN3QzMjgifX0="
      }
    ]
    
  4. Confirm that the newly paired terminal is in the response.

Unpairing the terminal

  1. From the WELCOME screen, navigate to the main menu.
    • For the Vega3000 model, press and hold the 9 button for three seconds.
    • For the MP200 model, press and hold the down arrow button for three seconds.
  2. Go to Settings.
  3. Select Unpair Device.
  4. Press the green button to confirm.

Did this page help you?