Onyx Global Payment Services

API Documentation v1.0

Introduction

Welcome to the Global Payment Services API reference.

This API serves as a payment gateway to facilitate cross-border fund transfers through Onyx global Payment Systems.

The Money Transfer API is organized according to REST principles and provides the following functionality:

Account management services
Process transaction to a specified destination
Retrieve transaction information and details
Discovery services

Environments

This API is available in 2 environments:

Pre-production: where partners can do integration phase and start tests.
Production: the live environment where real transactions are being processed.

Both environments are reachable via IPSec VPN or HTTPS.

Specific details relating to the endpoints will be provided upon account creation.

Versioning

Endpoints of the API are prefixed with a corresponding version number. This documentation describes version 1.0 of the API, the current and latest version available.

subsequent versions (only majors) will be listed here.

This method of versioning provides complete isolation between implementations and ensures that subsequent major changes to the API will never affect existing integrations.