PayUnit Native Android Library

The PayUnit Android Library provides a customizable button for processing payments in your native android application. This library simplifies the integration of payunit into your app.

If you don't know how to get your API credentials in the Dashboard, please consult Getting your API Key (opens in a new tab) documentation.

To Get Started with this library, Make sure you have a native android application ready. Also make sure you have subscribed to the various payment providers you want.

Table of Contents

• Installation
• Usage
  • XML Usage
  • Java Usage
  • Kotlin Usage

Installation

To use the PayUnit library in your Android project, follow these steps:

1. Add Internet permission to your AndroidManifest.xml file:

   AndroidManifest

   <?xml version="1.0" encoding="utf-8"?>
        <manifest xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools">
    
        <uses-permission android:name="android.permission.INTERNET"/>
    
    </manifest>

2. Add JitPack to your project-level build.gradle file:

   Groovy

   allprojects {
       repositories {
           google()
           mavenCentral()
           maven { url 'https://jitpack.io' }
       }
   }

   Kotlin

   allprojects {
       repositories {
           google()
           mavenCentral()
           maven ("https://jitpack.io")
       }
   }

3. Add the dependency to your app-level build.gradle file:

   Groovy

   dependencies {
       implementation 'com.gitlab.sevencommonfactor:payunit-android-sdk:0.0.1'
   }

   Kotlin

   dependencies {
       implementation("com.gitlab.sevencommonfactor:payunit-android-sdk:0.0.1")
   }

Usage

XML Usage

To use the PayUnitButton in your XML layout, add the following code:

   <com.gitlab.sevencommonfactor.PayUnitButton
    android:id="@+id/payUnitButton"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"/>

Java Usage

To use the PayUnitButton in your Java code, follow these steps:

1. Import and Initialize the button in your activity:

   import android.os.Bundle;
   import androidx.appcompat.app.AppCompatActivity;
   import com.gitlab.sevencommonfactor.PayUnitButton; // Import the PayUnitButton
    
   public class MainActivity extends AppCompatActivity {
    
       @Override
       protected void onCreate(Bundle savedInstanceState) {
           super.onCreate(savedInstanceState);
           setContentView(R.layout.activity_main);
    
           // Initialize the PayUnitButton
            PayUnitButton payUnitButton = findViewById(R.id.payUnitButton);
    
            // Configure the PayUnitButton
            payUnitButton.apiUsername("your_api_username");
            payUnitButton.apiPassword("your_api_password");
            payUnitButton.apiKey("your_api_key");
            payUnitButton.mode("live"); // "live" or "sandbox"
            payUnitButton.paymentCountry("CM"); // Example: Cameroon
            payUnitButton.totalAmount(1000); // Amount in Integer
            payUnitButton.currency("XAF"); // Currency code
            payUnitButton.returnUrl("your_return_url");
            payUnitButton.notifyUrl("your_notification_url");
    
             // Set a payment callback
            payUnitButton.setPaymentCallback(new PayUnitButton.PaymentCallback() {
            @Override
            public void onComplete(String transactionId, String transactionStatus) {
                if(transactionStatus == "SUCCESS"){
                    // TODO: Handle successful transaction             
                }else if(transactionStatus == "FAILED"){
                    // TODO: Handle failed transaction             
                }
            }
            
        });
    
       }
   }

Kotlin Usage

To use the PayUnitButton in your Kotlin code, follow these steps:

1. Import and Initialize the button in your activity:

   import android.os.Bundle
   import androidx.appcompat.app.AppCompatActivity
   import com.gitlab.sevencommonfactor.PayUnitButton // Import the PayUnitButton
    
   class MainActivity : AppCompatActivity() {
    
       override fun onCreate(savedInstanceState: Bundle?) {
           super.onCreate(savedInstanceState)
           setContentView(R.layout.activity_main)
    
            // Initialize the PayUnitButton
            val payUnitButton: PayUnitButton = findViewById(R.id.payUnitButton)
    
            // Configure the PayUnitButton
            payUnitButton.apiUsername = "your_api_username"
            payUnitButton.apiPassword = "your_api_password"
            payUnitButton.apiKey = "your_api_key"
            payButton.mode = "live" // "live" or "sandbox"
            payUnitButton.paymentCountry = "CM" // Example: Cameroon
            payButton.totalAmount = 1000 // Amount in integer
            payButton.currency = "XAF" // Currency code
            payButton.returnUrl = "your_return_url"
            payButton.notifyUrl = "your_notification_url"
            payButton.setPaymentCallback(object : PayUnitButton.PaymentCallback {
                override fun onComplete(transactionId: String, transactionStatus: String) {
                    if(transactionStatus == "SUCCESS"){
                       // TODO: Handle successful transaction             
                    }else if(transactionStatus == "FAILED"){
                       // TODO: Handle failed transaction             
                    }
                }
            })
       }
   }