Transaction API and RESTful Interface

Clearent Payment Gateway’s RESTful Transaction API, which facilitates fast, robust, secure integration of merchant e-commerce web sites, shopping carts, custom applications, mobile payment applications and Point-of-Sale systems with Clearent’s payment processing platform.

RESTful Interface Overview

Transaction Flow

All transaction requests use Hypertext Transfer Protocol (HTTP) with Transport-Layer Security (TLS). When the Gateway receives a request, it authenticates the originator by inspecting the API Key that is included in either the header or the body of the request.

The following diagram depicts the information flows that are made possible by the RESTful API:

RESTful Interface Flow

The numbered points in the diagram highlight how the Clearent Gateway:

  1. Receives a payment transaction request;
  2. Authenticates the requestor by validating the API Key, performs validation of the transaction data, then forwards it to the Switch;
  3. Forwards the transaction request to the front-end processor (not shown), which in turn submits it to the appropriate card associations and issuer for authorization.
  4. Returns a response message back to the requestor with the result of the transaction request.

An API Key Identifies an Originator

Since transactions for a single merchant account may originate from multiple sources, the Gateway permits creation of separate API Keys for different originators, each with different permissions as appropriate. This allows you to distinguish transaction activity according to the originator, whether in reports, or in data feeds.