Mobile SDKs
Android SDK

18min
Overview
This guide will walk you through a straightforward solution to accept payments within your Android application. The Moyasar Android SDK helps you accept multiple payment methods in your app including Mada, Visa, and MasterCard.
Installation
Before we can use the SDK, we have to add a couple of things within the app module build.gradle.kts and settings.gradle.kts files.
Add the SDK's hosting repository by adding the following to your settings.gradle.kts file:
settings.gradle.kts
dependencyResolutionManagement {
    // Other configurations

    repositories {
        // Other repositories

        maven {
            url = uri("https://jitpack.io")
        }
    }
}
dependencyResolutionManagement {
    // Other configurations

    repositories {
        // Other repositories

        maven {
            url = uri("https://jitpack.io")
        }
    }
}
﻿
Next, we need to enable the data binding feature, so we have to add the kotlin-kapt plugin and add the following within the android block in the app module build.gradle.kts file:
build.gradle.kts
plugins {
    // Other plugins

    id("kotlin-kapt")
}

android {
    // Other configurations

    buildFeatures {
        dataBinding = true
    }
}
plugins {
    // Other plugins

    id("kotlin-kapt")
}

android {
    // Other configurations

    buildFeatures {
        dataBinding = true
    }
}
﻿
Now, we can add the SDK dependency in the dependencies block inside build.gradle.kts file:
build.gradle.kts
dependencies {
    // Other dependencies

    implementation("com.github.Moyasar:moyasar-android-sdk:1.0.0")
}
dependencies {
    // Other dependencies

    implementation("com.github.Moyasar:moyasar-android-sdk:1.0.0")
}
﻿
Adding permissions
Make sure you have the following permissions in your Android manifest.
XML
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
﻿
Credit Card Payments
The SDK currently only provides Credit Card payment integration. We can use that by first preparing Moyasar's PaymentConfig object as follows:
Kotlin
val paymentConfig = PaymentConfig(
        amount = 100,
        currency = "SAR",
        description = "Sample Android SDK Payment",
        apiKey = "pk_test_vcFUHJDBwiyRu4Bd3hFuPpTnRPY4gp2ssYdNJMY3",
        manual = false,
        metadata = mapOf(
            "order_id" to "order_123"
        ),
        saveCard = false
)
val paymentConfig = PaymentConfig(
        amount = 100,
        currency = "SAR",
        description = "Sample Android SDK Payment",
        apiKey = "pk_test_vcFUHJDBwiyRu4Bd3hFuPpTnRPY4gp2ssYdNJMY3",
        manual = false,
        metadata = mapOf(
            "order_id" to "order_123"
        ),
        saveCard = false
)
﻿
Then, we initialize and display Moyasar's PaymentFragment as follows:
Kotlin
class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        // Other setup code

        val paymentFragment = PaymentFragment.newInstance(this.application, paymentConfig) { this.handlePaymentResult(it) }

        this.supportFragmentManager.beginTransaction().apply {
            // Id for the payment container view
            replace(R.id.paymentSheetFragment, paymentFragment)
            commit()
        }
    }

    fun handlePaymentResult(result: PaymentResult) {
        // ...
    }

    fun handleCompletedPayment(payment: Payment) {
        // ..
    }
}
class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        // Other setup code

        val paymentFragment = PaymentFragment.newInstance(this.application, paymentConfig) { this.handlePaymentResult(it) }

        this.supportFragmentManager.beginTransaction().apply {
            // Id for the payment container view
            replace(R.id.paymentSheetFragment, paymentFragment)
            commit()
        }
    }

    fun handlePaymentResult(result: PaymentResult) {
        // ...
    }

    fun handleCompletedPayment(payment: Payment) {
        // ..
    }
}
﻿
An error will be throwen if the API key format is incorrect.
The payment fragment looks like this:
Android SDK Dark AR
﻿
Android SDK Dark EN
﻿
Handling Credit Card Payment Result
Now, we can handle the Credit Card payment result as follows:
Kotlin
fun handlePaymentResult(result: PaymentResult) {
    when (result) {
        is PaymentResult.Completed -> {
            handleCompletedPayment(result.payment);
        }
        is PaymentResult.Failed -> {
            // Handle error
            val error = result.error;
        }
        PaymentResult.Canceled -> {
            // User has canceled the payment
        }

        else -> { /* Handle other statuses */ }
    }
}

fun handleCompletedPayment(payment: Payment) {
     when (payment.status) {
        "paid" -> { /* Handle successful payment */ }
        "failed" -> {
            val errorMessage = payment.source["message"]
            /* Handle failed payment */
        }
        else -> { /* Handle other statuses */ }
    }
}
fun handlePaymentResult(result: PaymentResult) {
    when (result) {
        is PaymentResult.Completed -> {
            handleCompletedPayment(result.payment);
        }
        is PaymentResult.Failed -> {
            // Handle error
            val error = result.error;
        }
        PaymentResult.Canceled -> {
            // User has canceled the payment
        }

        else -> { /* Handle other statuses */ }
    }
}

fun handleCompletedPayment(payment: Payment) {
     when (payment.status) {
        "paid" -> { /* Handle successful payment */ }
        "failed" -> {
            val errorMessage = payment.source["message"]
            /* Handle failed payment */
        }
        else -> { /* Handle other statuses */ }
    }
}
﻿
'Completed' payment doesn't necessarily mean that the payment is successful. It means that the payment process has been completed successfully.
You need to check the payment status to make sure that the payment is successful.
You can find payment statuses here: Payment Status Reference﻿﻿
Make sure to remove the payment's view after getting the result.
Java interoperability
The SDK is built with Kotlin and allows interoperability with Java.
Testing
Credit Cards
Moyasar provides a sandbox environment for testing credit card payments without charging any real money. This allows you to test your integration and ensure that everything is working correctly before going live with actual payments. Learn more about our testing cards here.
Migration Guide
﻿
From 0.5 to 1.0
This upgrade changes the following:
Installation Setup
The disrtibtution of the SDK has been moved to Jitpack rather than MavenCentral, so you can modify the installation from this:
build.gradle.kts
dependencies {
  // Other dependencies

   implementation("com.moyasar:android-sdk:0.5.1")
}
dependencies {
  // Other dependencies

   implementation("com.moyasar:android-sdk:0.5.1")
}
﻿
To this:
Add the new SDK's hosting repository In the app's settings.gradle.kts file:
settings.gradle.kts
dependencyResolutionManagement {
   // Other configurations

   repositories {
       // Other repositories

       maven {
           url = uri("https://jitpack.io")
       }
   }
}
dependencyResolutionManagement {
   // Other configurations

   repositories {
       // Other repositories

       maven {
           url = uri("https://jitpack.io")
       }
   }
}
﻿
Add the new dependency In the app's build.gradle.kts file:
build.gradle.kts
dependencies {
   // Other dependencies

  implementation("com.github.Moyasar:moyasar-android-sdk:1.0.0")
}
dependencies {
   // Other dependencies

  implementation("com.github.Moyasar:moyasar-android-sdk:1.0.0")
}
﻿
Initialization
Modify the initialization of the SDK from this:
Kotlin
val paymentSheet = PaymentSheet(activity, { this.handlePaymentResult(it) }, paymentConfig)

paymentSheet.present()
val paymentSheet = PaymentSheet(activity, { this.handlePaymentResult(it) }, paymentConfig)

paymentSheet.present()
﻿
To this:
Kotlin
val paymentFragment = PaymentFragment.newInstance(activity.application, paymentConfig) { this.handlePaymentResult(it) }

activity.supportFragmentManager.beginTransaction().apply {
   // Id for the payment container view
   replace(R.id.paymentSheetFragment, paymentFragment)
   commit()
}
val paymentFragment = PaymentFragment.newInstance(activity.application, paymentConfig) { this.handlePaymentResult(it) }

activity.supportFragmentManager.beginTransaction().apply {
   // Id for the payment container view
   replace(R.id.paymentSheetFragment, paymentFragment)
   commit()
}
﻿
﻿
Demo Example
﻿https://github.com/moyasar/moyasar-android-sdk/tree/main/sdkdriver﻿
﻿
Updated 08 May 2024
Did this page help you?
iOS SDK
Flutter SDK