Whitelabel Pay SDK/com.paymenttools.paymenttoolssdk.error/WhitelabelPayError

WhitelabelPayError

sealed class WhitelabelPayError : RuntimeException

The main error class detailing error cases when using the public facing APIs.

Inheritors

InitFailed

DeviceRegistrationError

GetPaymentMeansError

InvalidTokenFormat

TokenSignatureFailure

KeyGenerationFailure

GetPaymentTokensError

NetworkConnectivityFail

FailureToSignOff

FailureToGetPaymentsOverview

FailureToDeactivatePaymentMeans

FailureToReactivatePaymentMeans

PaymentMeanDeletionError

RequestDataSignatureFailure

WrongNotificationType

InvalidNotificationBody

Types

DeviceRegistrationError

data class DeviceRegistrationError(val errorCause: String?) : WhitelabelPayError

This error case can occur in WhitelabelPay.sync function call.

FailureToDeactivatePaymentMeans

data class FailureToDeactivatePaymentMeans(val errorCause: String?) : WhitelabelPayError

Thrown when trying to deactivate the payment means. Make sure to check the associated value error for more details.

FailureToGetPaymentsOverview

data class FailureToGetPaymentsOverview(val errorCause: String?) : WhitelabelPayError

Thrown if an error occurs when trying to fetch the payments overview with WhitelabelPay.getPayments

FailureToReactivatePaymentMeans

data class FailureToReactivatePaymentMeans(val errorCause: String?) : WhitelabelPayError

Thrown when trying to reactive the payment means. Make sure to check the associated value error for more details.

FailureToSignOff

data class FailureToSignOff(val errorCause: String?) : WhitelabelPayError

Thrown if an error occurs when trying to sign off with WhitelabelPay.signOff

GetPaymentMeansError

data class GetPaymentMeansError(val errorCause: String) : WhitelabelPayError

This error case can occur in WhitelabelPay.getPaymentMeansList function call.

GetPaymentTokensError

data class GetPaymentTokensError(val errorCause: String) : WhitelabelPayError

This error case can occur in WhitelabelPayImplementation initialisation process.

InitFailed

data class InitFailed(val errorCause: String) : WhitelabelPayError

This error case can occur in WhitelabelPayImplementation initialisation process.

InvalidNotificationBody

data class InvalidNotificationBody(val notificationBody: String?) : WhitelabelPayError

Thrown when an empty or null notification body is passed to WhitelabelPay.handleNotification.

InvalidTokenFormat

data class InvalidTokenFormat(val errorCause: String) : WhitelabelPayError

This error case can occur in WhitelabelPayImplementation initialisation process.

KeyGenerationFailure

data class KeyGenerationFailure(val key: String, val errorCause: String?) : WhitelabelPayError

This error case can occur in WhitelabelPayImplementation initialisation process.

NetworkConnectivityFail

data object NetworkConnectivityFail : WhitelabelPayError

This error case can occur in WhitelabelPay.getPaymentToken function call.

PaymentMeanDeletionError

data class PaymentMeanDeletionError(val errorCause: String?) : WhitelabelPayError

Thrown when trying to delete a payment means. Make sure to check the associated value error for more details.

RequestDataSignatureFailure

data object RequestDataSignatureFailure : WhitelabelPayError

Thrown when failing to sign the requests

TokenSignatureFailure

data object TokenSignatureFailure : WhitelabelPayError

This error case can occur in WhitelabelPay.getPaymentToken function call.

WrongNotificationType

data class WrongNotificationType(val notificationType: String?) : WhitelabelPayError

Thrown when the wrong notification type string is passed to WhitelabelPay.handleNotification.

Properties

cause

open val cause: Throwable?

message

open val message: String?

Functions

addSuppressed

fun addSuppressed(p0: Throwable)

fillInStackTrace

open fun fillInStackTrace(): Throwable

getLocalizedMessage

open fun getLocalizedMessage(): String

getStackTrace

open fun getStackTrace(): Array<StackTraceElement>

getSuppressed

fun getSuppressed(): Array<Throwable>

initCause

open fun initCause(p0: Throwable): Throwable

message

abstract fun message(): String

Function that provides the error message text.

printStackTrace

open fun printStackTrace()

open fun printStackTrace(p0: PrintStream)

open fun printStackTrace(p0: PrintWriter)

setStackTrace

open fun setStackTrace(p0: Array<StackTraceElement>)