BazaarPay Android SDK

BazaarPay is an all-in-one digital payment service that provides innovative payment solutions, including Direct debit , E-wallet, and BNPL. Our goal is to simplify money management and help businesses increase sales.

This project is the SDK for integrating BazaarPay within your Android applications. For additional information about BazaarPay, please visit our website.

Requirements

• The SDK requires Android 4.2 (API level 17) or higher.
• You need a Checkout Token or a PaymentURL before starting a payment. Checkout Token is a unique identifier that provides essential payment information. Check out this documentation on how to generate one.

Setup

Configure the repositories

BazaarPay is available through the JitPack repository. You can declare this repository in your build script as follows:

Kotlin DSL

repositories {
    maven { url = uri("https://jitpack.io") }
}

Groovy DSL

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

Add the dependency

After repository configuration, add a dependency on BazaarPay to your module's build.gradle file:

Kotlin DSL

dependencies {
    implementation("com.github.cafebazaar:bazaarpay:5.3.4")
}

Groovy DSL

dependencies {
    implementation 'com.github.cafebazaar:bazaarpay:5.3.0'
}

Usage

1. Register Payment Callback

BazaarPay uses the Activity Result API. Register the payment callback by calling the registerForActivityResult with an instance of StartBazaarPay as its contract parameter. The callback provides you with a boolean that indicates whether the payment was successful or not:

val bazaarPayLauncher = registerForActivityResult(StartBazaarPay()) { isSuccessful ->
    if (isSuccessful) {
        // A successful payment.
    } else {
        // An unsuccessful payment (Canceled by the user).
    }
}

The happy path of this if statement is the place you need to commit the paymentURL.

2. Launch Payment

Registering the payment callback will return a payment launcher instance. You can start a payment flow by calling the launch() function on the payment launcher. It takes an instance of the BazaarPayOptions as its parameter:

val options = BazaarPayOptions
    .paymentUrl(paymentURL = paymentURL)
    .authToken(authToken = AUTO_LOGIN_TOKEN) //optional (autoLogin)
    .build()
bazaarPayLauncher.launch(options)

BazaarPayOptions has a mandatory paymentURL parameter which is the URL you generated before. But there are also other optional parameters that you can configure to your needs:

• phoneNumber - pre-fills the input field of the login screen with this number.
• authToken - Optional input for autoLogin

3. Commit paymentURL

You have to commit the Payment URL after successful payment. There is a suspend commit() function for this purpose that you can call from a coroutine scope:

// Inside isSuccessful branch of the registered payment callback
myScope.launch {
    commit(
        paymentURL = "PAYMENT_URL",
        context = requireContext(),
        onSuccess = { },
        onFailure = { }
    )
}

Otherwise, if you are using other technologies, you need to implement this yourself. It is better to call it from a WorkManager worker or a Service for safety reasons.

Although sending tokens through the SDK is possible, we recommend this happens on the server side.

DirectPay Contract

DirectPay is a feature that enables direct payment from the merchant without user intervention, particularly useful for cases like automatic subscription renewal. You can find more information about DirectPay here.

This SDK allows you to obtain permission from the user for DirectPay. We will explain more about it below. First, let's register the contract callback.

val bazaarPayDirectPayContractLauncher = registerForActivityResult(
    StartDirectPayFinalizeContract()
) { isSuccessful ->
    if (isSuccessful) {
        // A successful directPay contract.
    } else {
        // An unsuccessful directPay contract (or canceled by the user).
    }
}

To provide a better user experience, please display appropriate messages to users in both successful and unsuccessful scenarios, informing them of the outcome.

Launch DirectPayContract

To initiate a payment flow, you can call the launch() function on the directPayContract launcher. It requires an instance of DirectPayContractOptions as its parameter:

 val options = DirectPayContractOptions(
    contractToken = contractToken,
    message = message, //optional
    phoneNumber = phone, //optional
    authToken = AUTO_LOGIN_TOKEN //optional (autoLogin)
)
bazaarPayDirectPayContractLauncher.launch(options)

BazaarPay Login API

Some functionalities in BazaarPay like getBalance, need BazaarPay login (in case you don't want to use autoLogin), for login in BazaarPay you need to make a login launcher:

val bazaarPayLoginLauncher = registerForActivityResult(StartLogin()) { isSuccessful ->
    if (isSuccessful) {
        // A successful login.
    } else {
        // An unsuccessful login.
    }
}

And then launch() the bazaarPayLoginLauncher like below:

 val options = BazaarPayLoginOptions(phoneNumber = phone)
bazaarPayLoginLauncher.launch(options)

BazaarPay Balance

You can get user's balance from BazaarPay. There is a suspend getBazaarPayBalance() function for this purpose that you can call from a coroutine scope:

myScope.launch {
    getBazaarPayBalance(
        context = requireContext(),
        authToken = AUTO_LOGIN_TOKEN, //optional
        onSuccess = { },
        onFailure = { },
        onLoginNeeded = {
            // here you should use BazaarPay Login API, or use autoLogin
        }
    )
}

authToken is an optional parameter that helps you get user balance without login

Open increase balance screen directly

You can open increase balance screen directly and get the result like below:

 val bazaarPayIncreaseBalanceLauncher = registerForActivityResult(StartIncreaseBalance()) { isSuccessful ->
    if (isSuccessful) {
        // A successful increase balance.
    } else {
        // An unsuccessful increase balance.
    }
}

And then launch() the bazaarPayIncreaseBalanceLauncher like below:

 val options = IncreaseBalanceOptions(
    authToken = AUTO_LOGIN_TOKEN, //optional 
)
bazaarPayIncreaseBalanceLauncher.launch(options)

License

Copyright 2022 Cafebazaar, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.