Introduction

Our API is designed to empower businesses across the continent with seamless, scalable, and secure financial infrastructure. Whether you are automating payouts, collecting payments, or managing complex treasury operations, BizFlex Africa provides a robust suite of tools to integrate high-performance fintech capabilities into your applications.

---

Authentication

Security is at the core of BizFlex Africa. All API endpoints are protected and require authentication via a custom header.

To interact with our protected routes, you must include your Secret Key in the x-api-key header of every request.

Header	Description
x-api-key	Your unique BizFlex Secret Key (Live or Test).
Content-Type	Must be set to application/json.

🔑

Accessing your Keys > Retrieve your API keys from the BizFlex Merchant Dashboard under Settings > API Keys. Always keep your Secret Keys secure and never expose them in client-side code.

---

Consistent Response Pattern

To ensure a predictable developer experience, BizFlex Africa follows a standardized response format for all API calls. This allows you to implement consistent error handling and data parsing across your entire integration.

Single Resource Response

For standard requests (creating or fetching a single resource), the response object follows this structure:

Field	Type	Description
success	boolean	Indicates if the request was processed successfully.
message	string	A human-readable summary of the result or error.
data	`object	null`	The requested resource object, or null if an error occurred.

Example Response:

JSON

{
  "success": true,
  "message": "Transaction retrieved successfully",
  "data": {
    "reference": "BZA-9901-X",
    "amount": 2500,
    "status": "completed"
  }
}

---

Collection Response (Arrays)

When fetching lists of data (e.g., transaction history, customer lists), the API includes a meta object to assist with pagination and record tracking.

Field	Type	Description
success	boolean	Indicates if the request was successful.
message	string	A summary of the collection status.
data	array	An array containing the requested resource objects.
meta	object	Contains pagination details (current page, total records, etc.).

Example Response:

JSON

{
  "success": true,
  "message": "Transactions fetched successfully",
  "data": [
    { "id": 1, "amount": 1000 },
    { "id": 2, "amount": 500 }
  ],
  "meta": {
    "total_records": 150,
    "current_page": 1,
    "total_pages": 75,
    "per_page": 2
  }
}

---