Setup Guide
Get your development environment ready for EcobankPay integration
Preparation Is Key
Complete all setup steps before attempting to integrate with the EcobankPay API. A proper setup will save development time and help prevent common integration issues.
Prerequisites
Before you begin the integration process, ensure you have the following:
- An active merchant account with EcobankPay
- Your merchant key and secret (provided by EcobankPay)
- API endpoint URLs for both sandbox and production environments
- Basic knowledge of REST API concepts and JSON
- Development environment with HTTPS support for callback URLs
Account Setup
To obtain your merchant account and credentials:
- Contact EcobankPay's merchant support team at support@ecobankpay.com
- Complete the merchant onboarding form with your business details
- Provide the necessary legal and business documentation
- Once approved, you'll receive your merchant key and secret
- Request access to the sandbox environment for testing
Environment Setup
Configure your development environment:
1. API Endpoints
Use the following endpoints for your integration:
| Environment | Base URL | Purpose |
|---|---|---|
| Sandbox | https://sandbox.ecobankpay.com/api/v1 | Testing and development |
| Production | https://api.ecobankpay.com/api/v1 | Live transactions |
2. Authentication Headers
For all API requests, include these authentication headers:
| Header Name | Value | Description |
|---|---|---|
| x-merchant-key | Your-Merchant-Key | Your unique merchant identifier |
| x-api-hash | HMAC-SHA256-Hash | HMAC signature of the request body |
| Content-Type | application/json | All requests use JSON format |
Next Steps
Once your environment is set up, you can proceed with integrating specific payment methods: