Aman SDK will allow your Android application to:

• initiates full-screen activities to get the shipping address, method of shipping, and payment information.
• Card, reference code, and installment payment options are easily obtained from Aman.

Make sure you are satisfied with the following compatibility list in order to prevent any conflicts and ensure a smooth integration.

How Android SDK Plugin Looks Like

Download and test Aman demonstrative application.

---

How it works

We will guide you through the Android SDK integration process on this page:

1. Set up and initialize the SDK for Android.
2. Provide payment options and obtain the payment information from your client.
3. Aman will receive a payment request from the Aman Android SDK plugin.
4. Give our Android SDK plugin the payment processing information back.
5. Share the payment outcome with your client through your Android application.

There are two ways to integrate the Aman Android SDK: manually and automatically. The two integration techniques are covered in this section.

Option 1: Manual Integration

1. Download Aman Android SDK.
2. Copy the downloaded aar file to your project' libs folder.

3. Insert the below repositories block inside the android block to Configure your module Gradle build file.

allprojects{
    repositories {
        mavenCentral()
        flatDir {
            dirs 'libs'
        }
    }
}

4. Provide a dependency configuration, such as implementation in the dependencies block of your build.gradle file, for the following dependencies (that are not already supported in your dependencies block) and configure them for your project.

implementation(name: 'cashier-sdk-1.0.4', ext: 'aar')

5. You have to add the aar file like bellow If your gradle version is higher than 7.0 :

implementation(name: 'cashier-sdk-1.1.2', ext: 'aar')

rather than using the step 4 implementation method:

implementation(name: 'cashier-sdk-1.0.4', ext: 'aar')

Further details are available in the Google official document psd-add-aar-jar-dependency.

Option 2: Auto Integration

1. Configure the below dependency to your build.gradle file.

implementation 'team.aman.sdk:cashier-sdk:1.0.4'

2. Insert the below repositories block inside the android block to Configure your module Gradle build file.

maven {
  url 'http://arifactory.amanride.com/nexus/content/repositories/public/'
  credentials {
       username = 'merchant'
       password = 'merchant'
  }
}

After integrating Aman SDK, now it's time to know how to use our SDK API hooks to:

1. Toggle between Sandbox (testing) and Production environment.
2. Create payment order.
3. Handling payment result.
4. Order status query.

You can use our SDK in testing mode while developing and integrating by configuring the sandBox to true:

PaymentTask.sandBox = true

After testing is complete and your application is prepared for production, you can toggle the sandBox variable to false:

PaymentTask.sandBox = false

The values that should be passed through your PayInput object are shown in the table below, which shows how your app cart item should implement the PayInput object.

Create PayInput object is given below.

PayInput payInput=new PayInput("AmanPUB123456",//public key
    "256612345678901",//merchantID
    "TEST 123",//merchant name
    "a2b050zzzz",//reference, reference unique
    "EG", //uppercase//country
    10000,//amount
    "EGP", //uppercase //currency
    "test",//ProductName
    "testtest",//ProductDescription
    "http://www.baidu.com",//callback Url
    "BankCard",//Payment Type
    30,//expire at
    "110.246.160.183",// user ip
    new UserInfo("UserId","UserName","UserPhone","Email")
);

val payInput = PayInput(
    publickey = "{PublicKey}",
    merchantId = "256612345678901",
    merchantName = "TEST 123",
    reference = "12347544444555666",
    countryCode = "EG", // uppercase
    currency = "EGP", // uppercase
    payAmount = 10000,
    productName = "",
    productDescription = "",
    callbackUrl = "http://www.callbackurl.com",
    userClientIP = "110.246.160.183",
    expireAt = 30,
    paymentType = "", // optional
    userInfo = UserInfo(
        //optional
        userId = "userid001",
        //optional
        userName = "David",
        //optional
        userMobile = "201066668888",
        //optional
        userEmail = "test@email.com",
    )
)

Once the necessary PayInput data has been initiated, you must call PaymentTask(this).createOrder To begin creating an order. Here is an example of code:

new PaymentTask(this).createOrder(
    payInput,((status, orderInfoHttpResponse) -> {
        switch (status) {
            case LOADING:
                break;
            case CANCEL:
                break;
            case SUCCESS:
                break;
        }
        return Unit.INSTANCE;
    })
);

PaymentTask(this).createOrder(payInput, callback = { status, response ->
    when (status) {
        Status.ERROR -> { // error
            Toast.makeText(this, response.message,
            Toast.LENGTH_SHORT).show()
        } else -> {

        }
    }
})

The user will be redirected to complete the payment once CreateOrder is called. In the event of an error, you must override the callback listener. Only the CreateOrder error will be returned by the callback. An error toast message will appear if you forget to add a callback.

Sample CreateOrder error response

{
    "code": "00001",
    "message": “order already exist”,
    "data": null
}

The order status may not be updated in a timely manner due to network and other problems. Calling order status inquiry is highly recommended if you want to make sure your data is accurate. In order to do that, you must create an object called CashierStatusInput with the following request parameters:

CashierStatusInput statusInput = new CashierStatusInput(
    "{PublicKey}",
    "256621050820270",
    "12347544444555666",
    "",
    "EG"
);

val input = CashierStatusInput(
    privateKey = "{PublicKey}",
    merchantId = "256612345678901",
    reference = "12347544444555666",
    countryCode = "EG"
)

After generating the CashierStatusInput object.Use the PaymentTask( activity ).getCashierStatus() method to find out the status of an order, then proceed with the logic based on the returned response object.

new PaymentTask(this).getCashierStatus(statusInput, (status, response) -> {
    if(status == Status.SUCCESS){
        //data
        OrderInfo orderInfo = (OrderInfo)response.getData();
    }else if(status == Status.ERROR){
        Toast.makeText(this, response.getMessage(), Toast.LENGTH_SHORT).show();
    }else{

    }
    return null;
});

PaymentTask(this).getCashierStatus((input, callback = { status, response ->
    when (status) {
        Status.SUCCESS -> {
            val data = response.data as OrderInfo
            // data
       }
        Status.ERROR -> {
            Toast.makeText(this, response.message, Toast.LENGTH_SHORT).show()
        }else -> {

        }
    }
})

Response data format is as follows:

{
  "code": "00000",
  "message": "SUCCESSFUL",
  "data":{
        "reference":"1001000",
        "orderNo":"10212100000034000",
        "status":"SUCCESS",
        "vat":{
          "total":10000,
          "currency":"EGP",
          "rate":100,
          "currencySymbo":"ج.م"
        },
  "failureReason":null,
  "silence":"Y"
}