This document provides detailed instructions on the requirements for a Toqio customer to integrate with Toqio’s Transaction Monitoring Micro Service.

Architecture overview

To start utilising the transaction monitoring service, the customer needs to choose a transaction monitoring service provider. Subsequently, they should establish a proxy server between Toqio and the selected transaction monitoring service provider to facilitate the connection.

Transaction monitoring workflow

The service will operate as follows:

Payment initiation: The end-user initiates a payment through Toqio.
Notification: Toqio updates the customer's transaction monitoring service in real-time via an endpoint to be developed by the customer.
Decision-making: The transaction monitoring service autonomously and promptly suggests an approval or rejection based on the transaction data.
Customer response: After having reviewed the matter, a customer can directly inform Toqio of a decision via a webhook to be developed by the customer.
Payment execution: The Toqio platform acts accordingly, either processing the payment or rejecting it.

Authentication

To authenticate with the customer service, Toqio will utilize an API key. This API key will be generated by Toqio and securely transmitted to the customer.

The customer is required to furnish Toqio with a URL {customerApiUrl}to which the validation request will be sent. This request will undergo authentication using the provided API key. Ensure that the URL is shared with the Toqio delivery team, and they will configure it in the admin panel.

Web-hook

A webhook needs to be developed to send Toqio any asynchronous updates regarding the transaction status. This applies to transactions that remain in a pending status within the transaction monitoring system, and they can be manually accepted or rejected.

This web-hook request will undergo authentication using the same API key as mentioned earlier.

Endpoint specification

An endpoint must be developed on the customer's side, which Toqio will use synchronously. Toqio will send a request to this endpoint containing transaction information, which the customer's service will receive, process, and then forward to their transaction monitoring system. Subsequently, the customer service is required to synchronously return a response to Toqio, indicating the status of the transaction based on the process within the transaction monitoring system.

Method and url

The endpoint should be implemented as a POST method, and the URL should follow this format: {CustomerApiUrl}/transaction/validate .

Payload to be received

Once a transaction is initiated by the end-user, Toqio's Transaction Monitoring will send an object with the following parameters:

Expected response

As a response, we expect an object with the following parameters:

If Toqio receives an unrecognized status, the transaction will be considered as rejected.