Setting Up Testing

Overview

To ensure seamless integration with Qolo’s Interact System, clients must create a gateway secret and two gateways to receive transaction notifications. After setting up the gateways, clients should provide Qolo with the designated URL to configure the testing environment. This staging environment allows businesses to verify how their systems handle authorization requests and transaction notifications, ensuring all endpoints function correctly before deployment.

Proper configuration of these endpoints ensures smooth communication between Qolo and the client’s system, facilitating real-time decision-making and accurate transaction processing.

Authorization and Message Endpoints

The two key API endpoints for successful Interact are the Authorization Endpoint and the Message Endpoint.

1. Authorization Endpoint

The Authorization Endpoint is the designated URL where Qolo sends transaction authorization requests for client decisioning. This endpoint receives real-time transaction authorization requests from Qolo, and clients are required to respond with a decision response of approve, decline, or partially approve within three (3) seconds

Key Responsibilities of the Authorization Endpoint

Accepts incoming transaction requests from Qolo.
Evaluates the transaction details using internal business rules.
Responds with an approval, partial approval, or decline decision.
Ensures real-time processing within Qolo’s response time requirements.

Example Authorization Request Flow

Qolo sends a transaction request → Client’s authorization endpoint receives the request.
Client evaluates the request → Determines whether to approve, partially approve, or decline based on internal logic.
Client sends a response → Qolo processes the response and forwards the outcome to the card network.

2. Message Endpoint

The Message Endpoint is responsible for receiving transaction notifications from Qolo, providing real-time updates on transaction approvals, reversals, refunds, and declines

Key Responsibilities of the Message Endpoint

Receives real-time transaction notifications from Qolo.
Processes authorization results, refunds, and reversals.
Ensures accurate logging and reconciliation of transactions.
Helps maintain compliance with funding and reporting requirements.

Example Message Notification Flow

Qolo processes a transaction decision (approval, decline, or reversal).
Qolo sends a notification → The client’s message endpoint logs the event.
Client updates records → Ensures accurate tracking of transaction statuses.

Example Endpoint Setup

Clients must provide Qolo with the correct sandbox endpoints where they will receive test transactions and notifications. Below are example test endpoints:

Authorization Endpoint: `https://sandbox.api.io/webhook/qolo/auth`

Message Endpoint: `https://sandbox.api.io/webhook/qolo/message`

These endpoints allow Qolo to send simulated transaction requests that clients can validate against their internal authorization rules before moving to production.

Gateway Secret

Clients must create a secure secret that Qolo will use to communicate transaction requests to the clients' gateways. Clients will send the secret along with the authorization and message endpoints to Qolo for configuring their environments.

Testing Endpoint Functionality

To verify that the endpoints are set up correctly, clients should:

Perform endpoint connectivity tests to confirm Qolo can send and receive requests.
Validate response times to ensure authorization decisions are processed within three (3) seconds.
Simulate various transaction types (approvals, partial approvals, declines, and reversals).
Confirm that logs are properly recorded for reconciliation and reporting.

API References for Testing

To assist clients in testing, the below API references contain sample payloads, and response formats to help clients structure their authorization responses correctly.

Key API Resources

Interact Authorization API – Defines how Qolo sends authorization requests to the client’s endpoint. Generates a sample payload/response that would be sent to your Authorization endpoint. The API does not send transaction requests to an endpoint.
Send Message API – Describes how Qolo sends transaction updates for approvals, reversals, and declines. It also generates a sample payload/response that would be sent to your Message endpoint. Note that this API does not send transaction requests to an endpoint.
Interact Auth Simulator – Allows clients to test their authorization/message endpoint response handling by simulating an example transaction object sent to the Authorization/Message endpoint. Transactions sent through the Interact Auth Simulator do not follow the settlement flow and will not appear in the transaction history.
Transaction Authorization Simulator – Simulates a transaction request sent to the client's configured authorization/message endpoint for testing purposes.