Airwallex Risk Android SDK

The Airwallex Risk SDK is required for Airwallex Scale customer apps.

Table of contents

• Requirements
• Installation
• Usage
  • Quick start
  • Update user
  • Events
  • Request header

Requirements

The Airwallex Risk Android SDK requires Android Studio Flamingo or later with Java 17 and is compatible with apps targeting Android 8 or above.

Installation

Gradle

In your app's build.gradle, add:

implementation "io.github.airwallex:RiskSdk:1.0.9"

Usage

Quick start

The SDK must be started as early as possible in your application lifecycle. We recommend calling the start method in your Application subclass's onCreate:

import android.app.Application
import com.airwallex.risk.AirwallexRisk
import com.airwallex.risk.RiskConfiguration

class SampleApplication : Application() {

    override fun onCreate() {
        super.onCreate()

        val accountId = null // "YOUR-ACCOUNT-ID-GOES-HERE"

        AirwallexRisk.start(
            applicationContext = applicationContext,
            accountId = accountId,
            configuration = RiskConfiguration(isProduction = !BuildConfig.DEBUG)
        )
    }
}

Notes:

• accountId is required in all Airwallex Scale customer apps. This will be your Airwallex account ID.
• the optional RiskConfiguration may also be used if needed. For test/debug builds you can set isProduction = false.

Update user

After the app user signs in to their Airwallex account, the app must send the users ID through to the SDK as follows. This will be persisted in the SDK until the next time this method is called. Set to null on sign out.

⚠️ Important: The user ID here is the signed in user's individual Airwallex account ID, not your own system user ID.

import com.airwallex.risk.AirwallexRisk

AirwallexRisk.setUserId(userID = "USER_ID")

Events

Some app events must be logged to the SDK. These events include:

• User logs in: When a user logs in, send the event "login". Make sure you set the user ID (above) before sending this event.
• Create a payout transaction: When a user submits a payment transaction, send the event "payout".

Use the following snippet to send event name and current screen name.

import com.airwallex.risk.AirwallexRisk

AirwallexRisk.log(
  event = "EVENT_NAME",
  screen = "SCREEN_NAME"
)

Request header

When your app sends a request to Airwallex, you must add the provided header into your request before sending. This will be slightly different depending on your networking library, so check the documentation describing how to add headers for the library you're using.

Some networking libraries you may be using

• Ktor
• OkHttp

import com.airwallex.risk.AirwallexRisk

val header = AirwallexRisk.header

// Add a header using `header.field` and `header.value` to airwallex.com network requests

The header consists of

• the field, which will always be "x-risk-device-id", and
• the value, which will be an internally generated device identifier.