Flutterwave Android SDK

Flutterwave's Android SDK can be used to integrate the Flutterwave payment gateway into your android app. It comes with a ready-made Drop In UI and non-UI module, depending on your preference.

The payment methods currently supported are Cards, USSD, Mpesa, GH Mobile Money, UG Mobile Money, ZM Mobile Money, Rwanda Mobile Money, Franc Mobile Money, US ACH, UK Bank, SA Bank, Nigeria Bank Account, Nigeria Bank Transfer, Barter Mobile Wallet.

Before you begin

• Ensure you have your test (and live) API keys.
• The use of this SDK means you have signed up on Flutterwave and have accepted Flutterwave's terms and conditions and privacy policy.

Requirements

• The minimum supported SDK version is 15
• Rave android sdk 1.0.50 and above only supports projects that have been migrated to androidx. For more information, read Google's migration guide.

Adding it to your project

Step 1. Add it in your root build.gradle at the end of repositories:

    allprojects {
        repositories {
            //...
            maven { url 'https://jitpack.io' }
        }
    }

Step 2. Add the dependency

If you want to use the default Drop In UI, add the rave-android module dependency

    dependencies {
         implementation 'com.github.flutterwave.rave-android:rave_android:2.1.39'
    }

if you are not interested in our default UI and you want to use yours and only want to interact with our core sdk, use the rave_presentation module

    dependencies {
         implementation 'com.github.Flutterwave.rave-android:rave_presentation:2.1.39'
    }

Step 3. Add the INTERNET permission to your android manifest

 <uses-permission android:name="android.permission.INTERNET" /> 

The steps below show how to use the Flutterwave Android SDK as a Drop-in UI (all the views for the payment process are handled by the SDK). If you would like to use your own custom UI instead, please see the continuation here.

Usage

For using the default UI

1. Create a RaveUiManager instance

Set the public key, encryption key and other required parameters. The RaveUiManager accepts a mandatory instance of the calling Activity (or a Fragment that has a parent activity).

    new RaveUiManager(activity).setAmount(amount)
                    .setCurrency(currency)
                    .setEmail(email)
                    .setfName(fName)
                    .setlName(lName)
                    .setNarration(narration)
                    .setPublicKey(publicKey)
                    .setEncryptionKey(encryptionKey)
                    .setTxRef(txRef)
                    .setPhoneNumber(phoneNumber, boolean)
                    .acceptAccountPayments(boolean)
                    .acceptCardPayments(boolean)
                    .acceptMpesaPayments(boolean)
                    .acceptAchPayments(boolean)
                    .acceptGHMobileMoneyPayments(boolean)
                    .acceptUgMobileMoneyPayments(boolean)
                    .acceptZmMobileMoneyPayments(boolean)
                    .acceptRwfMobileMoneyPayments(boolean)
                    .acceptSaBankPayments(boolean)
                    .acceptUkPayments(boolean)
                    .acceptBankTransferPayments(boolean)
                    .acceptUssdPayments(boolean)
                    .acceptBarterPayments(boolean)
                    .acceptFrancMobileMoneyPayments(boolean)
                    .allowSaveCardFeature(boolean)
                    .onStagingEnv(boolean)
                    .setMeta(List<Meta>)
                    .withTheme(styleId)
                    .isPreAuth(boolean)
                    .setSubAccounts(List<SubAccount>)
                    .shouldDisplayFee(boolean)
                    .showStagingLabel(boolean)
                    .initialize();

2. Handle the response

In the calling activity, override the onActivityResult method to receive the payment response as shown below

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        /*
         *  We advise you to do a further verification of transaction's details on your server to be
         *  sure everything checks out before providing service or goods.
        */
        if (requestCode == RaveConstants.RAVE_REQUEST_CODE && data != null) {
            String message = data.getStringExtra("response");
            if (resultCode == RavePayActivity.RESULT_SUCCESS) {
                Toast.makeText(this, "SUCCESS " + message, Toast.LENGTH_SHORT).show();
            }
            else if (resultCode == RavePayActivity.RESULT_ERROR) {
                Toast.makeText(this, "ERROR " + message, Toast.LENGTH_SHORT).show();
            }
            else if (resultCode == RavePayActivity.RESULT_CANCELLED) {
                Toast.makeText(this, "CANCELLED " + message, Toast.LENGTH_SHORT).show();
            }
        }
        else {
            super.onActivityResult(requestCode, resultCode, data);
        }
    }

The intent's message object contains the raw JSON response from the Rave API. This can be parsed to retrieve any additional payment information needed. Typical success response can be found here and failed response here.

PLEASE NOTE We advise you to do a further verification of transaction's details on your server to be sure everything checks out before providing service or goods.

3. Customize the look

You can apply a new look by changing the color of certain parts of the UI to highlight your brand colors.

First specify the theme in your styles.xml file. In this theme, you can edit the style for each of the elements you'd like to style, like the pay button, OTP button, etc.

    <style name="MyCustomTheme" parent="RaveAppTheme.NoActionBar">
        <item name="colorPrimary">@color/colorPrimary</item>
        <item name="colorPrimaryDark">@color/colorPrimaryDark</item>
        <item name="colorAccent">@color/colorAccent</item>
        <item name="OTPButtonStyle">@style/myOtpBtnStyle</item>
        <item name="PayButtonStyle">@style/myBtnStyle</item>
    <item name="PinButtonStyle">@style/myPinButtonStyle</item>
        <item name="OTPHeaderStyle">@style/myOtpHeaderStyle</item>
        <item name="TabLayoutStyle">@style/myTabLayoutStyle</item>
        <item name="PinHeaderStyle">@style/myPinHeaderStyle</item>
        <item name="PaymentTileStyle">@style/myPaymentTileStyle</item>
        <item name="PaymentTileTextStyle">@style/myPaymentTileTextStyle</item>
        <item name="PaymentTileDividerStyle">@style/myPaymentTileDividerStyle</item>
    </style>

Then in your RavePayManager setup, add .withTheme(<Reference to your style>) anywhere before calling the initialize() function. e.g.

  new RavePayManager(activity).setAmount(amount)
                    //...
                    //...
                    .withTheme(R.Style.MyCustomTheme)
                    .initialize();

There is a limit to which the drop-in UI can be customized. For further customization, see our Custom UI implemetation guide here.

Configuring Proguard

To configure Proguard, add the following lines to your proguard configuration file. These will keep files related to this sdk

keepclasseswithmembers public class com.flutterwave.raveandroid.** { *; }
dontwarn com.flutterwave.raveandroid.card.CardFragment

Help

• Have issues integrating? Join our Slack community for support
• Find a bug? Open an issue
• Want to contribute? [Check out contributing guidelines]() and submit a pull request.

Want to contribute?

Feel free to create issues and pull requests. The more concise the pull requests the better :)

License

Rave's Android SDK
MIT License

Copyright (c) 2020

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.