Skip to main content

Getting Started

Follow these steps to get started with the Terminal API integration.

Become a partner
Check prerequisites
Gather Credentials
Prepare Environment
Install and Configure Terminal API
Next Steps - Go to Integration

Become a partner​

If you have not yet completed merchant onboarding or obtained your UMID and UTID, refer to Become a Partner page.

Check prerequisites​

Complete all prerequisites described below before proceeding with the integration.

  • Product: Worldline Terminal API (Nexo Retailer v5.1). Enables ECR to POI communications using JSON messages for payments, refunds, and more.
  • Intended audience: POS integrators and developers new to Terminal API.
  • Hardware: Payment terminal with Terminal API app and access to launcher; UMID/UTID supplied for configuration.
  • Software: Terminal API app installed on the terminal; access to the launcher and SmartPOS Store for installation.
  • Network: Terminal must be able to reach webhook endpoints for asynchronous processing; ensure TLS/HTTPS endpoints are reachable.
  • Credentials: UMID and UTID are required for initial configuration; ExchangeIdentification must be generated per message; webhook URL optional for asynchronous mode.
  • Permissions: Terminal API must be enabled in the merchant environment; ensure you can activate Terminal API in the terminal.
  • Environment: Decide between PRODUCTION (live) and INTEGRATION (test) environments before you begin.

Gather credentials​

If you have not yet obtained your merchant credentials, refer to Become a Partner.

What you need and why:

  • UMID/UTID values for your merchant and terminal to authenticate and route messages.
  • Environment selection (PRODUCTION or INTEGRATION) to direct traffic to the appropriate endpoints.
  • If using asynchronous communication, a publicly reachable webhook URL and a retry policy.
  • Access to the Terminal API app in the launcher and the ability to install/enable it if not already present.
  • A secure method to generate ExchangeIdentification values for message tracing.

Prepare environment​

  • Ensure your environment is configured to send JSON over HTTPS to the correct endpoint.
  • Set the base URL to the Integration environment: https://api.terminal.iacc.global.worldline-solutions.com (or as provided)
  • Ensure your HTTP client sends JSON (Content-Type: application/json) and accepts JSON (Accept: application/json)
  • Align clocks to ISO-8601 timing if your payload includes ISODateTime fields
  • If you will test webhooks later, prepare a publicly reachable HTTPS webhook endpoint

Install and configure Terminal API​

  • Access the launcher on the terminal:
    • Press the circle at the bottom of the screen to open the launcher.
    • If the circle is not visible, swipe up from the bottom to reveal the navigation menu.
  • Open the app store:
    • Swipe up to App Drawer.
    • Tap the “SmartPOS Store” app.

  • Install Terminal API:
    • In the All tab, tap the Terminal API cloud icon to download and install.

  • Initial configuration:
    • Open the Terminal API app from the launcher.
    • Enter the data provided to you (UMID and UTID) accurately.
    • Select the environment: PRODUCTION for live operations or INTEGRATION for testing.
    • Activate Terminal API (toggle) and verify the cloud icon turns green.
  • Next, you are ready to initiate communications with the Cloud.

Next steps​