Process Flow

The Convergegate API follows a straightforward request–response pattern over HTTPS. All interactions require proper authentication as outlined in the Authentication section.

Below is a high-level view of how a typical request is processed:

1. Merchant System → Convergegate API

   • Your system sends an HTTPS request to the Convergegate API using the Sandbox or Production base URL.

   • The request includes:

     • Required authentication headers (Authorization and, if applicable, Signature).

     • Required request body parameters for the selected endpoint.

2. Convergegate API Validation

   • The API validates the authentication credentials.

   • The API validates the structure and content of the request body against the endpoint’s schema.

3. Processing

   • The API executes the requested operation (e.g., create a transaction, check status, initiate refund).

   • If applicable, the API communicates with underlying payment networks or services.

4. Response

   • A JSON-formatted response is returned with:

     • status or code indicating success or failure.

     • Relevant data fields (such as transaction ID, status, timestamps).

     • Error details if the request failed validation or processing.

---

Visual Process Diagram: