Skip to content

Getting Started

Overview

TranzAxis REST API (hereinafter TX API) is used to manage objects in TranzAxis - retrieve information, make modifications, perform financial operations, etc. Please visit Compass Plus website to learn more about the TranzAxis software product.

TX API is based on the RESTful principles, it uses HTTP methods (GET, POST, PUT, DELETE) to work with objects. Some requests contain data in their body, for example, to pass the attributes of an object being created or updated. TX API uses JSON format to transfer data.

Acronyms Used

Acronym Definition
DMZ Demilitarized zone - physical or logical subnet that separates a local area network (LAN) from other untrusted networks, for example, public internet
TX API TranzAxis REST API
TX RTP TranzAxis Regular Transaction Protocol, SOAP/XML-based
UDF User-defined function
UDT User-defined transaction

Interaction

Integration with TX API can be implemented as represented in the diagram below:

Typical integration

The main components shown in the diagram include:

  • TranzAxis – platform (host) configured to perform the required business functions (for example, issuer functions).
  • API Gateway – technological component usually deployed in DMZ and responsible for connection management, rate limiting, load balancing, additional user authentication, etc. Such gateways can have built-in dashboard and monitoring tools.
  • External system – system or application that requires online integration with TranzAxis.

TX API Objects

TX API supports different objects enabling to perform operations on them, such as issuing cards or creating accounts, modifying object attributes, etc.

Basic TX API objects are:

  • card – payment card (physical or digital) used for executing transactions
  • subject – individual customer (account holder or cardholder) or corporate customer (company, merchant, payee)
  • contract – agreement concluded between the issuer and customer, usually presented as an account of any type (current account, savings account or credit account)
  • tran – financial operation (transaction), for example, transfer, payment, etc.

For details on the supported objects and operations, refer to the TX REST API specification.