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.

Methods and parameters​

The following methods are available on the RevolutPaymentApi class:

RevolutPaymentApi.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.

fun init(
    environment: Environment,
    merchantPublicKey: String
)

RevolutPaymentApi.buildCardPaymentIntent method​

The buildCardPaymentIntent method constructs an Intent that launches the card payment process. It uses the provided context, order ID, and configuration details to initiate a secure payment activity.

fun buildCardPaymentIntent(
    context: Context,
    orderId: String,
    configuration: Configuration.CardPayment,
)

RevolutPaymentApi.mapIntentToResult method​

The mapIntentToResult method is used to interpret the result of a payment activity. It maps the result code and intent data returned by the payment activity into a more usable form for further processing.

fun mapIntentToResult(
    resultCode: Int,
    resultIntent: Intent?
)

Configuration.CardPayment class​

class Configuration.CardPayment(
    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?
)

Results​

The Result class is a sealed class that represents the outcome of a payment operation. It is designed to encapsulate both successful results and various error conditions, allowing developers to handle different scenarios effectively.

ApiError class​

The ApiError class represents errors returned by the API with specific error codes and identifiers. This helps in diagnosing issues related to API requests and responses.

class ApiError(
    verrorCode: Int,
    errorId: String
)

NetworkError class​

The NetworkError class captures issues related to network connectivity and communication, providing an error code and descriptive message.

class NetworkError(
    errorCode: Int,
    message: String
)

GenericError class​

The GenericError class handles general errors that may occur, offering optional details like a message and stack trace for better debugging.

class GenericError(
    message: String?,
    stackTrace: String?
)

OrderNotAvailable object​

The OrderNotAvailable object represents a specific error state where the requested order is not currently available for processing. This error indicates that the order cannot be processed due to its current status or availability issues.

OrderNotFound object​

The OrderNotFound object signifies an error where the specified order could not be located in the system. This error suggests that the provided order token is invalid or the order no longer exists.

TimeoutError object​

The TimeoutError object denotes an error condition where a request or operation has exceeded the allowed time limit. This error occurs when a process takes too long to complete, likely due to network delays or server responsiveness issues.

Authorised object​

The Authorised object indicates a successful authorisation of a payment, confirming that the transaction can proceed.

Failed class​

The Failed class represents a payment failure, providing a reason for the failure through the FailureReason type.

class Failed(
    failureReason: FailureReason
)

Declined class​

The Declined class captures situations where a payment is declined, specifying the reason for the decline with the DeclineReason type.

class Declined(
    declineReason: DeclineReason
)

InputValidationError enum​

The InputValidationError enum defines types of errors related to invalid input data during payment processing.

enum InputValidationError {
    INVALID_CARD_NUMBER,
    INVALID_CVV,
    INVALID_EXPIRY,
    INVALID_EMAIL,
    INVALID_CARDHOLDER_NAME
}