API Documentation

API documentation for Ubyx Clearing Platform

OpenAPI REST

Explore the complete REST API specification with interactive Swagger UI documentation for all clearing operations.

View OpenAPI Docs

AsyncAPI Events

Explore our event-driven architecture designed for real-time transaction lifecycle updates, ensuring your system stays synchronized instantly.

View AsyncAPI Docs

Integration Guide

Learn how to integrate both REST and event-based APIs in your applications with comprehensive examples.

View Integration Guide

Powerful Features

Everything you need to integrate with the Ubyx Clearing Platform

Secure Authentication

Institution-based access control with API key authentication for all endpoints.

Complete Workflow

Full stablecoin clearing lifecycle from conversion requests to settlement completion.

Real-time Events

Event-driven architecture for transaction lifecycle tracking.

Interactive Docs

Swagger UI interface for testing and exploring API endpoints in real-time.

Integration Guides

Comprehensive documentation with code examples and best practices.

Production Ready

Enterprise-grade APIs designed for high-volume financial transactions.

API Overview

OpenAPI REST

  • Authentication endpoints
  • Conversion workflows
  • Institution management
  • Settlement processing
  • Transaction event streaming

AsyncAPI Events

  • Event routing
  • Event schemas
  • Real-time notification patterns
  • Error and recovery handling