Revolut Pay Android SDK

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

Methods and parameters​

The Revolut Pay Android SDK offers several methods for managing payment flows, handling user interactions, and adding UI components:

init method​

The init method is used to initialise the SDK with the necessary environment and authorisation settings. It sets up the SDK to interact with Revolut's payment services, ensuring that the app is configured correctly for processing transactions. You must call this before creating buttons or promotional widgets.

fun init(
    environment: RevolutPayEnvironment,
    returnUri: String,
    merchantPublicKey: String,
    requestShipping: Boolean?,
    customer: Customer?
)

pay method​

This method allows you to initiate the Revolut Pay flow programmatically without requiring the user to tap a RevolutPayButton. This is useful for custom UI implementations where you want to trigger the payment from another element, like a generic checkout button.

fun pay(
    context: Context, 
    orderToken: String, 
    savePaymentMethodForMerchant: Boolean = false, 
    lifecycle: Lifecycle, 
    callback: OrderResultCallback
)

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

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
)

providePromotionalBannerWidget method​

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

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

PromoBannerParams class​

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

createController method​

Generates a Controller to handle the payment flow, which you attach to a Revolut Pay button instance. This method is where you define the logic for handling the button tap and the final payment result.

fun RevolutPayButton.createController(): Controller

// Controller methods
fun Controller.setHandler(onClick: (ConfirmationFlow) -> Unit)
fun Controller.setOrderResultCallback(orderResultCallback: OrderResultCallback)

The typical flow is to create the controller, then use setHandler and setOrderResultCallback to manage the payment.

setOrderToken method​

Provides the unique order token to the ConfirmationFlow. You fetch this token from your server after the user taps the Revolut Pay button.

fun ConfirmationFlow.setOrderToken(
    orderToken: String 
)

setSavePaymentMethodForMerchant method​

Sets a flag indicating the customer's intent to save their payment method for future merchant-initiated transactions. Call this after setOrderToken.

fun ConfirmationFlow.setSavePaymentMethodForMerchant(
    savePaymentMethodForMerchant: Boolean
)

continueConfirmationFlow method​

Once the orderToken is set, call continueConfirmationFlow() to begin the actual payment confirmation. The user may switch to the Revolut app (if installed) or see an in-app web view.

fun ConfirmationFlow.continueConfirmationFlow()

OrderResultCallback interface​

The OrderResultCallback interface is used to handle the outcomes of the payment process. Implement this interface to receive payment events in your UI.

interface OrderResultCallback {
    fun onOrderCompleted()
    fun onOrderFailed(throwable: Throwable)
    fun onUserPaymentAbandoned()
}

Data structures​

Customer class​

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

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

DateOfBirth class​

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

Country class​

class Country(
    value: String
)

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"
/>