API

JSON RESTful API Guide

Cloud9's API is available in OpenAPI format (Swagger) — a documentation suite combined with a testing sandbox that lets you run live samples while learning how the API works.

API Documentation & Sandbox

Explore the full API reference, view schemas, sample payloads, and test live requests against the Cloud9 gateway.

Open API Sandbox → Request Access

1. OpenAPI Introduction

The sandbox provides three key tools for working with the API:

Schema

Parameter names and values — e.g. TransType for transaction type, GMID for Gateway Merchant ID.

Examples

Sample implementation patterns showing how to structure requests for common operations like Sale, Auth, Void, and Refund.

Try It

Run JSON payloads directly against the API server to see live responses while you learn.

2. Test Account

The sandbox uses a TSYS test server. For successful test transactions, use these values:

Parameter	Value
Card Numbers	Real card numbers accepted (no charges in test mode)
Amount	`$1.00`
CVV	`999`
AVS	Use TSYS-specified test values

Note — Full test card details and edge-case scenarios are available in the TSYS Test Account documentation, accessible from within the API sandbox.

3. Live Environment Notes

Important — In the LIVE environment, do not use #[TransType] after the /restApi path. Omit the # and everything after it. The transaction type is identified solely through the TransType value in the request body.

Test environment

POST /restApi#Sale

Live environment

POST /restApi
{
  "TransType": "Sale",
  ...
}

4. Third-Party Tools

In addition to the built-in sandbox, you can use Postman as a free alternative for testing JSON API requests against the Cloud9 gateway.

Download Postman at postman.com.

← Portal Setup Guide iFrame Integration →