Skip to main content

In-store payments

Integration set up with terminal

Last updated: 17-Jun-2022
Rate this article:

Overview

This guide provides instructions for integration setup utilizing Terminal in a Sandbox Environment. To proceed, follow the steps below.

Step 1: Obtaining API Keys

The recent update of Entity Service and Verifone Central makes it possible to generate the API Keys directly in the Admin Panel. 

To obtain the keys, perform the following.

  1. Ensure the valid user logs into the necessary site.
  2. Navigate to the user settings at the top right corner, and select the "API Keys" option from the dropdown menu.

    API Keys Menu Icon

  3. On the API Keys page, click the "Create API Key" button.

    Create API key

  4. To copy the key, click the "Copy public key" button and paste it to a safe location. Once the key has been copied, the success message will appear at the right bottom corner of your screen. Note: Your API key expiration period is one year.

    API Key Created

    API Keys Page

  5. Navigate back to the "My Account" page.

    My Account

  6. Locate your "user-uid" by highlighting and copying the rest of the URL in your browser's address field. See the screenshot below.

    Locating user-uid

Note! The expiration date of API Keys is one year from the date of activation. The system automatically sends email notifications every week during the last three months and every day during the last week before the expiration date.

Step 2: Encoding API Key

To encode API keys, follow the authentication method below.

  1. Indicate Authorization: Basic "user-uid:api key" in the header.
  2. Replace the "user-uid" and "api key" values with the necessary ones.
  3. Encode the whole string in base64.

For example:
The following "user-uid:api key" string 777c31b3-a85f-4823-93a5-9055d1b:cGEFFLjYuUCtmerXlhTfAdaPpYVnXDJZmg

results in a base64 Nzc3YzMxYjMtYTg1Zi00ODIzLTkzYTUtOTA1NWQxYjpjR0VGRkxqWXVVQ3RtZXJYbGhUZkFkYVBwWVZuWERKWm1n

Thus, the header should look like this:

Authorization: Basic Nzc3YzMxYjMtYTg1Zi00ODIzLTkzYTUtOTA1NWQxYjpjR0VGRkxqWXVVQ3RtZXJYbGhUZkFkYVBwWVZuWERKWm1n

Step 3: Setting up Basic Auth in Postman

To set up Basic Auth in Postman, perform the following. 
Additionally, you can create a new collection by downloading our OpenAPI specification file available here.

  1. Navigate to the GET Health check menu item on the Collections page.
  2. Click the Authorization menu item below the request URL field.
  3. Choose the Basic Auth option from the Type dropdown list.
  4. Paste your "user-uid" into the username field and "api key" into the password to send the request. See the screenshot below.

    Basic Auth in Postman

Step 4: Importing the Integrator Collection into Postman

  1. Download the Integrator Collection .zip archive.
  2. Unzip the archive.
  3. Locate the Integrator Collection.postman_collection.json file.
  4. Import the collection by using the File > Import menu option in Postman. See the screenshot below.

Importing Collection Postman

Step 5: Testing the API

  1. Select the Service Request under the Integrator Collection.
  2. Change the Authorization type to No Auth.  

    1
     

  3. On the Headers tab, add the Authorization item.
  4. Paste the Basic Auth token obtained in Step 2 into the value field.

    2
     

  5. Click Send and wait for a response from the POS Cloud server with a terminal status.
    Ensure the registered terminal details were provided in the response and the "POIState": "CONNECTED".
  6. Copy the POIID value. This is the name of the terminal provided during the registration.

    3
     

  7. Select the Payment to Simulator request under the Integrator Collection
  8. Change the Authorization type to No Auth.

    4
     

  9. On the Headers tab, add the Authorization item.
  10. Paste the Basic Auth token obtained in Step 2 into the value field and disable the x-terminal-simulator.

    5
     

  11. On the Body tab, paste the “POIID” copied on Step 6 to the “POIID” field -
  12. Click Send to send the request and complete the testing. The Success response status message appears.

    6

 

 

Rate this article:

Need help?

Do you have a question? On our Support page you will find a list with answers to frequently asked questions.
Did not find the answer you are looking for? Please contact us. We are happy to help.

Logo of Verifone