Gateway Overview
The OLIVE Gateway is a Go-based REST API that serves as the public entry point for all external integrations. It handles authentication, rate limiting, request routing, and proxies requests to the wallet-core service over gRPC.Purpose
API Surface
REST endpoints for payments, subscribers, cards, agents, compliance, and admin operations
Authentication
Multiple auth methods: API keys, JWT, HMAC, service auth
Security
Rate limiting, input validation, audit logging, and CORS protection
Observability
Structured logging, Prometheus metrics, and Swagger documentation
Who Uses It
Endpoint Groups
Public Endpoints
Protected Endpoints
Quick Start
With Docker Compose
Build and Run Locally
Verify Health
API Documentation
Interactive Swagger documentation is available at:Architecture
Project Structure
Key Features
Idempotent Operations
All payment requests support idempotency viaX-Request-ID header:
Audit Logging
All operations are logged with:- Request/response details
- User and client identification
- Timestamps and duration
- Operation outcomes
Error Responses
Standard error format:Next Steps
Authentication
Configure API keys, JWT, and HMAC
Configuration
config.yaml reference
API Reference
Complete endpoint documentation
Architecture
Internal architecture details