toro/services.cabcard.toro.core.model/ToroConfig

ToroConfig

data class ToroConfig @JvmOverloads constructor(val captureMode: CaptureMode = CaptureMode.AUTOMATIC, val collectGeolocation: Boolean = false, val gratuityConfig: GratuityConfig = GratuityConfig(), val signatureMode: SignatureMode = SignatureMode.DEVICE, val connectionMode: ConnectionMode = ConnectionMode.BLUETOOTH, val allowPartialApprovals: Boolean = false, val strings: ToroStrings = ToroStrings(), val gatewayTimeoutSeconds: Long = 30, val security: SecurityConfig = SecurityConfig(), val merchant: MerchantConfig, val preserveSessionOnTransactionEnd: Boolean = false, val gatewayBaseUrl: String = if (BuildConfig.DEBUG) "https://api.torogateway.dev" else "https://api.torogateway.com", val authorisationEndpoint: String = "/v1/caaa/authorisation-request", val completionAdviceEndpoint: String = "/v1/caaa/completion-advice", val cancellationAdviceEndpoint: String = "/v1/caaa/cancellation-advice", val diagnosticRequestEndpoint: String = "/v1/caaa/diagnostic-request", val statusReportEndpoint: String = "/v1/catm/status-report", val miuraLogLevel: MiuraLogLevel = if (BuildConfig.DEBUG) MiuraLogLevel.DEBUG else MiuraLogLevel.WARN, val checkForUpdatesOnTransactionStart: Boolean = false, val readinessProbe: ReadinessProbeConfig = ReadinessProbeConfig())

Constructors

ToroConfig

@JvmOverloads

constructor(captureMode: CaptureMode = CaptureMode.AUTOMATIC, collectGeolocation: Boolean = false, gratuityConfig: GratuityConfig = GratuityConfig(), signatureMode: SignatureMode = SignatureMode.DEVICE, connectionMode: ConnectionMode = ConnectionMode.BLUETOOTH, allowPartialApprovals: Boolean = false, strings: ToroStrings = ToroStrings(), gatewayTimeoutSeconds: Long = 30, security: SecurityConfig = SecurityConfig(), merchant: MerchantConfig, preserveSessionOnTransactionEnd: Boolean = false, gatewayBaseUrl: String = if (BuildConfig.DEBUG) "https://api.torogateway.dev" else "https://api.torogateway.com", authorisationEndpoint: String = "/v1/caaa/authorisation-request", completionAdviceEndpoint: String = "/v1/caaa/completion-advice", cancellationAdviceEndpoint: String = "/v1/caaa/cancellation-advice", diagnosticRequestEndpoint: String = "/v1/caaa/diagnostic-request", statusReportEndpoint: String = "/v1/catm/status-report", miuraLogLevel: MiuraLogLevel = if (BuildConfig.DEBUG) MiuraLogLevel.DEBUG else MiuraLogLevel.WARN, checkForUpdatesOnTransactionStart: Boolean = false, readinessProbe: ReadinessProbeConfig = ReadinessProbeConfig())

Properties

allowPartialApprovals

val allowPartialApprovals: Boolean = false

Whether to allow partial approvals for transactions. Default is false.

authorisationEndpoint

val authorisationEndpoint: String

cancellationAdviceEndpoint

val cancellationAdviceEndpoint: String

captureMode

val captureMode: CaptureMode

The mode in which to capture payments.

checkForUpdatesOnTransactionStart

val checkForUpdatesOnTransactionStart: Boolean = false

Whether to automatically check for and apply pending TMS configuration updates before each transaction. Only CONFIGURATION_UPDATE updates are handled here; remote key injection and ECC CSR signing are prerequisites that must be resolved during initial device setup via services.cabcard.toro.ToroClient.ensureDeviceReady. Default is false.

collectGeolocation

val collectGeolocation: Boolean = false

Whether to collect geolocation data for transactions.

completionAdviceEndpoint

val completionAdviceEndpoint: String

connectionMode

val connectionMode: ConnectionMode

The mode in which to connect to the Miura device.

diagnosticRequestEndpoint

val diagnosticRequestEndpoint: String

gatewayBaseUrl

val gatewayBaseUrl: String

gatewayTimeoutSeconds

val gatewayTimeoutSeconds: Long = 30

Maximum time to wait for a response from the Toro gateway.

gratuityConfig

val gratuityConfig: GratuityConfig

Gratuity configuration for transactions. Defaults to GratuityMode.NONE (no tipping prompt). Can be overridden per-transaction via services.cabcard.toro.transaction.model.TransactionMetadata.gratuityConfig.

merchant

val merchant: MerchantConfig

Merchant details

miuraLogLevel

val miuraLogLevel: MiuraLogLevel

preserveSessionOnTransactionEnd

val preserveSessionOnTransactionEnd: Boolean = false

Whether to preserve the session after a transaction ends. When false (default), the session is automatically closed when onComplete, onCancel, or onError is called. When true, the session remains open and must be manually closed using closeSession().

readinessProbe

val readinessProbe: ReadinessProbeConfig

Tuning for the readiness probe run after a session opens. See ReadinessProbeConfig for the defaults and for ReadinessProbeConfig.worstCaseTotalMs when choosing an app-side connect timeout.

security

val security: SecurityConfig

Passphrase, key identifier and policy for the security trailers on gateway messages.

signatureMode

val signatureMode: SignatureMode

The mode in which to capture signatures.

statusReportEndpoint

val statusReportEndpoint: String

strings

val strings: ToroStrings

Use this to override strings used in messages displayed on the device and in the SignatureActivity

Functions

toString

open override fun toString(): String