POS

Overview

Integrate POS service to provide fast, accurate, and reliable payment processing. You can rely on it to track sales, manage inventory, and generate reports, all in one easy-to-use system. You can streamline transactions, improve efficiency, and offer a better customer experience.

Getting Started

To start testing our services, you need to have a sandbox account. Furthermore, it is crucial to onboard and configure your own terminal. Don't worry, we have made the process easy for you.

Terminal Onboarding Process

  • Get in Touch: Reach out to EveryPay’s tech team to initiate the terminal onboarding process. You will need to provide your business Name, you sandbox account email and your supported ERP provider.

  • Guided Setup: Our team will assist you with setting up your terminal. We'll handle all the procedures, making sure everything is configured correctly for your testing needs.

  • Receive Credentials: Once the onboarding is complete, you will receive a Terminal ID (TID), a Merchant ID (MID), and an authentication token. These credentials are essential for accessing our sandbox environment and testing our APIs.

Retrieve POS API Keys

Αfter completing onboarding process, it is time to get the API keys. Navigate to sandbox environment and click on button “Generate Key“ in the displayed screen, as it is shown in provided image below.

Screenshot

After this step, a new field in section “POS keys“ will be available as in the provided image. This is the POS API key you will be using from now on, for every request in POS API.

Screenshot

POS API Reference

You are now ready to use our POS service. You can find the complete POS API reference here

POS Emulator

For testing purposes, we have created a POS emulator that works on Windows, Mac and Linux. It allows integrating with POS service without the need to run an actual device.

VersionDateDownload
1.0.02024-05-28pos-emulator-v1-22-05-2024.zip
1.2.02024-09-05pos-emulator-v1-05-09-2024.zip
POS Emulator Changelog
  • 1.2.0: Added refund and void initiation capabilities
  • 1.0.0: Initial emulator version

Configure the Emulator

  1. Download and Extract: After downloading the desired for you, emulator version, extract the contents to a directory of your choice

  2. Open config.yml : Navigate to the extracted directory and locate the config.yml file.

  3. Edit Configuration: Open config.yml in your preferred text editor and update the following fields, with the credentials provided during terminal onboarding:

    • Listener Url
    • Listener Port
    • Terminal ID (TID)
    • Merchant ID (MID)
    • Authentication Token
    • Save the file after making the necessary changes

💡 Tip: Transactions with an amount equal to the failAmount specified in config.yml will result in a FAILED status. To ensure consistent simulation behavior, it is recommended to keep the failAmount parameter unchanged.

  1. Launch the Emulator
  • Windows: Execute the emulator_windows.exe file by double-clicking it.
  • MacOS:
    • Open Terminal.
    • Navigate to the directory containing the emulator executable ( cd path/to/emulator_folder ).
    • Change file permissions to executable using chmod +x pos-emulator-mac-amd-64
    • Run the command ./pos-emulator-mac-amd-64 to launch the emulator.
  • Linux:
    • Open Terminal.
    • Navigate to the directory containing the emulator executable.
    • Change file permissions to executable using chmod +x pos-emulator-linux-amd-64
    • Run the command ./pos-emulator-linux-amd-64 to launch the emulator.
Google Pay™ POS ERP Integration