DocumentationAPI ReferencesSupportBlogAsk AI
Documentation

Ghana Mobile Money

Learn about Mobile Money support in Ghana.

Suggest Edits

📘

Getting Started

We recommend checking out the introductory section to understand the basics of direct charge first. This guide assumes you’ve read that.

If you're collecting money in GHS, your customers can pay with Ghana mobile money services.

The Process

This involves the following steps:

  1. You call our API to create a charge and pass in the customer's mobile number.
  2. Your customer completes the payment by authorizing it with their mobile money provider.

Initiating the Payment

To create a mobile money charge for a customer in Ghana, you'll need the customer’s valid phone_number along with the following required parameters:

  • amount
  • currency
  • email
  • country
  • tx_ref (Unique transaction reference)

You can also specify more details, such as the customer's fullname and custom meta information. See the endpoint documentation for details.

// Install with: npm i flutterwave-node-v3

const Flutterwave = require('flutterwave-node-v3');
const flw = new Flutterwave(process.env.FLW_PUBLIC_KEY, process.env.FLW_SECRET_KEY);
const payload = {
    phone_number: '054709929220',
    amount: 1500,
    currency: 'GHS',
    network: "MTN",
    email: '[email protected]',
    tx_ref: "REF-001YEUEH",
}
flw.MobileMoney.ghana(payload)
    .then(console.log)
    .catch(console.log);

// Install with: composer require flutterwavedev/flutterwave-v3

$flw = new \Flutterwave\Rave(getenv('FLW_SECRET_KEY'));
// Set `PUBLIC_KEY` as an environment variable
$mobileMoneyService = new \Flutterwave\MobileMoney();
$payload = [
    "type" => "mobile_money_ghana"
    "phone_number" => '25454709929220',
    "amount" => 1500,
    "currency" => 'GHS',
    "network" => "MTN",
    "email" => '[email protected]',
    "tx_ref" => $this->generateTransactionReference(),
];
$response = $mobileMoneyService->mobilemoney($payload);
print_r($response);

# Install with: gem install flutterwave_sdk

require 'flutterwave_sdk'

flw = Flutterwave.new(ENV["FLW_PUBLIC_KEY"], ENV["FLW_SECRET_KEY"], ENV["FLW_ENCRYPTION_KEY"])
charge = MobileMoney.new(flw)
payload = {
    phone_number: '054709929220',
    amount: 1500,
    currency: 'GHS',
    network: "MTN",
    email: '[email protected]',
    tx_ref: generate_transaction_reference,
}
response = charge.initiate_charge payload
print response

curl --request POST \
   --url https://api.flutterwave.com/v3/charges?type=mobile_money_ghana \
   --header 'Authorization: Bearer YOUR_SECRET_KEY' \
   --header 'content-type: application/json' \
   --data '{
     "phone_number": "054709929220",
     "amount": 1500,
     "currency": "GHS",
     "network": "MTN",
     "email": "[email protected]",
     "tx_ref": "BJUYU399fcd43"
}'

Handling the Response

The charge response returns a meta.authorization object containing the details needed to complete the transaction.

One key detail is the meta.authorization.redirect URL. You’ll need to redirect the customer to this URL, where they can authorize the payment before the transaction is finalized.

{
  "status": "success",
  "message": "Charge initiated",
  "meta": {
    "authorization": {
      "redirect": "https://checkout-v2-qa.f4b-flutterwave.com/captcha/verify/lang-en/3441:877713af5525b0668a8a7018727a9a83",
      "mode": "redirect"
    }
  }
}

Completing the Payment

To complete a payment, redirect the customer to the payment confirmation URL returned in the payment initiation response. Follow the steps below to confirm the transaction.

Payment Confirmation Steps

  1. After the payment is initiated, the API returns a payment confirmation URL.
  2. Redirect the customer to this URL.
  3. The customer waits on the confirmation page while the transaction is processed.
  4. The final transaction status is displayed once processing is complete.

🧪

Testing Tip

In Test Mode, Ghanian mobile money payments are automatically authorized after a few seconds.

When the payment is completed, we'll send you a webhook notification. Here's what the response would look like:

{
  "event": "charge.completed",
  "data": {
    "id": 2073992,
    "tx_ref": "BJUYU399fcd43",
    "flw_ref": "flwm3s4m0c1620380894041",
    "device_fingerprint": "N/A",
    "amount": 1500,
    "currency": "RWF",
    "charged_amount": 1500,
    "app_fee": 43.5,
    "merchant_fee": 0,
    "processor_response": "Approved",
    "auth_model": "MOBILEMONEY",
    "ip": "::ffff:10.30.86.54",
    "narration": "MerchantName",
    "status": "successful",
    "payment_type": "mobilemoneyrw",
    "created_at":"2021-05-07T09:48:13.000Z",
    "account_id": 732559,
    "meta": null,
    "customer":{
      "id": 841600,
      "name": "Anonymous Customer",
      "phone_number": "054709929220",
      "email": "[email protected]",
      "created_at":"2021-05-07T09:48:13.000Z"
    }
  }

In your webhook handler, you can then verify the payment and credit your customers with whatever they paid for. See our guide to transaction verification for details.

Updated 4 days ago