for developers and administrators
User Interface Reference
Resources (Directory Structure)
Zip and Country Codes
Supported Providers (Banks & Networks)
UniPay Codes & Code Mappings
Integrated 3rd Party Libraries
Diagrams and Documents
Terminal Order Management Guide v1.4
Added on: 12/19/16
Updated on: 06/20/19
Table of Contents
This guide gives information about how a terminal order is created and how corresponding terminal settings should be set; how the fulfillment of the terminal, including the installation of software and security features, is done; how the terminal is delivered to the merchant and how it is maintained to work properly.
This guide is intended for Terminal Order (TO) Managers that provide associated merchants with terminals through the gateway as well as for departments that provide further terminal support.
The terminal ordering process involves three parts: a
is a device that is used for processing of card transactions. To obtain a terminal it is necessary to place a terminal order. A
is an object within the system that stores all necessary information about the ordered terminal(s), including fulfillment and delivery settings. All these settings are needed for the fulfillment center to fulfill a terminal. A
is a department within the gateway owner’s company or an external service provider.
The entire life cycle of a terminal order looks as follows:
1) TO Manager creates a terminal. Future order has to be attached to a particular terminal, which has to be created in advance.
2) TO Manager creates and approves a terminal order on behalf of a merchant.
3) Approval notification is sent to both the TO Manager and the merchant.
4) Order is submitted to the fulfillment center via a request file. A status of the request file can be checked in the gateway.
5) Fulfillment of the terminal is done. During this process, a payment software and injection keys are uploaded as well as the terminal’s configurations are set.
6) Terminal is passed from the fulfillment center to the mail service for delivery.
7) Order details and tracking information are returned to the gateway via a response file. A status of the response file can be checked in the gateway.
8) Shipment notification is sent to both the TO Manager and the merchant.
9) Terminal is delivered to the merchant.
10) Merchant activates the terminal. To activate the terminal, merchant uses information from the sticker placed on the terminal.
Terminal ordering includes three main processes:
creation of an order
Creation of an order
is done by a
to define settings that are applied to the terminal during the subsequent fulfillment.
includes installation of the settings applied in the terminal order, necessary software and injection keys that are installed for security purposes to a terminal. Shipping of the fulfilled terminals to the respective merchants is also a part of the fulfillment process.
includes updating of the terminal software, diagnostic of the terminal processing issues and terminal logs analysis.
Also, to manage terminal ordering process, two modules are used -
Fulfillment Management System(FMS)
Terminal Management System (TMS)
is the module within the gateway that is responsible for fulfillment and shipping of an order based on the applied settings.
is the module within the gateway that maintains specific configurations set for a terminal and uploads updates for both manufacturer’s and third party’s installed software.
We will explain the process of terminal order creation, fulfillment and post-ordering maintenance with the help of use cases. For our use cases, we will use the following examples:
– a convenience store that accepts one-time payments. It is represented as a merchant within the gateway.
– a chain of fitness centers that accepts recurring payments. It is represented as a merchant within the gateway.
– a company that provides franchises to open fitness centers under its brand. It is represented as a reseller within the gateway.
– an independent store that accepts one-time payments. It is represented as a merchant within the gateway.
– a POS software development company. It is represented as a reseller within the gateway.
– a POS software development company. It is represented as a reseller within the gateway.
– a POS software development company that provides its services to MiniShop Store and SuperGym. It is represented as a reseller within the system.
Pay Solutions Inc.
– a payment service provider that provides a technical platform for processing transactions. It is represented as a portfolio within the system.
Major Fulfullment Inc.
– a service provider that provides a technical platform for terminal fulfillment. It is represented as a fulfillment center within the system.
You can review detailed information about terminal ordering participants, processes and associated functionalities in the sections below.
is a device that is used for processing of EMV and swipe card transactions. Within the gateway, it is an entity that represents information related to a particular physical terminal as well as set up settings of this terminal.
Reading and processing of chip cards are impossible without a physical terminal. In the past, terminals were not required for processing card-present transactions. A merchant could use a card reader device for this purpose (for example, ID TECH). But in 2015, EMV card processing became mandatory for merchants that operate in industries that require a card to be present for payment.
During fulfillment and post-ordering processes, a terminal obtains an owner within the system – a merchant. To receive a terminal, a merchant must create a terminal order – an entity that stores information about settings and configurations for the ordered terminal. After the terminal order is fulfilled and a merchant receives its terminal, a terminal is managed by TMS.
From the moment of creation of the terminal record within the system, the terminal acquires different statuses, depending on the lifecycle of the associated terminal order and its post-ordering state.
is an indicator that shows the state of a particular terminal within the system.
The possible statuses of the terminal are the following:
– indicates that an active terminal record has no physical device associated yet and a virtual terminal is currently used by a merchant. At this status, a terminal order (purchase, exchange or return) for this terminal record can be created. When a terminal is in unassigned status, no status changes are available via the user interface.
– indicates that a particular terminal record is used and is associated with the physical device, which is pending fulfillment and deployment. At this status, a corresponding terminal order is created within the system.
– indicates that the terminal record is created and the physical device is at the fulfillment facility being prepared for deployment. At this status, a virtual terminal is used and associated order cancellation is allowed.
– indicates that the terminal record is active with a respective terminal device connected. A physical device is provisioned and ready for deployment. At this status, a terminal is locked and no re-provisioning is allowed.
– indicates that a terminal record is active within the system and the associated physical device has been registered and activated. At this status, the terminal can be manually assigned with
status via the user interface.
– indicates that the physical device is in merchant possession, but the terminal record within the gateway has been deactivated and the physical device cannot be used. At this status, a terminal record can be re-activated.
– indicates that the terminal record is getting reassigned from one physical device to another. At this status, a virtual terminal is used.
– indicates that the physical device is in merchant possession, but it is disconnected from the terminal record because the record has been deactivated within the gateway. When disconnected, a terminal record cannot be reactivated and settings of the physical device are set to default. If the physical device is going to be used again, it can be injected with the same injection key during fulfillment.
In addition, there are two statuses that can be assigned to the terminals created within the merchant onboarding process:
' - indicates that the terminal record has been created within the gateway, terminal creation request has been submitted to the processor and awaiting a response. Once the processor’s response is received, the terminal status is changed either to
(request rejected, Terminal ID not obtained) or
(Terminal ID provided by the processor) status. When a terminal is in Onboarding status, no status changes are available.
- indicates that the request for terminal registration has been declined by the processor. When a terminal is in Discarded status, the order for a physical device cannot be created, and no further status changes are available.
Depending on which status a terminal is in, there are actions that can be applied to it. These actions are divided in two groups:
Terminal order actions
- actions that are available when the terminal is being under the fulfillment process;
- actions that are available when the terminal is delivered to a merchant and is ready for transaction processing.
These actions are listed in the tables below. Please note that you can apply no actions to the highlighted statuses.
Terminal order actions:
Cancel Terminal Order
Migrate Terminal (in development)
х - destination terminal
x - source terminal
In case the terminal was created within the onboarding process, it can be
activated or deactivated
via onboarding API call:
. This action can be applied to the following statuses.
Activate/Deactivate Terminal via Onboarding API
is a way a terminal device is used. Depending on the needs of a merchant, there are four types of terminals:
- a terminal record instance that allows merchants to accept card-not-present transactions without a physical device;
- a physical device instance that allows merchants to accept card-present chip and swipe transactions;
– a physical device represented as a self-service kiosk;
Automated Fuel Pump
– a physical device that is represented as a fuel pump at a gas station.
Before becoming a General POS, kiosk or automated fuel pump and obtaining a physical representation, a terminal has a terminal record within the gateway that is represented as a
In the past, all legacy systems worked only with physical terminals to process card transactions, but after the Internet became a mandatory part of business and providing the opportunity to pay by phone and Internet became advantageous, transactions without a physical terminal became necessary. That is why a representation for virtual terminals within the gateway is needed.
Virtual terminal within the gateway can be used in two ways – as a representation of the virtual terminal or as a placeholder that will be associated eventually with a physical device. In the second case, a virtual terminal is used for transaction processing before the terminal order is shipped to a merchant.
For cases when a General POS terminal is planned to be used, it is needed to choose a terminal model.
indicates the physical terminal being used and determines what functionality it can provide. It is important for a merchant to analyze what terminal functionality is required for business before purchasing a terminal model because it must correspond with business needs.
To learn more about terminal models supported by the gateway, review
For small businesses that use their own POS to sell goods, it is enough to buy a terminal that performs basic functions and prints receipts, and good models are available for no more than $200 to $300.
For big businesses that use POS and provide goods and/or services, more advanced terminals are recommended. In such businesses, transaction processing sometimes requires filling out a specific form (for example, a membership agreement) or signing a document. That is why a terminal with a touch screen is recommended. Additionally, if receipt printing is done through the POS, it is not necessary to buy a terminal that prints receipts.
For independent sellers that are not connected to a POS, recommendations vary depending on their business needs. For example, a fair seller needs a common terminal that prints receipts, but a taxi driver needs a multi-function terminal because they face situations where a wide range of functions that are usually performed by POS are needed. Terminals with a touchscreen can be used for this purpose because they have advanced facilities and functionality that are usually provided via a POS.
is a convenience store that needs a terminal to process card present transactions. As this is a small business with a limited budget, it doesn’t have POS and doesn't need an advanced terminal for signing receipts using the terminal screen. It only needs to accept card payments and print receipts with a terminal that works as a standalone device and connects to a power outlet. For this reason, a terminal that best fits its needs is a terminal that has only basic functionality. For example, the Ingenico iCT220/250 is a smart choice.
is an independent seller that sells its products at fairs and is going to process card-present transactions. Just as with
, it has a very tight budget and doesn't have POS. However, it has no possibility of connecting the terminal to a power outlet. Consequently, it doesn't need an advanced terminal that can handle sign-up agreement details through the screen. It needs a terminal that can be used in standalone mode and supports connection to a mobile device. For this reason, a terminal that meets its needs is a terminal that uses Bluetooth to connect with mobile devices to accept payments. For example, the Ingenico iSMP works well in this case.
is a large chain of fitness centers that, just like
, is going to process card-present transactions. But unlike them,
is a highly profitable company that operates via POS system. This company doesn’t need to print receipts via the terminal; it needs to capture signatures right from the terminal screen. More importantly, the terminal it chooses should be managed by POS, powered from standard electrical power and have a big color display to promote its services and special offers to its clients. Given the company’s needs, the terminal that fits best is an advanced terminal, such as Verifone MX 925 or Ingenico iSC 250/350/480, which feature large touchscreens so club members can sign agreements right on the screen.
Every terminal model must have an operation mode set up to satisfy the specific needs of the merchant’s business.
determines how terminal processing is controlled. The terminal mode is selected for each terminal individually. Currently,
modes are supported within the system. Selection of a terminal's operation mode affects whether integration with the gateway is required or not.
mode is used when integration with POS is necessary and a terminal is controlled indirectly by the operator through POS. Cloud is a new approach that allows integration with POS without DLL libraries and associated drivers being installed. This is useful because in some cases, merchants don’t have an on-site IT team to install drivers or web services to allow DLL communications.
DLL (Dynamic-link library)
is a collection of small programs, any of which can be called when needed by POS. Traditionally, terminals connected with POS through serial and USB ports. This required the installation of specific software on the hardware with the POS to send tasks and receive data in the corresponding format. To avoid installation of the additional software components, the Cloud mode was designed. A cloud-based terminal connects directly to the cloud through the router without connection to a workstation, and all calls from POS are received through the cloud. As the cloud mode imposes that terminal is controlled indirectly through POS, it means that transaction commands are sent to the terminal from POS.
You can learn more about the operating mechanism of cloud integration in
mode is used when integration with POS is not necessary and a terminal is controlled directly by the operator. To send a command for a transaction to the terminal, follow these instructions:
button on the terminal keypad.
2. Enter appropriate amount.
3. Select form of the payment (payment card/direct debit).
4. Select the way to run a sale (Swipe/Insert the card, manual entry or cash).
5. Run the transaction and receive response code on the terminal screen.
6. Get a receipt.
Cloud mode is suitable for retail stores, fitness centers, restaurants and other businesses where a cashier desk with a POS system is used.
Standalone mode is suitable for independent sellers that do not have a POS system to register payments – such as taxi drivers or sellers at fairs or trade shows.
has its own POS system and is going to process terminal transactions. To process transactions through the terminal, this terminal should be managed by
POS system without human intervention. To achieve this, the POS system should be integrated with the terminal. For this purpose, the integration between the POS system and the terminal is done via cloud mode.
that trades individually is also going to process terminal transactions. It uses a simple POS system that prints receipts only. This POS system cannot be integrated with a terminal, and the salesperson has to process transactions by manually entering them on the terminal. As
does not need its POS system to be integrated with the terminal, its terminal will operate in standalone mode.
To process transactions, a terminal needs specific software installed that is right for the processing mode.
is software uploaded for processing transactions and fulfilling various tasks on a terminal. It is responsible for programming and updating the hardware. A terminal cannot operate without it. There are two purposes for the terminal: to provide a device for working with transactions and processing and to process the actual transactions.
To deal with these tasks, there are two types of terminal software:
(for example, Ingenico) is used to have and access to and operate physical built-in hardware (keyboard, card reader, etc.) and related functionality. This software cannot be customized.
is used to fulfill business tasks via a terminal, such as processing transactions, printing customized receipts, etc. This software can be customized to correspond the individual needs of the client.
When in fulfillment, a fulfillment center installs manufacturer software first, then payment software provided by the gateway is installed. Before the installation, payment software should be signed by the responsible person on the client’s side. For this purpose, a designated toolkit is used – a specific terminal that is used only for validation of the application code. After the application is validated by a client, it is sent to the fulfillment center for subsequent provisioning of the terminals.
An unassigned application cannot be installed on the terminal used in the production environment. Terminals with unassigned applications, called mock-up terminals, can be used for testing purposes only.
Note, that along with a signing toolkit, a magic box is required for the terminal to get connected to the Internet.
If it is necessary to perform only basic operations that do not require extra features and no customization is necessary, the manufacturer software is enough. However, if a merchant desires to use extended functionality to meet specific business needs, third-party software should be installed.
To learn more about the steps for manually installing terminal software, you can request the respective document from terminal support.
are a combination of terminal settings, the main purpose of which is to regulate terminal behavior depending on the supported functionality of the terminal and the business needs of a merchant.
Configurations setup is available at two levels: the fulfillment center associated with a particular portfolio and the reseller. Terminal configurations can be set up individually for either fulfillment center or a particular
. In this case, the overriding mechanism is applied, i.e. the configurations of a lower entity override the default ones.
If configurations are changed, these changes are not applied immediately but at a predetermined time of a day, usually at midnight for both planned and urgent updates. This is done so that a terminal will work properly and transaction processing is not interrupted.
You can review a full list of parameters available for terminal configurations in the TMS parameters integration
has ordered a terminal from
without configuration for AmEx card process because this
considers the cost of processing this type of cards too high. But since this merchant’s customers have expressed a desire to pay for purchases with AmEx cards,
decides to enable processing of these cards.
sends a request to
adds this configuration parameter to the terminals of
at the reseller level.
are the keys that encrypt and decrypt data within a terminal. They are necessary for the increased security of the terminal during usage.
There are three kinds of keys that can be used in terminals:
– used for
of PIN value associated with customer's credit card.
- used for encryption of message authentication code (MAC) data block. MAC is used for Canadian transactions only.
- used for point-to-point encryption of EMV and track data.
Depending on what encryption key type is used in the terminal, its algorithm can be
When one key is used for both encryption and decryption, it is the
symmetric encryption algorithm (AES/3DES)
. Symmetric encryption is easier to decrypt, but the fulfillment center provides an additional level of security for terminals with symmetric keys. To fulfill the process of AES/3DES key uploading into a terminal, a special injection facility is needed. AES/3DES can be used for PIN, session and P2PE keys.
When two keys – a public key (for encryption) and a private key (for decryption) – are used, it is
asymmetric encryption algorithm (RSA)
. To upload an RSA key, an injection facility is not needed.
RSA keys can be used for P2PE keys. If an emitting bank supports RSA, then RSA encryption can be also used for PIN keys.
Injection keys are set up for encryption of data for each particular processor. Each injection key is assigned to the specific processor’s profile. Only one key can be injected to a terminal. If it is needed to process terminal transactions by more than one processor, separate terminals, injected with corresponding keys, are required.
Within the gateway, injection keys are chosen before the fulfillment of an order to indicate to the fulfillment center which keys must be installed in the terminal.
Pay Solutions Inc.
wants to provide its clients the ability to process card-present transactions via terminals. Because terminals have to be fulfilled,
Pay Solutions Inc.
has two options: to create its own fulfillment department or integrate with a specific fulfillment service provider.
As a mandatory part of the fulfillment process,
Pay Solutions Inc.
must inject terminals with keys. Injected symmetric (AES/3DES) keys are more vulnerable to fraud attacks than asymmetric (RSA) keys because with symmetric encryption the same key is used for encryption and decryption of sensitive data. The correct security level must be reached by
Pay Solutions Inc.
for it to have access to the keys while fulfilling terminals on its own. This means that
Pay Solutions Inc.
must pass a corresponding certification that is costly and can take some time to complete.
To avoid this situation, integration with
Major Fulfillment Inc.
, a certified fulfillment center, is recommended for
Pay Solutions Inc.
After the fulfillment processes are done and the terminal is delivered to the merchant, it is maintained through the Terminal Management System.
Terminal Management System (TMS)
is a module within the gateway that maintains a specific configuration set for a terminal and uploads updates for both manufacturer’s and installed third-party software. TMS makes it possible for terminal software to work properly and get updated. The updates are usually planned in advance and have a certain schedule, but urgent updates can also be done, if needed, through TMS. Along with software updates, TMS regulates how terminals should be configured.
To have a terminal connected to TMS host, 443 port is used. Terminal connects using IP-address that is obtained by a domain name stored in terminal parameters with network settings.
Also, TMS is responsible for identification of a particular terminal, using a unique sticker for each piece of hardware with terminal credentials.
is a unique record with a collection of assigned credentials for a particular terminal. Stickers are placed on a physical terminal and include specific data that helps to identify a terminal and provide quick and easy access to terminal credentials. This data usually includes the terminal activation key, terminal key (a combination of the merchant ID (MID) of the merchant that received the terminal and terminal ID (TID) of the specific terminal) and terminal reference code (a combination of the account reference code and terminal reference code within a merchant’s system).
Also, the sticker includes the support phone number so that a merchant can immediately contact a support team if any problems occur with a terminal.
Pay Solutions Inc.
distributes terminals through its resellers,
develops POS software for restaurants;
develops POS software for supermarkets.
provide terminals to their merchants. When any processing issues occur with the terminals, merchants must call terminal support associated with the reseller that provided the terminal to address the issue to the first level of support. For this purpose, the contact phone number of the reseller associated with the merchant is located on each terminal’s sticker. If the problem cannot be solved at the reseller level, it will be elevated by the reseller to a payment service provider, the second level of support.
When support is requested, a terminal should be identified within the reseller’s system and, in some cases, within the payment service provider’s system. For different systems, different identifiers are used: the terminal reference code is used for the reseller’s system and the terminal key is used for the payment service provider’s system. Both the terminal reference code and the terminal key are placed on the terminal’s sticker along with the support contact phone number.
The fulfillment center
is a service provider or a department within the gateway owner’s company. The purpose of a fulfillment center is to fulfill a terminal order, which includes the creation of a terminal order, installment of software, injection keys and configurations, monitoring of the order's lifecycle and delivery of the terminal order to the merchant. Within the gateway, it is a virtual representation of a fulfillment center that allows for creating and maintaining terminal orders.
As a rule, a terminal manufacturer (for example, Ingenico) or a gateway usually do not provide fulfillment services associated with physical devices. It is inconvenient to work with a large number of merchants, so makers prefer to deal with vendors which are referred to as fulfillment centers.
To fulfill a terminal, a fulfillment center must be created within the system under a certain portfolio. This fulfillment center can be used by a reseller or a merchant to place terminal orders. When a terminal order is approved and submitted to the fulfillment center, assigned terminals are fulfilled by a fulfillment center. Once fulfillment is done, the ordered terminals are shipped to the merchant.
Fulfillment can be done in two ways:
by a gateway owner
- an existing fulfillment department associated with the gateway that executes fulfillment of terminal orders;
by an external company
- a third-party service provider that executes fulfillment of terminal orders.
Whether fulfillment is done by the gateway owner or an external company, the fulfillment process is similar.
Fulfillment Management System
The Fulfillment Management System (FMS)
is a module within the gateway that is responsible for fulfillment and shipping of an order based on the applied settings. It also includes tracking of the lifecycle of a particular terminal order, reviewing of statistics of terminal orders and monitoring of the fulfillment process. The module manages all order regulated operations: the creation of terminal configurations and order settings, terminal order processing and submitting the order to a fulfillment center where terminal software, configurations, and injection keys are installed.
A terminal order
is an object within the system that stores all necessary information about the ordered terminal(s), including fulfillment and delivery settings. In the real world, terminal orders are orders of terminals that process both EMV and swipe card transactions.
In the past, terminals were not required to process card-present transactions. A merchant could use a card reader device for this purpose (for example, ID TECH). But starting 2015, EMV card processing became mandatory for merchants that operate in industries that require a card to be present for a payment. Reading and processing of chip cards is impossible without a physical terminal. Thus, a problem for merchants emerged: how to order a terminal. The terminal order object within the system manages this task.
The terminal ordering object goes through the lifecycle of the ordering process. It can include settings for one or several terminals. An order is created for a
, but a
can place the terminal order for subsequent reselling to the attached merchants. If, for example, there are no resellers present as entities within the system, a portfolio can be an entity that places a terminal order for subsequent reselling to the attached merchants.
After the order is created, it is sent to the fulfillment center - an entity within the system that is responsible for fulfillment of the terminals that are included in the terminal order. A terminal order is submitted to the fulfillment center as a request file. The result of the order is retrieved via a response file.
As with any object within the system, a terminal order obtains different statuses during the terminal ordering process.
is an indicator that shows in which phase a terminal order currently is. A set of statuses represents a lifecycle of an order. While an order is being processed within the system, it acquires different statuses to keep participants in the process up to date.
Available order statuses are the following:
– the order has been terminated during the creation process by a gateway manager.
– the order has been submitted to the system by a gateway manager and is ready for subsequent review.
– the order has been canceled by a submitter for some reason before the submission to the fulfillment center. After the order has been canceled, a status of the terminal in the order is put to
– the order has been reopened by a submitter as a result of a review for some changes to be made. The order can be reopened only before being approved.
– the order has been successfully modified after being reopened.
– the order has been reviewed and approved for submission to the fulfillment center.
– the order has been sent to the fulfillment center for all required installations (applicable both in cases when a fulfillment center is used and when fulfillment is done by the gateway). Note that when the fulfillment center is a department of the gateway, the order obtains this status after it is created.
– the order has failed during the fulfillment process.
– the order has been successfully processed.
– the order has been shipped to the merchant.
- the order has been returned by a submitter.
For each order, it is possible to review the entire status history in order details.
regulates on what terms a merchant obtains terminal(s). Within the gateway, there is an opportunity not only to buy a terminal but also to exchange or return it if it was ordered and activated within the system and if it malfunctions or defects are present.
Within the gateway, three types of orders are represented:
– a merchant buys or rents a new terminal.
– a merchant exchanges one terminal for another. For the exchange option to be available, another terminal has to be ordered and activated within the gateway. Exchange can only be done if a previously purchased terminal has a defect, malfunction or has been injected with a wrong injection key. Note that some fulfillment centers have a specific period during which the exchange of a terminal can be done. After this period, this option is unavailable.
– a merchant returns a terminal to a fulfillment center and receives their payment back. This can be done if a merchant does not want to use a previously purchased terminal because of its physical features or if it is not required for processing anymore. Note that some fulfillment centers have a specific period during which the exchange of a terminal can be done. After this period, this option is unavailable.
The way a merchant pays for an order depends on available payment arrangements.
The payment arrangement
regulates how a terminal is expected to be paid for. There are two payment arrangements available within the gateway:
– a merchant pays full price for a terminal;
– a merchant pays monthly rental
with the possibility of paying off the total terminal cost if needed.
Purchase is recommended when a merchant can afford buying a terminal.
Rental is acceptable for cases when a reseller can afford to buy a terminal for subsequent rental to assigned merchants. Additionally, if the relationship between a merchant and reseller tend to be long-term, rental is a more profitable option for the reseller. The risk here is that after a short period of using a terminal, it will be returned and the reseller will lose profit that could be gained if the terminal had been purchased.
resells terminals to its clients. One of the clients,
, is a large supermarket chain that is going to process terminal transactions. Considering the needs of
, the most suitable terminal models for this merchant cost $320 or more. This price is affordable for the merchant as it has high profit and can cover such costs. The terminal is purchased by
receives the full price of the terminal as its profit.
, is a convenience store that is also going to process terminal transactions. Considering the needs of
, the most suitable terminal model for this merchant costs $270. This cost is too high for this merchant as it has low profit, and
suggests subsidizing the terminal price through a rental option. In this case,
pays only $10 per month.
benefits from a long-term rental. For example, in 2.5 years, the total rental charge received from
exceeds the cost of the terminal by $30.
To deliver a physical terminal to a merchant, it is necessary to set a list of shipping methods that will be chosen in the future for each terminal order individually.
As a rule, there should be set two basic shipping methods for the fulfillment center:
method is the most affordable for a merchant. Usually, it takes 3-5 days. This method is used by default.
method is much faster and used for orders with high priority. Usually, it takes 1-2 days.
Depending on the fulfillment center, shipping methods can vary. Additional alternatives with different terms can be provided. Several methods can be added as urgent alternatives: a delivery in 24 hours and in 2-3 days, for example, along with several regular methods which might include two weeks, three weeks and a month.
orders a terminal from
to start processing card-present transactions. As this order is not urgent,
selects the regular shipping method (5-7 days).
In two months, a processing issue occurs with one of the ordered terminals and
needs to exchange the broken terminal to a new one. For this purpose, the merchant submits a return order to
. It selects an urgent shipping method (1-2 days) because it needs to resume processing of card-present transactions as soon as possible.
In a year,
decides to open new stores abroad with the ability to process terminal transaction.
wants to order terminals for the new shops from
currently has only two basic shipping methods that do not fit for delivery of the order abroad due to short delivery period.
adds alternative shipping methods that can be selected by
for terminal orders for locations in other countries (8-10 days and 14-18 days).
are emails that inform users about the current status of an order and include important information that is needed for further processing of an order. Notifications are indicators of the current lifecycle phase of an order.
During the terminal ordering process, email notifications are sent to a merchant’s email indicated during the terminal order submission. Additionally, copies of these notifications can be sent to a
associated with the
and to terminal managers. For notification copies to be sent, it is necessary to set up respective settings within the system.
There are five phases of the terminal ordering process when notifications can be sent:
– notification is sent when an order has been created.
– notification is sent when an order is in “Created” status, including information about a submitted order as well as the assigned ID within the system.
– notification is sent when an order is in “Modified” status and informs the receiver that the order has been modified after it was reopened.
– notification is sent when an order is in “Canceled” status and informs the receiver that the order has been canceled.
– notification is sent when an order is in “Shipped” status and informs the receiver that the order is being shipped. Additionally, it provides the activation code and serial number(s) of terminal(s). If configured, this notification also contains a tracking number that allows a user to keep track of the shipping process.
- notification is sent when an order has been created for order return.
Templates for notifications available within the system can be found in the
perspective on the
Step-by-Step Terminal Ordering
For ordering terminals through the gateway to be possible, the system must be configured in the proper way. The steps include the following:
Create a fulfillment center
. It must be done no matter whether fulfillment is handled by an external service provider or by a fulfillment department of the gateway owner’s company. To learn how to create a fulfillment center, review
Add available terminal models
. It is possible to add models to a terminal order until it is sent to a fulfillment center. To learn how to add a terminal model within a fulfillment center, review
. It is possible to assign different configurations to different terminals within an order. When this is necessary, multiple configuration sets can be created. To learn how to set up configurations for a fulfillment center, review
Assign injection keys
. It is possible to assign different injection keys to different terminals within an order. Injection keys must be associated with the processor through which the merchant is going to process transactions. To learn how to add an injection key, review
Add shipping methods
. It is necessary to set at least two shipping methods,
stands for UPS ground shipping (UPSGROUND as
within the shipping method's profile),
stands for UPS next day air shipping (UPSNEXTDAYAIR as
within the shipping method's profile). To learn how to set a shipping method within the gateway, review
Configure a provider’s profile and terminal order notifications
. Depending on the company that does the fulfillment (external service provider or gateway department), profile settings should be as follows:
If an external service provider is used as a fulfillment center, the following profiles should be set:
Fulfillment center profile
Email notifications profile
If a gateway owner is used as a fulfillment center, the following profile should be set:
Email notifications profile
To learn how to configure a profile, review
Terminal ordering steps include:
. The order that is going to be created has to be attached to a particular terminal. This terminal must be created in advance.
To learn how to create a terminal, review
. Depending on the company that does fulfillment (external service provider or gateway department), profile settings should be the following:
external service provider
is used as a fulfillment center, an order is placed on the Merchant or
is used as a fulfillment center, an order is placed on the
Create Order (Extended)
To learn how to create an order, review
. When the order is submitted, the creator of the order receives a
email notification. If notification is not received, it can be resent on the
form. To learn how to re-send a notification, review
After review, the order should be approved. To learn how to approve an order, review
. Done by a fulfillment center. Orders are usually submitted to the fulfillment center on a set schedule regulated by a timer (every three hours during a business day). Before a terminal is sent to a merchant, it gets registered in TMS using connectivity parameters that are returned in an API call (to learn more about API calls available through TMS API, review
documentation section). After received, these parameters are stored in a separate file within the terminal. After initialization is done, the terminal is managed by the TMS server. After terminal fulfillment is done, the ordered terminal is assigned with a unique serial number and activation code. Before shipping, the fulfillment center runs terminal diagnostics to verify that it is in the
status, all required connections are operating, and no error messages are present.
. Done by a fulfillment center. When the order is ready to be shipped, the submitter of the order receives a
email notification. While the order is in shipping status, the order delivery status can be checked on the fulfillment center portal using the
function. To learn how to set up tracking information for orders, review
Terminal connection and activation
. After a terminal is received by a merchant, it must be connected and activated. To do that, follow these steps:
Place the terminal on a free surface, which doesn’t restrict usage of the terminal’s display, keyboard, and card reader.
Ensure that you have arranged the terminal’s cables to prevent them from possible damage or dangerous contacts.
Connect one end of the Ethernet cable to the ETH port in the terminal and the other end to a router or a network point.
Connect the power cord to the round jack in the terminal. Note that since the connection works under conditions of an ultra-low voltage (SELV), you must use only joining parts approved by Ingenico. Don’t use different or longer (more than 3m) external cables other than indicated and/or supplied by the manufacturer.
Make sure that you have received an activation code. It can be obtained in two ways: via an
or via the user interface on the Details form under the Terminal perspective.
Turn on the terminal.
When the terminal menu is displayed, select
from the menu to verify if the terminal parameters are correct.
Press “OK” or the green button. If the device is connected correctly, all parameters on the screen are shown with no ‘’error’’ indicator. To learn more about terminal diagnostics, review the
Terminal Diagnostics guide
Press “OK” or the green button to return to the main menu.
in the terminal menu.
Enter the activation code. To learn more about terminal activation, review
Terminal Order Management Guide
Press “OK” or the green button.
Congratulations! You have activated your terminal and can now use your terminal for processing transactions.
After the terminal is activated, it is important to monitor its activity and provide maintenance when needed in a timely manner.
If any issues occur with a terminal device, the following functionalities are available for identifying the problem:
. If there is an issue with a terminal, the diagnostics should be run via the terminal device. To learn about common errors that occur within the terminal system, review
Terminal logs analysis
. If a diagnostic of the terminal does not help and it is necessary to analyze the terminal’s activity within a particular period of time, the terminal logs should be examined. To learn how to review terminal logs, review
If any changes are necessary for a terminal device, the following functionalities are available:
Configuration of the terminal
. Configurations are uploaded to the terminal from TMS during the initialization process and every time when they are changed in the gateway or through the API. To learn how to review terminal configurations, review
tutorial. To learn how to change configurations for a particular terminal or for a group of terminals, review
Updates of the terminal
. Usually, terminal updates are done by the gateway support team. Update profiles contain the update scenario used for terminals assigned to a portfolio. Also, updates can be applied to terminals that are assigned to any particular segment. A
is a group of terminals that is used to download updates for certain terminals. To learn how to set a segment for a terminal, review
Exchange/Return of the terminal
. When exchange or return of a terminal is necessary, the terminal must first be deactivated. To learn how to exchange or return a terminal, review
For terminal management access, the following PINs are used:
- allows to access and modify terminal parameters. The settings for parameters are the same for the ones configured in the gateway. If a parameter is locked in the gateway, it cannot be changed via the terminal.
- allows to trigger internal processes that are run by timer (for example,
- allows to access Telium Manager settings (for Ingenico terminals only).
If any of the PINs are needed, address the request to the gateway support.
Reporting on Terminal Orders
The task of a Terminal Order Manager is not just to create a terminal order but also to keep a track of the ordered terminals. For this reason, there is a need to obtain this information from the gateway. This can be done in two ways:
via a series of user interface forms associated with a terminal order;
via a designated report called
The report can be downloaded from the user interface and uploaded to the integrated system for cross-reference. It is available for generation broken down by a definite terminal order or status, contact person, merchant, account or reseller. The report can be downloaded in XLS or CSV.
The dashboard contains the following columns:
- identifier of a reseller generated by the gateway
- name of a reseller assigned within the gateway
- identifier of a merchant generated by the gateway
- name of a merchant assigned within the gateway
- identifier of an account generated by the gateway
- name of an account assigned within the gateway
- identifier of a fulfillment center generated by the gateway
- the date when a terminal order was created in the gateway
- tracking information provided by a fulfillment center
- name of the person/organization indicated as the one to receive the order
- street where the order is to be delivered to
- city where the order is to be delivered to
- state where the order is to be delivered to
- code of the country where the order is to be delivered to
- zip code where the order is to be delivered to
- date when the order was sent by the fulfillment center
- name of the person indicated as the one to receive the order
- phone number of the person indicated as the one to receive the order
- email of the person indicated as the one to receive the order
- type of the order. To learn more about available order types, follow
- identifier of the order generated by the gateway
- identifier of the order in the fulfillment center’s system
- type of the shipping method applied to the orderю To learn more about available shipping methods, follow
- type of the payment arrangement applied to the order. To learn more about available payment arrangement types, follow
- list of the ordered terminal models
- status of the order. To learn more about available terminal order statuses, follow
UniPay - Payment Gateway Software
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.