Overview

The eSewa Mobile SDK enables native Android to easily accept eSewa payments. The SDK supports only one use case for making payment – Single Payment (i.e., one payment per one user login).

client_id and client_secret values are provided by eSewa to its merchant/client and is unique for each. For development phase, you can use the following credentials: client_id: JB0BBQ4aD0UqIThFJwAKBgAXEUkEGQUBBAwdOgABHD4DChwUAB0R client_secret: BhwIWQQADhIYSxILExMcAgFXFhcOBwAKBgAXEQ==

Note : After login, if the device stays ideal for more than 5 minutes before confirming the payment, the particular session will be time out and customer have to re-initiate the payment process.

Clients can download the sdk (.aar file ) from this drive link. The .aar file must be added to libs folder of your projects app module (Your Project -> app -> libs ). After that add the following code in your apps build.gradle:

android {

dependencies {
   implementation(files("libs/eSewaPaymentSdk-release.aar"))
   implementation("com.squareup.okhttp3:okhttp:4.9.1")
   implementation("com.squareup.okhttp3:logging-interceptor:4.9.1")
}

} 

Note : eSewa SDK uses minSdkVersion 21. Hence, minSdkVersion of your project must be 21 and above. Also compileSdkVersion is recommended to be 34 and above

<uses-permission android:name=”android.permission.INTERNET” />
<uses-permission android:name=”android.permission.ACCESS_NETWORK_STATE” /> 

<application
    	tools:replace="android:theme">
</application> 

Create a ESewaConfiguration object. Start with test environment. When application is ready, you can switch it to live (ENVIRONMENT_PRODUCTION)

val eSewaConfiguration = ESewaConfiguration(
clientId = "<Client ID>",
secretKey = "<Secret Key>",
environment = ESewaConfiguration.ENVIRONMENT_TEST
) 

val eSewaPayment = EsewaPayment(
            "100.0",
            "Sample Product",
            "Product Id xxxxx",
        ) 

private lateinit var registerActivity: ActivityResultLauncher<Intent>

override fun onCreate(savedInstanceState: Bundle?) {
   super.onCreate(savedInstanceState)
   setContentView(R.layout.activity_main)
   registerActivity = registerForActivityResult(
      ActivityResultContracts.StartActivityForResult(),
       ::onResultCallback
   )

btnPay.setOnClickListener {
   if(validateForm()){
       registerActivity.launch(
           Intent(this, EsewaPaymentActivity::class.java).apply {
           putExtra(EsewaConfiguration.ESEWA_CONFIGURATION,eSewaConfiguration)
           putExtra(EsewaPayment.ESEWA_PAYMENT,eSewaPayment)
           }
       )
   }
} 

Where,

In this method, proof of payment in case of successful transaction and reason for failure in case of transaction failure ( In case of ( result == RESULT_CANCEL ) will be returned. No additional information will be sent on intent and in case of successful and unsuccessful payment proof of payment and reason of failure are sent respectively to string value Esewa-Payment.EXTRA_RESULT_MESSAGE).

private fun onResultCallback(result: ActivityResult) {
   Log.d("TAGz", "result ${result.resultCode}")
   result.let {
       when (it.resultCode) {
           RESULT_OK -> {
               it.data?.getStringExtra(EsewaPayment.EXTRA_RESULT_MESSAGE)?.let { s ->
                   Log.i("Proof of Payment", s)
               }
               Toast.makeText(this@MainActivity, "SUCCESSFUL PAYMENT", Toast.LENGTH_SHORT).show()
           }
           RESULT_CANCELED -> {
               Toast.makeText(this@MainActivity, "Canceled By User", Toast.LENGTH_SHORT).show()
           }
           EsewaPayment.RESULT_EXTRAS_INVALID -> {
               it.data?.getStringExtra(EsewaPayment.EXTRA_RESULT_MESSAGE)?.let { s ->
                   Toast.makeText(this@MainActivity, s, Toast.LENGTH_SHORT).show()
               }
           }
           else -> {}
       }
   }
} 

Call Back Url

Callback-url is an API exposed at merchant/client's server at which eSewa sends a copy of proof of payment after successful payment; the client/merchant must send a callback-url while initiating the payment through SDK. The sent callback-url is later used by eSewa server to send a copy of proof of payment after a payment is received. The callback-url is a POST method API and should be in this format

• 1. Invalid Merchant Id or Secret Key SDK gets JSON response from server including errorMessage which contains message "Sorry your request failed. Contact your service provider." shown to customer and technicalErrorMessage which contains message "Invalid Merchant Credential" returned to merchant mobile application as along with result code EsewaPayment.RESULT_EXTRAS_INVALID.

• 2. No Internet Connection. SDK shows dialog box with message "Internet not available" to end user and returns same message to mobile application as result.

• 3. Invalid Test Environment If environment of EsewaConfiguration is set to value other than ENVIRONMENT_TEST or ENVIRONMENT_PRODUCTION, SDK shows message "Sorry your request failed. Contact your service provider." to end user and message "Invalid Test Environment" which is returned to mobile application as result with result code EsewaPayment.RESULT_EXTRAS_INVALID.

• 1. No Internet Connection SDK shows dialog box with message "Internet not available" to end user.

• 2. Invalid user name or password SDK shows message Invalid username or password to customer and clears password field.

• 3. Canceled by customer If end user presses Back Button or Cancel button then user is returned to previous mobile application's activity and result code RESULT_CANCELED is returned to mobile application.

• 1. No Internet Connection SDK shows dialog box with message "Internet not available" to customer. He can turn on Internet and proceed to confirming their payment.

• 2. Insufficient Balance SDK compares the customer's current balance with the total payment amount of the product or service. Payment request is sent if and only if the customer has sufficient balance else the following message will be shown “Your balance is less than required total amount” and will be bound to cancel the payment.

• 3. Canceled by user If customer presses Back Button or Cancel button then he is returned to previous merchant application's activity and result code RESULT_CANCELED is returned to mobile application.

• 4. Session Timeout If the device is kept untouched for 5 minutes then the particular session for payment expires and user has to re-process the payment again. Message "The session is expired. Please try again later" is shown to user and message “Session Time Out” which is returned to mobile application as result with result code EsewaPayment.RESULT_EXTRAS_INVALID.

In case of mobile devices, We suggest to use the TXN verification API with txnRefId to verify ur transaction status and check for “status” key in “transactionDetails” object from the response body. “status” => “COMPLETE” means the transaction verification is successful. For live enviromment, please remove 'rc' from url

https://rc.esewa.com.np/mobile/transaction?txnRefId={refId}

REQUEST TYPE : GET merchantId : *********************************************** merchantSecret : *********************************************** Content-Type : application/json

[
    {
        "productId": "1999",
        "productName": "Android SDK Payment",
        "totalAmount": "25.0",
        "code": "00",
        "message": {
            "technicalSuccessMessage": "Your transaction has been completed.",
            "successMessage": "Your transaction has been completed."
        },
        "transactionDetails": {
            "date": "Mon Dec 26 12:58:14 NPT 2022",
            "referenceId": "0004VZR",
            "status": "COMPLETE"
        },
        "merchantName": "Android SDK Payment"
    }
]