Elemi API Documentation
  • Introduction
  • Getting Started
    • Registration
    • Error Handling
    • Authentication
    • Merchant Account Credentials
      • Generate Secret Key
      • Regenerate Security Keys
    • Supported Countries/Regions
    • Transaction Limits
    • Sandbox Test Accounts
    • Elemi Public Keys
  • Utility Functions
    • Balance Inquiry
    • Payment Options
    • Payout Bank Codes
    • Mobile Money Operator Prefixes
    • Handling Notifications/Callbacks
      • Callback Events
    • Transaction Status Verification
  • Funds Collection
    • Getting Started
    • Mobile Money Collection
      • Mobile Money - Direct Charge
      • Mobile Money - Hosted Page
    • NGN Bank Transfers
    • ZAR Bank Collections
    • Card Payments
      • Hosted Payment Page
      • Direct Card Payment (S2S)
  • Payouts/Disbursements
    • Getting Started
    • Mobile Money Payouts
    • Bank Account Transfers
  • Callbacks
    • HMAC Signature Verification
    • RSA Signature Verification
  • Appendix
    • API Reference
    • Merchant Account Transfers
    • Availing Payout Funds
    • Sub Account Transfers
    • Funds Settlement
    • Transaction Audit Logs
    • Cross Currency Transactions
Powered by GitBook
On this page
  • Pre-requisites
  • Collection Workflow Selection
  1. Funds Collection

Mobile Money Collection

The Elemi API supports mobile money as described in the Supported Countries section. The API allows for direct charge or making use of the hosted page that's powered by Elemi (recommended).

PreviousGetting StartedNextMobile Money - Direct Charge

Last updated 3 months ago

Pre-requisites

  1. The merchant needs to have an approved merchant account on the live platform. This is only achieved after the go-live requirements are met (being on sandbox and clearing the UAT tests).

  2. The mobile money channels required by the merchant need to be configured on the designated merchant account. The support teams will be available to assist with this.

Collection Workflow Selection

The API allows the merchant to either use the hosted payment page (recommended) or build their own user experience based on the API workflow. With the hosted payment page, Elemi handles all the different variations of authorizing mobile money payments e.g. PIN entry, verifying phone numbers with OTP before completing transactions (e.g. for GHS Mobile Money collections.) and this seamless workflow creates a good user experience. Some merchants however wish to create custom experiences using their brand guidelines and, in this situation, the direct charge can be used.

The table below briefly describes the two Mobile Money workflows to select from.

Scenario
Resource

You wish to use a managed user experience that handles all Mobile Money workflow variations without any input from you, even when telecom policies change from time to time to require other parameters. (RECOMMENDED)

You wish to have control of the user experience, page branding and directly call all the API endpoints yourself. (this requires a thorough understanding of the Mobile Money API workflow and the variations in authorization modes)

We strongly recommend that when the merchant chooses to use the direct charge workflow, they should first study the hosted page workflow before building their custom experiences. Merchants outside the mobile money processing countries are especially encouraged for try the hosted page first.

Hosted Page Workflow
Direct Charge Workflow