Revolut Pay Android SDK

This page contains information about the methods, parameters, and data types of the Revolut Pay Android SDK.

SDK components​

RevolutPaymentsSDK object​

This is the main entry point for configuring the SDK.

RevolutPaymentsSDK.configure method​

Initialises the SDK with the necessary configuration. This method must be called before any other SDK method, typically in your Application's onCreate() method.

RevolutPaymentsSDK.configure(
    configuration: RevolutPaymentsSDK.Configuration
)

createController method​

Creates a RevolutPaymentController to handle payment flows. This method is where you define the logic for handling payment results.

// For Activity
fun createController(
    activity: ComponentActivity, 
    onResult: (PaymentResult) -> Unit
): RevolutPaymentController

// For Fragment
fun createController(
    fragment: Fragment, 
    onResult: (PaymentResult) -> Unit
): RevolutPaymentController

pay method (Controller)​

Initiates the payment flow using the controller. This method is called on the RevolutPaymentController instance.

fun pay(orderParams: OrderParams)

isRevolutAppInstalled method​

Checks if the Revolut Retail app is installed on the device.

fun isRevolutAppInstalled(context: Context): Boolean

handle method​

Handles deeplink URIs to trigger payment result callbacks when appropriate.

fun handle(uri: Uri)

bindPaymentState method (Button Extension)​

Binds the payment state to a RevolutPayButton, automatically showing a loading indicator while the payment is processing.

// For Activity
fun RevolutPayButton.bindPaymentState(
    controller: RevolutPaymentController,
    activity: ComponentActivity
)

// For Fragment
fun RevolutPayButton.bindPaymentState(
    controller: RevolutPaymentController,
    fragment: Fragment
)

showBlockingLoading method (Button)​

Shows or hides a blocking loading indicator on the RevolutPayButton.

fun RevolutPayButton.showBlockingLoading(loading: Boolean)

provideButton method​

Creates an instance of the Revolut Pay button, which you can programmatically add to your layout.

fun provideButton(
    context: Context,
    params: ButtonParams
): RevolutPayButton

providePromotionalBannerWidget method​

Creates a promotional banner widget to display rewards and sign-up incentives.

fun providePromotionalBannerWidget(
    context: Context,
    params: PromoBannerParams,
    themeId: Int? = 0
): View

Data structures​

RevolutPaymentsSDK.Configuration class​

data class Configuration(
    val merchantPublicKey: String,
    val environment: Environment
)

OrderParams class​

Contains all the parameters needed to initiate a payment.

data class OrderParams(
    val orderToken: String,
    val returnUri: Uri,
    val requestShipping: Boolean,
    val savePaymentMethodForMerchant: Boolean,
    val customer: Customer?
)

ButtonParams class​

A ButtonParams object defining how the button appears and behaves.

class ButtonParams(
    radius: Radius = Radius.NONE,
    buttonSize: Size = Size.LARGE,
    variantModes: VariantModes,
    boxText: BoxText = BoxText.NONE,
    boxTextCurrency: BoxTextCurrency? = BoxTextCurrency.GBP,
)

VariantModes class​

class VariantModes(
    lightMode: Variant = Variant.LIGHT,
    darkMode: Variant = Variant.DARK
)

PromoBannerParams class​

data class PromoBannerParams(
    val transactionId: String,
    val currency: RevolutCurrency,
    val paymentAmount: Long?,
    val customer: Customer?
)

Customer class​

Providing customer data can simplify the checkout process or pre-fill user info.

class Customer(
    val name: String?,
    val email: String?,
    val phone: String?,
    val dateOfBirth: DateOfBirth?,
    val country: CountryCode?
)

DateOfBirth class​

class DateOfBirth(
    day: Int,
    month: Int,
    year: Int
)

CountryCode class​

class CountryCode(
    val value: String
)

Enums​

Environment enum​

The Environment enum defines the possible server environments that the SDK can point to.

enum class Environment {
    PRODUCTION,
    SANDBOX
}

Radius enum​

The Radius enum defines the corner radius of the Revolut Pay button.

enum class Radius {
    NONE,
    SMALL,
    MEDIUM,
    LARGE
}

Size enum​

The Size enum defines the width of the Revolut Pay button.

enum class Size {
    EXTRA_SMALL,
    SMALL,
    MEDIUM,
    LARGE
}

Variant enum​

The Variant enum defines the visual style of the Revolut Pay button, suitable for different themes. It is used within the VariantModes class.

enum class Variant {
    DARK,
    LIGHT,
    DARK_OUTLINED,
    LIGHT_OUTLINED
}

BoxText enum​

The BoxText enum defines the text content of the informational box displayed beneath the Revolut Pay button.

enum class BoxText {
    NONE,
    GET_CASHBACK_VALUE
}

BoxTextCurrency and RevolutCurrency enums​

These enums define the supported ISO 4217 currency codes for use in transactions or for displaying rewards.

enum class BoxTextCurrency {
    AED, AUD, BGN, CAD, CHF, CZK, DKK, EUR, GBP, HKD, HUF, ILS, JPY, MXN, NOK, NZD, PLN, QAR, RON, RUB, SAR, SEK, SGD, THB, TRY, USD, ZAR
}
// RevolutCurrency contains the same set of values.

Results​

PaymentResult interface​

The PaymentResult sealed interface represents the outcomes of the payment process. It is passed to the result callback when using the createController method.

sealed interface PaymentResult {
    data object Success : PaymentResult
    data class Failure(val exception: Throwable) : PaymentResult
    data object UserAbandonedPayment : PaymentResult
}

UI components and layouts​

XML layout configuration for the Revolut Pay button​

Instead of creating the button from Kotlin/Java, you can embed it directly in an XML layout:

<com.revolut.revolutpay.ui.button.RevolutPayButton
  android:id="@+id/revolut_pay_button"
  android:layout_width="wrap_content"
  android:layout_height="wrap_content"
  app:revolutPay_Radius="Medium"
  app:revolutPay_Size="Large"
  app:revolutPay_BoxText="GetCashbackValue"
  app:revolutPay_BoxTextCurrency="GBP"
  app:revolutPay_VariantDarkTheme="Dark"
  app:revolutPay_VariantLightTheme="Light"
/>