This solution is perfect for native POS applications that are built for an Operating System — whether desktop, mobile, or both — as opposed to applications that are accessed via the browser. The Ingenico Semi-Integrated API is not considered a cloud solution because the payment terminal only accepts calls locally within the LAN. The POS system sends the request to the terminal over LAN, which then sends the request out of the LAN to our processor.

An https connection between a website and a physical payment terminal on a LAN is difficult to achieve due to browser rules regarding certificates and CORS (Cross-Origin Resource Sharing). If such an integration is required, another option is to develop custom middleware (whether a native application or browser plugin) to facilitate the connection. However, semi-integrating a terminal via LAN is the recommended method of implementation.

For those who need the ability to perform operations remotely from a server instead of doing everything from the terminal at a physical merchant location, it can be beneficial to pair the Ingenico Semi-Integrated API with a server-based API. With this type of omnichannel payment solution, card-present transactions can be captured in real time at a brick and mortar store using an Ingenico terminal, but processes can also be run remotely since the server-based API is not restricted to the LAN. This type of server-based API, such as North’s Server Post API, enables payment services to be initiated at any time, from any location.

For example, the processes of closing batches and adjusting tips can be automated to run from the server at the most convenient time without manual initiation, such as overnight or after hours of operation. Additionally, using the Server Post API increases the speed and amount of transactions that can be processed. Batch processes can be written to perform actions on multiple transactions at once, and removing the Ingenico terminal from the transaction process reduces the number of steps in communication, which improves processing time. Additionally, functions such as card-not-present refunds can be processed by passing the initial transaction token to the Server Post API, without requiring that the card be brought back into the store, improving the customer experience.

Requests sent via the Server Post API must originate from a server (or multiple servers). Each server is required to have a static IP address and cannot use dynamic IP addressing. This is because the API uses Access Control List (ACL) rules based on IP address, so a server’s IP address must be whitelisted to gain access to the API. If the IP address changes without requesting that the new address be whitelisted, the server will lose access to the API.

Once the partner receives a test terminal, they start integrating their POS system with the Ingenico Semi-Integrated API and Server Post API, with support from North Developer’s technical documentation as well as a team of Integration Specialists. Development to integrate the Ingenico Semi-Integrated API typically only involves adding code to the POS application to send requests to the terminal and save the responses. Development for the Server Post API may include additional steps, such as ensuring that everything meets PCI requirements, if sensitive data is being introduced to the server environment. Integration Specialists are available to help with any questions and provide guidance throughout this process.

When development is complete, partners contact the Integration Specialists to review the API calls that they will be integrating in the POS software. This code verification is required because North’s Semi-Integrated and server-based solutions directly access the processor, as opposed to a gateway. For more information about the benefits of direct-to-processor integrations, see this article.

Partners simply create a .txt file that includes the raw request and response calls for every transaction type that will be implemented. If a partner is using the Ingenico Semi-Integrated API and the Server Post API, they just create one .txt file for each product, and submit them for review at the same time. The Integration Specialists typically complete the review and provide feedback on the same day that the code is submitted, making this a very brief and straightforward process. If needed, the Integration Specialists will work with the partner to make any changes until the solution is ready for the Production environment.