ReadyRemitConfiguration

The options available for customizing a branded experience

Definition

public struct ReadyRemitConfiguration {
    public let colorPalette: ColorPalette
    public let defaultCountry: DefaultCountry?
    public let environment: ReadyRemitEnvironment
    public let fixedRemittanceServiceProvider: RemittanceServiceProvider?
    public let fixedTransferMethod: TransferMethod?
    public let homeScreenContent: HomeScreenContent
    public let idleTimeoutInterval: TimeInterval?
    public let localization: Localization
    public let sourceAccounts: [SourceAccount]?

    public init(
        colorPalette: ColorPalette = .default,
        defaultCountry: DefaultCountry? = .none,
        enviornment: ReadyRemitEnvironment = .default,
        fixedRemittanceServiceProvider: RemittanceServiceProvider? = .none,
        fixedTransferMethod: TransferMethod? = .none,
        homeScreenContent: HomeScreenContent = .default,
        idleTimeoutInterval: TimeInterval? = .none,
        localization: Localization = .default,
        virtualSenderAccounts: [SourceAccount]? = .none
    ) {
        self.colorPalette = colorPalette
        self.defaultCountry = defaultCountry
        self.environment = enviornment
        self.fixedRemittanceServiceProvider = fixedRemittanceServiceProvider
        self.fixedTransferMethod = fixedTransferMethod
        self.homeScreenContent = homeScreenContent
        self.idleTimeoutInterval = idleTimeoutInterval
        self.localization = localization
        self.sourceAccounts = virtualSenderAccounts
    }
}

Properties

PropertyTypeDescription
colorPaletteColorPaletteA group of color tokens that collectively define a theme
defaultCountryDefaultCountry?(Optional) The pre-selected destination country for a transfer
environmentReadyRemitEnvironmentA configured space that includes infrastructure, settings, and data to support a specific stage of the development lifecycle
fixedRemittanceServiceProviderRemittanceServiceProvider?A specific remittance service provider to be used for transfers
fixedTransferMethodTransferMethod?A specific transfer method to be used for transfers
homeScreenContentHomeScreenContentThe title and subtitle displayed on the Home Screen
idleTimeoutIntervalTimeInterval?(Optional) The threshold, in seconds, a session may remain inactive prior to closing the SDK. If specified, the minimum allowed value is 61 seconds; values below this will be ignored.
localizationLocalizationThe language and region that determine how localized content is presented
virtualSenderAccounts[SourceAccount]?A list of accounts a sender may choose from to fund a transfer

Sample Usage

private let configuration: ReadyRemitConfiguration = .init(
    colorPalette: .default,
    defaultCountry: .none,
    enviornment: .default,
    fixedRemittanceServiceProvider: .none,
    fixedTransferMethod: .none,
    homeScreenContent: .default,
    idleTimeoutInterval: .none,
    localization: .default,
    virtualSenderAccounts: .none
)