openmf / mobile-wallet

A reference implementation of Mifos platform wallet and payment capabilities

Mobile Wallet

Mobile Wallet is an Android-based framework for mobile wallets based on top of Fineract. The app follows clean architecture and contains a core library module that can be used as a dependency in any other wallet based project. It is developed at MIFOS together with a global community.

Notice

⚠️ We are fully committed to implement Jetpack Compose and moving ourself to support kotlin multi-platform. If you are sending any PR regarding XML changes we will not consider at this moment but converting XML to jetpack compose are most welcome. If you sending any PR regarding logical changes in Activity/Fragment you are most welcome.

Development	Chat

Join Us on Slack

Mifos boasts an active and vibrant contributor community, Please join us on slack. Once you've joined the mifos slack community, please join the #mobile-wallet channel to engage with mobile-wallet development. If you encounter any difficulties joining our Slack channel, please don't hesitate to open an issue. This will allow us to assist you promptly or send you an invitation.

How to Contribute

Thank you for your interest in contributing to the Mobile Wallet project by Mifos! We welcome all contributions and encourage you to follow these guidelines to ensure a smooth and efficient collaboration process.

The issues should be raised via the GitHub issue tracker. For Issue tracker guidelines please click here. All fixes should be proposed via pull requests. For pull request guidelines please click here. For commit style guidelines please click here.

Branch Policy

We have the following branches :

• dev All the contributions should be pushed to this branch. If you're making a contribution, you are supposed to make a pull request to dev. Please make sure it passes a build check on Travis.

  It is advisable to clone only the development branch using the following command:

  git clone -b <branch> <remote_repo>
  

  With Git 1.7.10 and later, add --single-branch to prevent fetching of all branches. Example, with development branch:

  git clone -b dev --single-branch https://github.com/username/mobile-wallet.git`
  

• master The master branch contains all the stable and bug-free working code. The development branch once complete will be merged with this branch.

Demo credentials

Fineract Instance: demo.mifos.io

Username: venus

Password: Venus2023#

Development Setup

Before you begin, you should have already downloaded the Android Studio SDK and set it up correctly. You can find a guide on how to do this here: Setting up Android Studio.

1. Fork the Git Repository

   Forking the repository is the first step to start contributing. Click on the "Fork" button in the top right corner of the Mobile Wallet (Mifos Pay) repository to create your own fork.

   

   Forking creates a copy of the project under your GitHub account. This enables you to work on changes without affecting the original repository directly.

2. Clone the Forked Repository

   Once you have forked the repository, you need to clone it to your local development environment. Open a terminal or Git Bash and use the following command:

   git clone https://github.com/yourUsername/mobile-wallet.git

   Replace yourUsername with your actual GitHub username. Cloning creates a local copy of the repository on your machine, allowing you to make changes and contributions.

3. Working Locally on Your Cloned Repository

   After cloning, navigate to the project directory using the terminal or Git Bash.

   Before making any changes, create a new branch dedicated to the feature or bug fix you'll be working on:

   git checkout -b "new-branch-name"

   Ensure that new-branch-name reflects the purpose of your changes (e.g., add-payment-feature or fix-bug-123).

   Make the necessary changes to the files to address the issue you're working on. Once you're done, you will be ready to proceed with verifying and committing your changes.

4. Perform a Gradle Check

All your pull requests must pass the CI build only then, it will be allowed to merge. Sometimes, when the build doesn't pass you can use these commands in your local terminal and check for the errors,

For Mac OS, you can use the following commands:

• ./gradlew check quality checks on your project’s code using Checkstyle and generates reports from these checks.
  
• ./gradlew spotlessApply an check and apply formatting to any plain-text file.
  
• ./gradlew build provides a command line to execute build script.
  

For Windows, you can use the following commands:

• gradlew check quality checks on your project’s code using Checkstyle and generates reports from these checks.
  
• gradlew spotlessApply an check and apply formatting to any plain-text file.
  
• gradlew build provides a command line to execute build script.
  

Committing Your Changes

When you've finished making your changes and have tested them locally, it's time to commit your work:

1. Stage Changes

   Use the following command to stage all changes:

   git add .

   This adds all modified and new files to the staging area, preparing them for the commit.

2. Commit Changes

   Commit your changes with a meaningful commit message that describes the purpose of your changes:

   git commit -m "Your commit message goes here"

   A good commit message is concise and provides enough context about the changes made. Mifos follows its own commit style guidelines that you must follow. Learn more about it here.

3. Push Changes

   Push your changes to your forked repository on GitHub:

   git push origin new-branch-name

   Replace new-branch-name with the name of the branch you created earlier.

Making a Pull Request

Once your changes are pushed to your forked repository, you can initiate a pull request to merge your changes into the main project:

1. Navigate to the Mobile Wallet (Mifos Pay) repository on GitHub.
2. Click on the "Pull Requests" tab and then click "New Pull Request."

1. Ensure the base repository is set to "openMF/mobile-wallet" and the base branch is the main development branch dev.
2. Set the compare repository to your forked repository and the compare branch to the branch you just created with your changes (e.g., in my case, the head repository was set to “rchtgpt/mobile-wallet” and the comparison branch was kotlin-migration-common.
3. Fill out the pull request template, providing a clear description of your changes, why they are necessary, and any relevant information for the reviewers.
4. Click "Create Pull Request" to submit your changes for review.

Squashing Your Commits

It is common for pull requests to undergo multiple rounds of review before being merged. To keep the Git history clean and organized, you should always squash your commits before finalizing the merge. Here's how you can do it:

1. Squash your commits:

   git rebase -i HEAD~x

   Replace x with the number of commits you want to squash. An interactive rebase will open, allowing you to choose how to combine the commits. Change pick to squash (or simply s) for all but the topmost commit. Save and exit the editor.

2. Amend the commit message if needed.

   git commit --amend

3. Force push the changes to your forked repository:

   git push --force origin your-branch-name

   Please note that force pushing rewrites the Git history, so use it with caution.

Solving Merge Conflicts

In some cases, your pull request might encounter merge conflicts when the changes cannot be automatically merged with the main branch. To resolve merge conflicts:

1. Update your local branch with the latest changes from the main repository:

   git fetch upstream
   git checkout your-branch-name
   git rebase upstream/master

2. Git will pause when encountering conflicts. Open the affected files, resolve the conflicts manually, and save the changes.

3. After resolving all conflicts, stage the changes and continue with the rebase:

   git add .
   git rebase --continue

4. Finally, force push the changes to your forked repository:

   git push --force origin your-branch-name
   

Your pull request will be updated with the resolved conflicts, and the reviewers can proceed with the review process. Again, don’t forget to squash your commits.

Conclusion

By following these contribution guidelines, you're all set to start contributing to the Mobile Wallet (Mifos Pay) project. We appreciate your efforts and look forward to your valuable contributions. Happy coding!

Instructions to get the latest APK

To get the latest apk fom the Github actions artifacts, follow these steps:

1. Navigate to the Actions tab of this repository.
2. Click the latest workflow from the workflows list.
3. Scroll down to the Artifacts section and click the mobile-wallet hyperlink.
4. After successful download, extract the zip file to your preferred location.

Wiki

https://github.com/openMF/mobile-wallet/wiki

Screenshots

Click here for more screenshots

Contributors

Special thanks to the incredible code contributors who continue to drive this project forward.

mobile-wallet's Issues

Add UI for initiating a new payment

Incorrect Pin

Summary:

When we press an incorrect passcode it must give a popup that it is an incorrect passcode

Steps to reproduce:

When we open the app it asks for the passcode

Expected behavior:
It must show (Incorrect Passcode)

Observed behavior:

When we enter incorrect passcode nothing is shown

Device and Android version:

Xaiomi Redmi Note 4( Mido)
Android Version-7(Nougat)

Screenshots:

Mobile Number is not formatted

Summary:

Mobile number is not correctly formatted, it is in raw form.

Steps to reproduce:

Go to Transfer Tab from Dashboard

Expected behavior:

I expected that mobile number would be well formatted according to its country code.

Observed behavior:

The mobile number was not formatted

Device and Android version:

Pixel 2 Android Marshmallow (Android Emulator)

Feature Request: Disable login button if any field is empty

Summary:

We could improve user experience by disabling login button if any login field is empty. PayPal use this solution.

Steps to reproduce:

Leave any input empty

Expected behavior:

Disable login button

Observed behavior:

Login button is enabled even if Input is empty

Device and Android version:

Android 8.0 Huawei p10

Screenshots:

Mifospay: Request Money page is just behaving like 'Send' Money page and throwing the same error

Handle unique payment links

Use intent filter and schemes to intercept unique payment links and handle them inside the app itself.

New payment links ganerated should have the same schema as the one that will be intercepted.

Cannot change Mobile Number

Summary:

There is option to change the mobile number but it gives an error.

Steps to reproduce:

Dashboard -> Profile -> Edit Profile -> Change Mobile Number.

Expected behavior:

I would be able to change the Mobile Number without any error.

Observed behavior:

When tried to change the email Id, error pops up.

Device and Android version:

Android Emulator Pixel 2 (Marshmallow)

Bug: Error while running gradle check

Summary:

./gradlew check throws an error with following message:
Task :core:findbugs No files to be analyzed

Steps to reproduce:

1. Open terminal on Android Studio
2. Run ./gradlew check

Expected behavior:

./gradlew check to be executed successfully

Observed behavior:

./gradlew check throws an error with following message:
Task :core:findbugs No files to be analyzed

App Crashes when trying to sign up without Google Account

Summary:

The App crashed when I tried to sign up without a Google Account.

Steps to reproduce:

Login -> Register a Account -> Uncheck the checkbox of Google Account (important) -> Click on Register

Expected behavior:

I expected that it will take me to a screen where I can fill in my details and register myself.

Observed behavior:

The App crashed when I tried to Register account.

Device and Android version:

Pixel 2 Android Marshmallow (Android Emulator)

Outdated Wiki

I've updated the wiki here
Updated Wiki link: https://github.com/ankurs287/mobile-wallet/wiki

To merge latest changes, follow this

Bug: User's profile picture isn't rounded when profile image's changed

Summary:

User's profile image should be always rounded.

Steps to reproduce:

Dashboard > Profile > Edit Profile > Change profile picture

Expected behavior:

Rounded profile image

Observed behavior:

The image is a rectangle shape.

Device and Android version:

Huawei p10, Android 8.0

Screenshots:

Issue when cloning the app

Error:(4, 0) Could not get unknown property 'RblClientIdProp' for project ':app' of type org.gradle.api.Project.
Open File

Any help would be gladly appreciated

Adding transition effect to UI for Home Activity

Summary:

Transition effect between the Home, Profile and Transfer

Steps to reproduce:

Go to Home

Expected behavior:

On swiping left or right new activity should appear. If current activity is Home on sliding left, Tranfer activity should be displayed.

Observed behavior:

On sliding, doesn't switch to new activity.

Device and Android version:

Redmi Note 5 Pro (WHYRED)
MIUI Global 9.6
Android Oreo 8.1.0

Gif:

Incorrect Passcode display in UI

Summary:

When we open the app it must display incorrect passcode when we type the incorrect passcode

Steps to reproduce:

1. Open the app
2. A display appears to enter passcode

Expected behavior:

To show incorrect passcode when we entered incorrectly

Observed behavior:

When the incorrect passcode is entered nothing is displayed

Device and Android version:

Device-Xiaomi Redmi Note 4 (Mido)
Android Version-7(Nougat)

Screenshots:

Add UI for checking account balance using upi

No changes required in core library for this

Store person/business details of recent transactions

App should be able to store with whom transactions have been done by a particular user.

Specifically, name of the person should also be stored in a transaction.

Further, transactions involving a specific person should also be fetched

List all registered merchants and businesses.

When user initiates a new payment, he should be able to search from registered businesses.

Searching registered businesses should be implemented in core library

Update Profile Section Does Not Handle Same Cases

Summary:

When updating fields in the edit profile section, the user is not informed if they update their profile with the same data.

Steps to reproduce:

Visit the profile section and go to the editor by pressing the edit icon in the top right. In the editor, try updating a field with the same information. The app should have no mechanism to inform you that you have inputted the current data.

Expected behavior:

The toast message that appears after updating a field should reflect the corner cases of when data is the same.

Observed behavior:

The toast messages ignore this case, sometimes saying "Error" and other times "Updated Successfully".

Device and Android version:

Google Pixel, Android 9.0 Pie

Screenshots:

Mifospay: Unable to send money. Showing the error : Unable to process transfer.

On Home page, tap on send button. On next page, provide the amount and VPA. Then press on Send Money and confirm.

Add Checks while storing cards

Summary:

There should be some checks which are required for when we store cards. Currently, we do not have any checks.

Steps to reproduce:

Dashboard -> Saved Cards -> Add Card -> Try different things like leave some TextField empty or input a expired date.

Expected behavior:

There would be various checks while a user is adding a card like if a user has left any field empty then there would be some error.

Observed behavior:

There were no checks and user can even store a empty card.

Device and Android version:

Pixel 2 Android Marshmallow (Android Emulator)

Feature Request: Add FAQ Section

Summary:

As of now, there is no FAQ section which would explain about the features of the app or organisation using it.

Steps to reproduce:

No steps to reproduce as feature doesn't exists.

Expected behavior:

There would be a FAQ section which would clarify about app's features. The FAQ section will be added under settings option in Profile Fragment. Create a button to launch an activity which would display FAQ. Add Dummy questions as of now.

Observed behavior:

There wasn't any FAQ section.

Device and Android version:

Android Marshmallow Pixel 2 Android Emulator

Cannot change the email

Summary:

There is option to change the email ID but it gives an error.

Steps to reproduce:

Dashboard -> Profile -> Edit Profile -> Change Email.

Expected behavior:

I would be able to change the email ID without any error.

Observed behavior:

When tried to change the email Id, error pops up.

Device and Android version:

Android Emulator Pixel 2 (Marshmallow)

On clicking Scan Code nothing is shown

Summary:

On clicking "Scan Code" in the Transfer Screen nothing is shown.

Steps to reproduce:

Click on Transfer in Home Screen and then click on Scan Code option.

Expected behavior:

A barcode or QR code scanning camera should open up.

Observed behavior:

A blank screen with "Scan Code" written on the toolbar.

Device and Android version:

Samsung Galaxy J2(2016) Android Version : 6.0.1

No action on clicking the signup button

Summary:
On clicking the signup button on the login screen no action is performed.

Steps to reproduce:
Click on the sign up button on the login screen.
Expected behavior:
A new activity should open up asking for the details of a new user to sign up.
Observed behavior:
No action on clicking the button
Device and Android version:
Samsung Galaxy J2(2016) Android 6.0.1

Virtual Payment Address should be of only single line

Observed Behavior:
Currently, VPA is of multi-line while single line is more than sufficient for VPA input.
Expected Behavior:
VPA EditText should have one line and don't allow user to create multiple lines unnecessarily.
Possible Fix:
In fragment_payment_upi.xml, we can add android:singleLine or android:maxLines in VPA EditText

@edcable @therajanmaurya @naman14 Can I work on this issue ?

Bad keyboard behavior during "new passcode" flow

Summary:

When adding a new passcode, the EditTexts allow the user to type in letters (for a only number password), and an infinite amount of characters (for a 4 digit passcode).

Steps to reproduce:

Visit the profile section and go to the editor by pressing the edit icon in the top right. In the editor, try updating the passcode. The EditTexts should have the behavior described in the summary.

Expected behavior:

The EditTexts should only allow valid 4-digit number passcodes

Observed behavior:

The EditTexts allow the user to type in letters (for a only number password), and an infinite amount of characters (for a 4 digit passcode)

Device and Android version:

Google Pixel, Android 9.0 Pie

Screenshots:

Gradle Check Throwing "Failed to run Gradle FindBugs Worker" Error

Link to the detailed error
https://gist.github.com/ankurs287/6c24f60f7e958478d61c7c6fa47f1bfc

Pixiepay(&Mifospay): We need to login again if we tap back button

There should be some time stamp before the application logs out.

In UI scrolling is very hard

Summary:
When opening the App and going to bank accounts to link the bank account the scrolling is not vey smooth because we are using the Nested ScrollView and recycler View.

Expected behavior:

Smooth Scrolling.

Observed behavior:

Not smooth scrolling we have to scroll a bit hard to move to the next items in the list which will be not nice when anyone uses it.

Device and Android version:

Redmi Note 4 [mido]
MIUI Global 9.6
Android 7.0(Nougat)

GIF:

Edit Profile Photo Header Should Not Be Persistant

Summary:

When editing the user profile, the user photo persists when scrolling downward

Steps to reproduce:

Go to the profile section and select the edit icon in the top right. Inflate the "change password" or "change passcode" and start scrolling, you will then see the profile picture persist, instead of scrolling away.

Expected behavior:

The profile picture should match the scroll behavior, and not stick out which confuses the UI.

Observed behavior:

The profile picture awkwardly persists past other attributes.

Device and Android version:

Google Pixel, Android 9.0 Pie

Screenshots:

Add invoicing support in mifospay

Paying invoices created by a merchant needs to be added in mifospay.

Replace all the hardcoded strings with @string resource

Expected Behavior:
All strings should be added in strings.xml file which are hardcoded in other xml files.
Observed Behavior:
Only Some Strings are defined in strings.xml file while others are not.
Possible Fix:
Remaining Strings can be declared in strings.xml file of the app.
Can I go ahead on this ? @edcable @therajanmaurya

Bug: Back button is not working correctly on Transfers and Profile Tab

Summary:

When I click mobile's back button while I am either on Transfers or Profile Tab, it closes the app whereas in a ideal situation user should be taken to Home tab.

Steps to reproduce:

Open the app -> Go to either Transfers or Profile Tab -> Press back button of Mobile

Expected behavior:

When back button is pressed, user is taken to the Home Screen/Tab.

Observed behavior:

When back button is pressed, the app gets closed.

Device and Android version:

Pixel 2 XL

Feature Request: Improve user's profile image user experience

Summary:

Image should be bigger than the current one. I suggest you to change it to 96x96dp.

We should add a camera icon which should be attached to the user's profile image when in edit profile mode to let the user know he can easily modify his profile picture by clicking on it.

Steps to reproduce:

Image size:

In res/values/dimens there is a <dimen name="user_profile_image_size">60dp</dimen>
All you need to do is change it to 96dp.

Image icon

Icon should appear in edit profile mode:

Dashboard > Profile > Edit Profile

Expected behavior:

Image size is too smal.
The icon should appear when in edit mode.

Observed behavior:

Size of image is too small and looks really bad in the layout.
There is no icon in edit mode.

Screenshots:

Current look:

Here's how It should look like:

Notice

Camera icon shape with size of 32dp has a white border with size of 2dp. Icon inside the shape is called camera_alt and can be downloaded from material icons google's site. and has size of 16dp. (You can experiment with sizes)

No change in brightness on viewing QR Code

Summary:

There is no change in brightness of device when QR Code is shown to the user.

Steps to reproduce:

Transfer -> Show Code

Expected behavior:

The brightness of device can be maximised when clicked on "Show Code" and returned to normal when pressed back.

Can I work on this? @naman14

Feature Request: Remove Profile Picture Option

Summary:

Currently, we are only having feature of Changing the Profile Picture. We want a Remove Profile Picture Option too. This can be achieved by when an user clicks on the profile picture a BottomSheetDialog comes up and shows both the option.

Steps to reproduce:

Dashboard -> Profile -> Edit Profile -> Change Photo.

Expected behavior:

App would provide me the option of Removing the profile picture too.

Observed behavior:

There was no option to remove profile picture.

Device and Android version:

Android Emulator Pixel 2 (Marshmallow)

Bug: User image and text below it, in the Profile section isn't centered because of missing margin parameter

Summary:

User's profile picture and text below it aren't centered, because of missing android:margin_right="@dimen/value_10dp" parameter.

Steps to reproduce:

Dashboard -> Profile

and also

Dashboard -> Profile -> Edit Profile

Expected behavior:

Profile's picture and text below it should be centered.

Observed behavior:

Profile's picture and text below are not centered, but moved 10dp in the right.

Device and Android version:

Huawei p10, Android 8.0

Screenshots:

Add payment link support in core library

For a pending invoice in fineract, corresponding payment link should be there

What should i put on the keys. is their a special place i have to first sign up . Access keys in gradle

Summary:

Summarize your issue here.

Steps to reproduce:

How can we reproduce again the issue?

Expected behavior:

What did you expect the app to do?

Observed behavior:

What did you see instead? Describe your issue in detail here.

Device and Android version:

What make and model device (e.g., Samsung Galaxy S3) did you encounter this on? What Android
version (e.g., Android 4.0 Ice Cream Sandwich or Android 6.0 Marshmallow) are you running? Is it
the stock
version from the manufacturer or a custom ROM?

Screenshots:

Can be created by pressing the Volume Down and Power Button at the same time on Android 4.0 and higher.

Feature Request: Add Money

Summary:

There is no option to add money whereas the wallet has a balance feature, so how would a customer add money into it.

Expected behavior:

There would be a Add Money option with different options like Debit/Credit Card, Netbanking and UPI.

Observed behavior:

There is no Add money feature.

Device and Android version:

Pixel 2 Android Marshmallow (Android Emulator)

Feature Request: Crop Image Support while changing photo in Edit Profile

Summary:

Provide the support to crop an image when user tries to change the profile picture

Error while transferring money

Summary:

When I tried to send money to other random UPI address, it is showing error in Toast ‘Error fetching Receiver’. Firstly, it should be shown in SnackBar and the error should be more clear like ‘Error finding Virtual Payment Address’ and the loader goes off in a infinite loop.

Also, the wallet balance at that time was 0 so my suggestion is that we should first check if balance is enough and then find the receiver.

Steps to reproduce:

Keep wallet Balance 0.

Dashboard -> Transfer (Send) -> Enter a Random UPI Address and amount greater than balance (in our case greater than 0)

Expected behavior:

The app should firstly search for if balance is enough or not and then if receiver is not find, the error should be shown in a SnackBar with a error message something like Error finding Virtual Payment Address.

Observed behavior:

The firstly searches for a receiver without taking care of balance. Also, shows the error message in a Toast ‘Error fetching Receiver’.

Device and Android version:

Pixel 2 Android Marshmallow (Android Emulator)

GCM to FCM upgrade in Fineract Back-end for notification

Error logging in

Summary:

On entering the credentials,the progressDialog keeps loading or a Toast is displayed saying 'Error logging in'.

Steps to reproduce:

Enter the credentials mentioned in Wiki to login.

Expected behavior:

Should have logged in successfully.

@naman14 Could you please help? Is it a backend issue? Thanks!

App crashes on clicking Send Button

Summary:

In the transfer fragment on clicking the send money button when Amount is not entered the app crashes.

Steps to reproduce:

Click on Transfer or Send or Request on wallet screen and then click on Send Money button without entering any amount.

Expected behavior:

App should prompt the user to enter the amount or not leave the required fields empty.

Observed behavior:

The app crashes on clicking the send money button

Device and Android version:

Samsung Galaxy J2(2016) Android Version : 6.0.1

Separate core and mifospay from pixiepay module

Use jitpack.io to get an aar for our core library module. Use that in pixiepay and make it in a separate repository

Expedite Input Type for Change Passcode

Summary:

Expediting input type for Change Passcode

Steps to reproduce:

1. Go to Profile
2. Click on Change Passcode

Expected behavior:

On clicking Text field for Change Passcode Numeric keyboard will appear.

Observed behavior:

On clicking Text field for Change Passcode Alphanumeric keyboard will appear. (Where passcode can only be a numeric value.)

Device and Android version:

Redmi Note 5 Pro (WHYRED)
MIUI Global 9.6
Android Oreo 8.1.0

Screenshots:

Differentiate between individual person and a merchant/business in user profile

Inappropriate Hint Text in Change Passcode Text Field.

Summary:

Hint text for Change Passcode in Edit Profile is inappropriate.

Steps to reproduce:

1. Go to Profile.
2. Click on edit menu.

Expected behavior:

Hint text should be "New Passcode" in New Passcode text field.

Observed behavior:

Hint text shows "New Password" for a New Passcode text field.

Device and Android version:

Redmi Note 5 Pro (WHYRED)
MIUI Global 9.6
Android Oreo 8.1.0

Gif:

Bug: ./gradlew check fail on building master branch

Summary:

Gradle check on the master branch doesn't pass check successfully. It's failing.

Steps to reproduce:

In your terminal on root directory:

git checkout master
./gradlew check

Expected behavior:

Pass the build.

Observed behavior:

FAILURE: Build failed with an exception.

What went wrong:

BUILD FAILED in 55s
36 actionable tasks: 3 executed, 33 up-to-date