Prerequisites
What you need before integrating with EcobankPay
Important
To successfully complete the integration and send requests, the following details are required as described in the table below.
Requirements
| Requirement | Description |
|---|---|
| Merchant Key | This is a unique Key created by EcobankPay and assigned to third parties for integration. |
| Secret Key | A confidential key used for creating secure hash signatures. This will be provided as part of the registration process. |
| Developer Environment | A development environment with the capability to make HTTP requests and handle JSON responses. |
| Secure Website | A secure website (HTTPS) for handling payment redirects and notifications. |
| IPN Endpoint | A publicly accessible endpoint for receiving Instant Payment Notifications. |
Technical Requirements
API Tools
Tools for testing and development
We recommend having the following tools for development and testing:
- API Client (Postman, Insomnia, etc.)
- JSON Parser/Validator
- HMAC SHA-256 Hash Generator
Programming Knowledge
Skills required for integration
The following technical knowledge is recommended:
- RESTful API Concepts
- HTTP/HTTPS Protocols
- JSON Data Format
- Cryptographic Hashing (SHA-256)
- Webhook Implementation
Registration Process
- Contact EcobankPay to start the merchant registration process
- Complete the merchant application form with your business details
- Upon approval, you will receive your Merchant Key and Secret Key
- Configure your test environment using the provided credentials
- Complete integration testing with test transactions
- After successful testing, receive production credentials
- Deploy your integration to production
Note
Your merchant account needs to be properly configured before you can receive payments. Please contact EcobankPay support if you encounter any issues during the registration process.
Environment URLs
| Environment | Base URL | Purpose |
|---|---|---|
| Testing | https://test-pgw.paywithonline.com/v1/ | For integration testing and development |
| Production | https://pgw.paywithonline.com/v1/ | For live transactions |
During development, use the testing environment to validate your integration without processing real payments. Once your integration is complete and verified, you will be provided with production credentials to process live transactions.