commonMain.com.lightspark.sdk.wallet.model.PaymentFailureReason.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wallet-sdk Show documentation

The Lightspark Wallet SDK for Kotlin and Java.

The newest version!

// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
@file:Suppress("ktlint:standard:max-line-length")

package com.lightspark.sdk.wallet.model

import com.lightspark.sdk.core.util.EnumSerializer
import kotlinx.serialization.Serializable

/** This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may have failed. **/
@Serializable(with = PaymentFailureReasonSerializer::class)
enum class PaymentFailureReason(val rawValue: String) {
    NONE("NONE"),

    TIMEOUT("TIMEOUT"),

    NO_ROUTE("NO_ROUTE"),

    ERROR("ERROR"),

    INCORRECT_PAYMENT_DETAILS("INCORRECT_PAYMENT_DETAILS"),

    INSUFFICIENT_BALANCE("INSUFFICIENT_BALANCE"),

    INVOICE_ALREADY_PAID("INVOICE_ALREADY_PAID"),

    SELF_PAYMENT("SELF_PAYMENT"),

    INVOICE_EXPIRED("INVOICE_EXPIRED"),

    RISK_SCREENING_FAILED("RISK_SCREENING_FAILED"),

    /**
     * This is an enum value that represents values that could be added in the future.
     * Clients should support unknown values as more of them could be added without notice.
     */
    FUTURE_VALUE("FUTURE_VALUE"),
}

object PaymentFailureReasonSerializer :
    EnumSerializer(
        PaymentFailureReason::class,
        { rawValue ->
            PaymentFailureReason.values().firstOrNull { it.rawValue == rawValue } ?: PaymentFailureReason.FUTURE_VALUE
        },
    )