Ecobank API

Getting Started

This section provides a comprehensive guide to help you quickly integrate with Ecobank’s Sandbox API. By following the steps outlined below, you can configure your environment, authenticate your application, and begin interacting with our API services efficiently.

Ensure the following prerequisites are met:

  1. Create an account by using the sign-up link on this platform.

  2. Obtain the necessary API access credentials from Ecobank. These credentials include your API key and all necessary credentials, which will be used for authentication.

  3.  Environment Setup:

    • Sandbox Environment: Ensure you have access to the Ecobank sandbox environment for testing and development purposes.

    • Production Environment: Once your integration has been tested and approved, you will be provided with access to the production environment.

  4. Development Tools:

    • API Client: A tool like Postman or cURL to test API requests and responses are recommended.

    • Programming Environment: A development environment that supports HTTP requests protocol (e.g., Java, C#, PHP, JavaScript, Python. etc.).

  5. Network Configuration: Enable all necessary configurations to allow the Ecobank API endpoints to properly communicate with the appropriate services.

Keynote

  1. Obtain the required credentials and API keys for authentication.

  2. Review the available services like Bill Payment, Xpress Cash Token, Account Services, Direct Debit. Etc. and select the appropriate endpoint for your operation.

  3. Ensure that your HTTP request includes the appropriate protocol:

    • The correct HTTP method (POST).

    • The base URL (sandbox or production), combined with the specific endpoint.

    • The required headers (including the Authorization token).

    • Any necessary query parameters, path parameters, or request body for the operation.

  4. Review the response, which will typically include status codes and the response body in JSON format. A successful request will return a 200 OK status, while error codes (e.g., 400 Bad Request or 401 Unauthorized) indicate the specified issues to be addressed.

  5. The platform enforces rate limits to ensure optimal performance for all users. Ensure your application is designed to handle rate limit errors and implement appropriate retry logic. You will receive a 429 Too Many Requests status code if you exceed the rate limits.

  6. To maintain seamless API integration, ensure your application is equipped to handle various error responses. Refer to the Error Response section of this documentation for details on error codes, descriptions, and troubleshooting steps.