Welcome to the Afriex Business API
The Afriex Business API enables you to manage customers, process payments, handle payouts, and receive real-time notifications via webhooks. This documentation provides comprehensive guides and API reference for integrating with our platform.Base URLs
The API is available on two environments:| Environment | Base URL |
|---|---|
| Staging | https://staging.afx-server.com |
| Production | https://prod.afx-server.com |
Authentication
All API endpoints require authentication using an API key. Include your API key in thex-api-key header:
API Versioning
The API supports versioning via thex-api-version header:
Core Resources
The API provides the following core resources:Customers
Create and manage customer profiles with optional KYC information.
Payment Methods
Set up bank accounts, mobile money, and crypto wallets for payouts.
Transactions
Process deposits and withdrawals with real-time status tracking.
Webhooks
Receive real-time notifications for customer, payment method, and transaction events.
Quick Links
- Quickstart Guide - Get up and running in minutes
- Customer API - Manage customer profiles
- Transaction API - Process payments
- Webhook Events - Handle notifications