stellar-sdk/com.soneso.stellar.sdk.sep.sep31/Sep31TransactionStatus

Sep31TransactionStatus

enum Sep31TransactionStatus : Enum<Sep31TransactionStatus>

Enumeration of SEP-31 transaction lifecycle statuses defined by the spec.

Each constant carries the lowercase wire form (value) used by the Receiving Anchor in GET /transactions/:id responses. The SDK keeps Sep31TransactionResponse.status as a raw String so new spec statuses are accepted without an SDK release; use fromString when typed dispatch is preferred.

Usage

val response: Sep31TransactionResponse = sep31Service.getTransaction(id = "tx-id", jwt = jwt)
when (Sep31TransactionStatus.fromString(response.status)) {
    Sep31TransactionStatus.PENDING_SENDER -> println("Awaiting Sending Anchor payment")
    Sep31TransactionStatus.COMPLETED -> println("Delivered to Receiving Client")
    null -> println("Unknown status: ${response.status}")
    else -> println("Status: ${response.status}")
}

Entries

PENDING_SENDER

Awaiting payment from the Sending Anchor.

PENDING_STELLAR

Stellar payment submitted by the Sending Anchor but not yet confirmed on-network.

PENDING_CUSTOMER_INFO_UPDATE

Customer KYC information must be updated via SEP-12 before the transaction can advance.

PENDING_TRANSACTION_INFO_UPDATE

Per-transaction fields require an update (legacy; superseded by SEP-12).

PENDING_RECEIVER

Payment is being processed by the Receiving Anchor.

PENDING_EXTERNAL

Payment was submitted to an external (off-chain) network but is not yet confirmed.

COMPLETED

Funds successfully delivered to the Receiving Client.

REFUNDED

Funds were refunded to the Sending Anchor; inspect Sep31TransactionResponse.refunds for details.

EXPIRED

Transaction abandoned or the underlying SEP-38 quote expired.

ERROR

Catch-all for unspecified errors; inspect Sep31TransactionResponse.statusMessage for context.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<Sep31TransactionStatus>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

value

val value: String

The exact lowercase wire form used in SEP-31 JSON payloads.

Functions

valueOf

fun valueOf(value: String): Sep31TransactionStatus

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<Sep31TransactionStatus>

Returns an array containing the constants of this enum type, in the order they're declared.