API Requirements & Setup

Before you can integrate our services (Payments, SMS, Email, USSD), you need to complete a few setup steps in your account dashboard. This guide outlines the necessary requirements.

Step 1: Create Your Account

The first step is straightforward: sign up and create your main account. This will be your central hub for managing services, companies, applications, and billing.

Step 2: Company Setup

When you create your account, we automatically generate an initial company profile based on the information you provided during sign-up.

  • You can manage this default company profile from your dashboard.
  • If you operate multiple distinct business entities or projects, you have the capability to create additional company profiles under your main account.

Step 3: Configure Payment Methods

Our platform offers flexibility in payment processing:

  • Mobile Money (MOMO): Support for Mobile Money payments (initially focused on Rwanda) is enabled by default for your account and applications.
  • Card Payments: If you need to accept credit or debit card payments (Visa, Mastercard, etc.), please contact our support team to enable this feature for your account.

Step 4: Create Applications

To integrate specific services like Payments or SMS, you need to create an 'App' within your dashboard. Each App represents a specific integration point or project.

  • Navigate to the 'Applications' section in your dashboard.
  • Create a new App, giving it a descriptive name.
  • Configure which services (Payments, SMS, etc.) this App will use.
  • During configuration, provide webhook URLs for services that require them (e.g., for Payment status updates or USSD session handling).

Step 5: Generate API Keys

Once your App is created, you need to generate API credentials (Access Key and Secret Key) for it. These keys are essential for authenticating your API requests.

  • Select the App you created in the 'Applications' section.
  • Find the option to generate API keys.
  • Important: Securely store your Secret Key immediately. It will not be shown again after generation for security reasons.
  • Use these keys in the authorization headers of your API calls as described in the API reference documentation.