Quick Start

Let's get started with Volume in less than 5 minutes.

Android SDK for Volume is a library with Volume custom view that allows you to display Volume checkout and start accepting payments from your customers in zero time into any Android app.

Getting Started

Get started by installing Volume Android SDK.

    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/getvolume/volume-android-sdk")
            credentials {
                username volume-public
                password // Token provided by Volume
            }
        }
    }

Add dependency to volume-android-sdk (Ask Volume team for the latest version number)

dependencies {
    implementation "com.volume.sdk:volume-android-sdk:1.0.3"
}

Volume Provider

The volume provider should be placed at the root level of your application, this provides key global configuration for using volume in your application.

class SampleApplication : Application() {
    override fun onCreate() {
        super.onCreate()
 
        VolumeProvider.init(
            volumeSetup = VolumeSetup(
                applicationId = "", // Provided by Volume
                volumeEnvironment = "sandbox",
                onEvent = { Timber.v("[Sample App Volume] On Event: $it") }, // Your own event listener
                logger = logger, // Your own logger implementation
                showSandboxBanks = true,
                maxPaymentAmount = 150.toBigDecimal(),
                minPaymentAmount = 0.01.toBigDecimal(),
                buttonCustomisation = ButtonCustomisation(),
                translations = mapOf(
                    "EN" to VolumeTranslations(accountHolderNameText = "Name and Surname"),
                    "DE" to VolumeTranslations(accountHolderNameText = "Name und Nachname")
                ),
                language = "EN",
            ),
            app = this
        )
        VolumeProvider.setLanguage("DE") // Use this to change language in runtime
    }
}

Properties

Expand the section below for a quick glance at what you need to know.

The Volume Button

When VolumeProvider is initialized then you can add Volume button to your screen by adding VolumePaymentButtonView View:

    <com.volume.sdk.payment.VolumePaymentButtonView
        android:id="@+id/volumePaymentView"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="16dp"
        app:layout_constraintTop_toBottomOf="@id/volume_toggle" />

Then you can set the properties from your Activity/Fragment code

        binding.volumePaymentView.setAmount("1".toBigDecimal())
        binding.volumePaymentView.setReference("payment ref")
        binding.volumePaymentView.setMerchantPaymentId("Payment 86")
        binding.volumePaymentView.setCurrency("GBP")

Implementing the after payment screen (Callback) in mobile app

Upon completion of the payment process, users are directed back from the banking app to your app using a callback via an app link or universal link. Volume accepts only https links, which means traditional deep links like myapp://callback are not supported. Instead, we recommend using App Links and Universal Links, such as https://myDomain.com/callback (opens in a new tab), for their superior security, user experience, seamless integration, and web fallback capabilities.

Android:

About app links (opens in a new tab)

Create Deep Links to App Content (opens in a new tab)

iOS:

Supporting universal links in your iOS app (opens in a new tab)

Supporting associated domains on iOS (opens in a new tab)

Flutter:

Flutter app links library (opens in a new tab)

Universal links on Flutter (opens in a new tab)

React Native:

React Native linking documentation (opens in a new tab)

React Native app links tutorial (opens in a new tab)

Documentation for the Volume Callback parameters: Callback

Testing

After you have completed the steps above, then you can start testing.

We strongly recommend to use sandbox environment before switching to live environment.

Please note that sandbox testing will not open the Banking app due to lack of testing environment offered by the different banks in the UK. However, a successful test will open the bank environment via the browser. The user experience will differ bank by bank. Ask us more information at support@getvolume.com or use the chat in this page to get immediate assistance.

Please check Sandbox Banks Credentials to be able to test with Natwest Sandbox and other sandbox banks.