The MobilePayments SDK is a library containing a suite of payment tools designed to be simple and easy to integrate into an existing, or new, mobile application. It is a collection of easy to use UI widgets that can support varying levels of integration, everything from an isolated full-screen takeover to individual widgets that can be embedded into an existing UI, with extensive customization to fit nearly any look and feel.
In addition, for those looking for a truly custom experience, the full underlying Payments API is available to be plugged directly into a custom-built UI.
To use the MobilePayments SDK on Android, your app must have
- a
minSdkVersionof26or higher - a
compileSdkVersionof36or higher
In addition, you must set up a merchant account and associated payment configurations with Fiserv
To install on Android, first ensure you have added the maven repository to your project. To do so, you must ensure the following is in your project’s settings.gradle.kts file
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
maven {
url = uri("https://maven.pkg.github.com/Fiserv/mobile-payments-android")
credentials {
username = "USERNAME_PROVIDED_BY_FISERV"
password = "PASSWORD_PROVIDED_BY_FISERV"
}
}
}
}
Next you need to add the dependency to your module’s Gradle build file (app/build.gradle.kts):
dependencies {
implementation("com.fiserv.payments:mobile-payments:<version>")
}
Once added, simply sync your gradle files and the MobilePayments SDK will be available in your code, and you are ready.
Initializing the MobilePayments SDK is done on app start, in the Application.onCreate method. Here, you will provide:
- a reference to the host Application
- the Environment (SANDBOX or PRODUCTION) you wish to run the SDK on
- the clientToken provided when your merchant account was configured
- (OPTIONAL) the ID of a store within your merchant, that will assign transactions and payments made to that store
The invocation will look like this:
MobilePayments.initialize(
application = this,
environment = Environment.SANDBOX,
clientToken = "<clientToken>",
businessLocationId = "<businessLocationId>",
)
In addition, you are able to configure certain optional parameters to control and influence the behavior of the MobilePayments SDK. These are:
- A customer ID value (typically an account ID or otherwise unique identifier for a customer). This will allow a customer with this ID value to access previously saved Credit Cards for use in future payments.
MobilePayments.setCustomerId("<CUSTOMER_ID>")
- The ID of a store within your merchant, this is the same value that can be passed into inititalize. This will direct payments to that location specifically as well as ensure payment configurations are accurate to the specific store in the event of different configurations within the same merchant.
MobilePayments.setBusinessLocationId("<STORE_ID>"
- A boolean to control GooglePay access in the Sheets integration
MobilePayments.setGooglePayEnabled(true)
The Mobile Payments SDK has an extensive Customization suite available to finetune the look and feel of the provided UI to match the host application. You can find details in the Customization walkthrough
The first step to integrating the MobilePayments SDK is determining what method of integration is right for you.
The simplest and easiest of the available options is Sheets. This is as quick and easy as firing off an intent and monitoring the response. This is by far the easiest path to go, but simultaneously the least flexible.
If you require more flexibility, but don’t want to deal with customer information directly, or just want a personalized touch to the user experience, then using the MobilePayments UI Components is the way to go.
If even that’s not enough, and you really must have a unique UI, then you’re looking to interface with MobilePayments Directly. This will take the most work, and you will have to collect user information to pass to MobilePayments, but you will be able to make your app look and behave exactly the way you want to.
Quick Links