Cycle Logo

Cycle REST API

A secure interface for external platforms to interact with the Cycle system, designed for reliable request handling and smooth integration.

API Components

Web API: Manages entities such as clients (merchants), branches, and agents (POS users).

Processing API: Handles transactional-level interactions with the payment engine.

API Models & Schemas

Explore models and schemas via our interactive Swagger documentation:

Web API Swagger UI Processing API Swagger UI

Base URLs

Web API: https://web-api-pro-demo.cardport.net/<MethodName>

Processing API: https://processing-demo.cardport.net/<MethodName>

Request Types

GET

Parameters are passed via the URL query string.

// GET
url = host + path + query

POST

Parameters are included in the body as JSON.

// POST
url = host + path
body = JSON

Authorisation & Usage Guidelines

  • Authorisation is mandatory for all REST API requests.
  • Do not exceed one request per second.
  • Use only UTF-8 encoding. Avoid unsupported or special characters.
Next
Authentication