Skip to main content

Introduction

Overview​

Welcome to the Zikopay API reference documentation. Our RESTful API enables merchants to seamlessly integrate payment processing capabilities into their applications, including pay-ins (cards and mobile money), payouts, wallet management, and transaction status tracking.

This API is designed specifically for the unique payment ecosystem of Central and West Africa, with support for regional payment methods and operators.

Authentication​

All API requests require authentication using API keys. Each request must include:

X-API-Key: your_api_key
X-API-Secret: your_api_secret

You can obtain your API credentials from the Zikopay Merchant Dashboard after your account has been approved.

Base URL​

Production: https://api.payment.zikopay.com/v1
Test: http://api.zikopay.test/v1

Always use the test environment first to validate your integration before moving to production.

Request/Response Format​

The API accepts and returns JSON data. All requests must include:

Accept: application/json
Content-Type: application/json

Common Response Structure​

All API responses follow a consistent structure:

{
  "success": true,
  "message": "Operation successful",
  "data": {
    // Response data specific to the endpoint
  }
}

For errors:

{
  "success": false,
  "message": "Error description",
  "errors": {
    // Detailed error information
  }
}

API Endpoints​

Transactions​

Wallets​

Webhooks​

Rate Limits​

The Zikopay API implements rate limiting to ensure stability and availability:

  • Test environment: 100 requests per minute
  • Production environment: 300 requests per minute

When a rate limit is exceeded, the API returns a 429 Too Many Requests status code.

Error Codes​

HTTP StatusDescription
400Bad Request - Invalid parameters
401Unauthorized - Authentication failed
403Forbidden - Insufficient permissions
404Not Found - Resource doesn't exist
422Unprocessable Entity - Validation errors
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Something went wrong on our end

Getting Help​

If you encounter any issues with the API:

  1. Check our Integration Guides
  2. Review common Troubleshooting Tips
  3. Contact our support team at developers@zikopay.com