Skip to main content

​
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.

OpenAPI spec

Get the full OpenAPI spec at this endpoint for code generation, SDKs, and API tooling.

MCP server

Add the Afriex Business API to your MCP client and search the docs from Cursor, Claude Code, and other MCP-enabled tools.

Postman collection

Import every endpoint into Postman, with sandbox example requests and API key auth already set up.
Fork the collection into your Postman workspace in one click: Run in Postman

​
Base URLs

The API is available on two environments:

​
Authentication

All API endpoints require an API key. Include it in the x-api-key header:
See Authentication to get a key, set its permissions, restrict access by IP address, and sign requests.

​
API versioning

The API supports versioning via the x-api-version header:
2026-05-18 is currently the only supported version, and it is what you get if you omit the header. Any other value is rejected with 400 Bad Request and an Unsupported API version message.

​
Which version number is which

You will see four version numbers in these docs. Only the x-api-version header selects how the API behaves. To see what changed in how the API behaves, read the changelog.

​
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.
Webhook firewall requirement: If you plan to receive webhooks, allowlist the following Afriex IP addresses on your server:See Webhook IP addresses for details.

​
Support

Need help? Contact us at support@afriex.com.