Info

This guide outlines the different methods available to charge your customers and manage incoming payments through the Honeycoin API.

Collections

Collections, in the context of Honeycoin, refer to the process of charging your customers. This can be done through various methods, including mobile money, bank transfers, or our Universal Payment SDK. This guide provides an overview of the different collection methods available through the Honeycoin API.

Which Collection Method Should I Use?

MethodUse this whenCustomer actionBest for
Universal Payment SDKYou want one hosted checkout flow that can show multiple local payment methodsCustomer opens a Honeycoin payment link and chooses or completes a payment methodMost checkout integrations, especially when you do not want to build method-specific UI
Mobile Money ChargeYou already know the customer's phone number, currency, and mobile money operatorCustomer approves an STK, OTP, USSD, redirect, or provider prompt depending on the marketDirect mobile money collections
Bank TransferYou want to create a temporary virtual account for an exact bank transferCustomer sends the exact amount to the generated account before it expiresNGN or KES bank-transfer collections
OPay ChargeYou want to accept NGN payments through OPayCustomer may be redirected to complete authorizationNigeria OPay-specific checkout flows
P2P ChargeYou need a redirect-based peer-to-peer payment flowCustomer opens a redirect URL and authorizes the paymentMarkets or providers that require P2P redirect completion
Card ChargeYou want to collect card payments directly through the APICustomer may complete 3DS, OTP, PIN, redirect, or address verificationCard checkout flows where you collect card details server-side

Collection Happy Path

  1. Choose the collection method that matches your checkout experience.
  2. Initiate the transaction with a unique externalReference.
  3. Show the customer the required payment action, such as a payment link, virtual account, STK prompt, or redirect URL.
  4. Listen for webhooks and/or query the transaction status.
  5. Provide value only after the final transaction status is successful.

Mobile Money Charge

This method allows you to directly charge a customer's mobile money wallet. It's a straightforward way to collect payments in countries where mobile money is prevalent. To initiate a mobile money charge, you'll need to provide the customer's phone number, the amount, and the currency. For all currencies except KES, you will also need to provide the momoOperatorId.

For more details, please refer to the Mobile Money Charge API Reference.

Bank Transfer

The Bank Transfer method enables you to create temporary virtual bank accounts for your customers. Customers can then make payments to these accounts, which are automatically reconciled with your Honeycoin account. This is a useful method for collecting larger payments or for customers who prefer to pay via bank transfer.

For more details, please refer to the Bank Transfer API Reference.

Universal Payment SDK

The Universal Payment SDK provides a unified and flexible way to accept payments from customers in multiple markets and through various payment methods. With a single integration, you can offer a localized payment experience to your customers, allowing them to pay with their preferred method, whether it's mobile money, a bank account, or other local payment options. The SDK handles the complexities of different payment gateways, providing you with a single endpoint for all your collection needs.

For more details, please refer to the Universal Payment SDK API Reference.

Refund Deposit

The Refund Deposit feature allows you to refund a previously successful mobile money deposit transaction. This is particularly useful for handling customer refunds or correcting erroneous charges. It's important to note that refunds can only be initiated for mobile money transactions.

For more details, please refer to the Refund Deposit API Reference.

Supported Countries and Mobile Money Operators

Honeycoin supports a wide range of countries and mobile money operators. For a detailed list of supported countries and their respective transaction limits, please refer to our Supported Countries & Limits documentation. To see the list of mobile money operators available in each country, please visit the Mobile Money Operators page.