Revolut Merchant Card Form SDK

This page contains information about the available methods, parameters and data types of the Revolut Merchant Card Form SDK for Android.

SDK components​

RevolutPaymentsSDK object​

This is the main entry point for configuring the SDK.

RevolutPaymentsSDK.configure method​

The configure method is used to initialise the SDK with your merchant public key and the desired environment. It must be called once before performing any payment operations, typically in your application's onCreate method.

fun configure(
  configuration: Configuration
)

RevolutPaymentsSDK.Configuration class​

This data class holds the configuration settings for the SDK.

class Configuration(
    environment: Environment,
    merchantPublicKey: String
)

CardPaymentLauncher class​

This class handles the presentation of the payment UI and delivers the final result. You must register it as a member variable in your Activity or Fragment.

class CardPaymentLauncher(
    caller: ActivityResultCaller,
    onResult: (CardPaymentResult) -> Unit
)

CardPaymentLauncher.launch method​

This method starts the payment process, displaying the card form to the user.

fun launch(
    params: CardPaymentParams
)

Data classes​

CardPaymentParams class​

This data class is used to pass all required and optional information to the launch method.

class CardPaymentParams(
    orderId: String,
    email: String?,
    billingAddress: AddressParams?,
    shippingAddress: AddressParams?,
    savePaymentMethodFor: UserType?
)

AddressParams class​

The AddressParams class represents an address used for billing or shipping purposes. Providing accurate address information can help reduce the likelihood of transaction declines and improve overall payment success rates.

class AddressParams(
    streetLine1: String?,
    streetLine2: String?,
    city: String?,
    region: String?,
    country: String?,
    postcode: String?
)

Environment enum​

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

enum class Environment {
    PRODUCTION,
    SANDBOX
}

UserType enum​

The UserType enum specifies for whom a payment method should be saved, distinguishing if the payment method can be used for customer-initiated or merchant-initiated transactions.

enum class UserType {
    CUSTOMER,
    MERCHANT
}

Results​

The CardPaymentResult is a sealed class that represents the outcome of a payment operation. It is delivered to the onResult callback of the CardPaymentLauncher.

Authorised object​

Indicates that the payment was successfully authorised.

object Authorised : CardPaymentResult()

Declined object​

Indicates that the payment was declined by the card issuer or payment network.

object Declined : CardPaymentResult()

Failed object​

Indicates that a technical failure occurred during the payment process (e.g., network issues).

object Failed : CardPaymentResult()

Error class​

Indicates that an error occurred due to invalid input or configuration.

class Error(
    errorCode: String,
    errorMessage: String
) : CardPaymentResult()

UserAbandonedPayment object​

Indicates that the user abandoned the payment (e.g., using a system back button, a back gesture, or a close button).

object UserAbandonedPayment : CardPaymentResult()