Getting Started
Welcome to the Kulpay API documentation. Kulpay API is the core financial services middleware powering the Kulpay ecosystem, providing a comprehensive API for customer management, KYC verification, payment processing, and transaction management.
Quick Navigation
System Architecture
Understand the technical foundation: technology stack, deployment topology, security model, data models, and external integrations.
API Reference
Complete REST API documentation with all endpoints, request/response schemas, authentication, and error handling.
Business Processes
Visual documentation of the 6 core business workflows: customer onboarding, fund transfers, withdrawals, top-ups, payment method registration, and fund requests.
System Overview
Kulpay API exposes a dual-protocol API:
- REST API on port
8080via gRPC-Gateway (JSON over HTTP) - gRPC API on port
50051(Protocol Buffers over HTTP/2)
All REST endpoints are prefixed with /v1/ and accept/return application/json.
Core Services
| Service | Description |
|---|---|
| Customer Service | Customer lifecycle management and onboarding |
| KYC Service | Know Your Customer verification records |
| KYC Log Service | KYC workflow tracking and reviewer interactions |
| Bills Service | Customer bill management |
| Partner Service | Partner configurations and payment methods |
| Instruction Service | Financial transaction instructions |
| License Service | System license activation and validation |
| Device Service | Device registration and trust management |
| System Service | System configuration and health |
System Authorization
Kulpay API uses a license-based authorization model. The system validates a license key on each incoming request at the middleware level. There is no per-request Authorization header required from API consumers.
See Authentication for details on the license system.