Android SDK Integration

Quick guide to integrate onramp SDK to your android app.

This guide will help you understand how to integrate the Onramp SDK into your Android app

General Requirements

Here are the minimum requirements to use the Onramp SDK:

  • minSdkVersion: 21

  • compileSdkVersion: 33

  • The SDK requires the INTERNET permission to function properly: <uses-permission android:name="android.permission.INTERNET"/>

Setup

Dependencies

In your app level build.gradle file, add the following dependencies:

dependencies {
    ...
    implementation 'money.onramp.onrampwebview:OnrampSDK:1.0.3'
}

Initialize the SDK

Start the Onramp SDK by calling the startOnrampSDK function and pass the necessary configuration parameters:

OnrampSDK.startOnrampSDK(
  context: this,    // replace 'this' with the context of the activity where SDK is initialized
  appId: 1,         // replace '1' with the appID you received during onboarding
  walletAddress: '0x495f519017eF0368e82Af52b4B64461542a5430B', // replace with user's wallet address
  flowtype: 1,      // 1 -> onramp || 2 -> offramp || 3 -> Merchant checkout
  fiatType: 1,      // 1 -> INR || 2 -> TRY || 3 -> AED || 4 -> MXN || 5 -> VND || 6 -> NGN etc. visit Fiat Currencies page to view full list of supported fiat currencies
  paymentMethod: 1  // 1 -> Instant transfer(UPI) || 2 -> Bank transfer(IMPS/FAST)
  // ... pass other configs here
)

Note:

  • Supported Currencies: To view the list of all the fiat currencies supported by Onramp, click here.

  • Supported Payment Methods: To view the list of all the supported payment methods for various currencies supported by Onramp, click here.

Next, register an event listener for the SDK:

OnrampSDK.registerOnrampSDKEventListener(this)

Listening to SDK Events

In your Activity class declaration, add the OnrampSDKEventListener interface:

class MainActivity : AppCompatActivity(), OnrampSDKEventListener {
  ...
}

Implement the onDataReceived(event: WidgetResponse) method in your activity class to handle the various SDK events:

override fun onDataReceived(event: WidgetResponse) {
        when(event.type){
          // handle various sdk events based on type of event here

          //Example events usage:

          "ONRAMP_WIDGET_TX_COMPLETED" -> {
              //handle success code here
          }
          "ONRAMP_WIDGET_TX_FAILED" -> {
              //handle failure code here
            }
          "ONRAMP_WIDGET_CLOSE_REQUEST_CONFIRMED" -> {
              //handle failure code here when user cancels the transaction              
            }
        }
    }

SDK Lifecycle

You can disable the OnrampSDK at any time using the following code:

OnrampSDK.stopOnrampSDK()

Widget Transactions Events

TX_EVENTS

ONRAMP_WIDGET_TX_INIT, 
ONRAMP_WIDGET_TX_FINDING, 
ONRAMP_WIDGET_TX_PURCHASING, 
ONRAMP_WIDGET_TX_SENDING, 
ONRAMP_WIDGET_TX_COMPLETED,
ONRAMP_WIDGET_TX_SENDING_FAILED, 
ONRAMP_WIDGET_TX_PURCHASING_FAILED, 
ONRAMP_WIDGET_TX_FINDING_FAILED

WIDGET_EVENTS

ONRAMP_WIDGET_READY, 
ONRAMP_WIDGET_FAILED, 
ONRAMP_WIDGET_CLOSE_REQUEST_CONFIRMED,
ONRAMP_WIDGET_CLOSE_REQUEST_CANCELLED,
ONRAMP_WIDGET_CONTENT_COPIED

Widget Event Data

The events triggered by the SDK come with an associated data field. This provides partners with a streamlined way to track order statuses. Here's a breakdown of a sample response and its interpretation.

ONRAMP_WIDGET_TX_INIT

"data": {
    "coinRate": 90.2,
    "cryptoAmount": 1.02,
    "fiatAmount": 101,
    "paymentMethod": "UPI"
  }

ONRAMP_WIDGET_TX_FINDING

"data": {
    }

ONRAMP_WIDGET_TX_PURCHASING

"data": {
    "kycNeeded": 0
  }

ONRAMP_WIDGET_TX_SENDING

"data": {
    "actualCryptoAmount": 1.11,
    "actualPrice": 90.2,
    "gasFee": 0.09
  }

ONRAMP_WIDGET_TX_COMPLETED

"data": {
    "actualCryptoAmount": 1.11,
    "actualPrice": 90.2,
    "chainId": 3,
    "clientFee": 0,
    "coinId": 54,
    "createdAt": "2023-10-13T07:49:58.000Z",
    "expectedCryptoAmount": 1.03,
    "expectedPrice": 90.2,
    "fiatAmount": 101,
    "fiatType": 1,
    "gasFee": 0.09,
    "gatewayFee": 0,
    "kycNeeded": 0,
    "merchantRecognitionId": null,
    "onRampFee": 0.25,
    "orderId": 302342,
    "orderStatus": 4,
    "referenceId": "327624383007",
    "transactionHash": "0xc1a8aaa9c887ca8f0c3b929caa71b2337c840b353939d3b6b340948ae5d",
    "updatedAt": "2023-10-13T07:56:04.000Z",
    "walletAddress": "0x63dDcda9ABC022Ce0E179A0F6f033Ea3282807b"
  }

Note:

  • Each instance of the SDK maps directly to a single widget instance. Should you wish to close and subsequently reopen Onramp Instant, a fresh SDK initialization is required.

PreviousSandbox quick guideNextiOS SDK Integration

Last updated