Revolut Tap to Pay SDK

This page contains information about the available methods and parameters of the Revolut Tap to Pay SDK for iOS.

Methods and parameters​

RevolutTapToPayKit initialiser​

The RevolutTapToPayKit initialiser creates the main entry point to all SDK flows. The SDK must be initialised with your client ID, the environment, a token provider that fetches short-lived device tokens from your backend, and an onLogout handler.

public final class RevolutTapToPayKit {
    public init(
        clientId: String,
        environment: RevolutTapToPayKit.Environment,
        tokenProvider: TokenProviderProtocol,
        onLogout: @escaping @Sendable () -> Void
    )
}

RevolutTapToPayKit.performPayment method​

Receives a single payment for a predetermined amount. The SDK handles the entire payment flow - including device pairing, order creation, payment processing, and presenting the payment UI - and returns the result via callbacks.

func performPayment(
    amount: UInt,
    currency: String,
    description: String?,
    merchantName: String?,
    onDidCharge: @escaping (RevolutTapToPayKit.Receipt?, Result<Void, RevolutTapToPayKit.Error>) -> Void,
    completion: @escaping () -> Void
)

RevolutTapToPayKit.performPayments method​

Receives a series of payments where the merchant enters the amount each time via the SDK's built-in amount entry UI. After the amount is entered, the SDK presents a UI allowing the merchant to choose between Tap to Pay and QR code payment methods.

func performPayments(
    currency: String,
    merchantName: String?,
    onDidCharge: @escaping (RevolutTapToPayKit.Receipt?, Result<Void, RevolutTapToPayKit.Error>) -> Void,
    completion: @escaping () -> Void
)

RevolutTapToPayKit.performFirstTimeSetup method​

Optionally guides the merchant through the initial setup. This method:

1. Runs the steps necessary to set up Apple's ProximityReader framework for operation, including accepting terms and conditions.
2. Optionally presents an introduction screen giving a short description of Tap to Pay on iPhone capabilities.
3. Gives the merchant an opportunity to run a test payment. The test payment behaves exactly like performPayment, with a predefined amount of 1 currency unit (e.g., £0.01).

func performFirstTimeSetup(
    shouldShowIntro: Bool,
    currency: String,
    merchantName: String?,
    completion: @escaping (RevolutTapToPayKit.Receipt?, Result<Void, RevolutTapToPayKit.Error>) -> Void
)

Helper objects and types​

TokenProviderProtocol protocol​

The SDK should not receive a static, long-lived credential. Instead, implement a TokenProviderProtocol that requests fresh short-lived device tokens from your backend. The SDK calls fetchAccessToken() when it needs a token - either on the initial API call or when the current token has expired (received an unauthorised error).

public protocol TokenProviderProtocol: Sendable {
    func fetchAccessToken() async throws -> SdkTokenApiDto
}

SdkTokenApiDto struct​

This struct wraps the short-lived device token returned by your token provider.

public struct SdkTokenApiDto: Decodable {
    public let accessToken: String

    public init(accessToken: String) {
        self.accessToken = accessToken
    }
}

RevolutTapToPayKit.Environment enumeration​

This enum specifies the environment in which the SDK operates. Use the client ID corresponding to the selected environment.

public enum Environment {
    case production
}

RevolutTapToPayKit.Receipt struct​

This struct represents a payment receipt, returned in the onDidCharge closure (for performPayment and performPayments) and in the completion closure (for performFirstTimeSetup). The receipt contains a URL that can be shared with the merchant or customer.

public struct Receipt {
    public let url: URL
}

Errors​

RevolutTapToPayKit.Error enumeration​

Error types returned by the Revolut Tap to Pay SDK. The Error enumeration defines error cases that can occur during the payment or setup process, returned by the .failure case of the onDidCharge and completion closures.

public enum Error: Swift.Error {
    /// Returned when an internal error occurs.
    case internalError
}