stellar-sdk/com.soneso.stellar.sdk.sep.sep06/Sep06Transaction

Sep06Transaction

@Serializable

data class Sep06Transaction(val id: String, val kind: String, val status: String, val statusEta: Long? = null, val moreInfoUrl: String? = null, val amountIn: String? = null, val amountInAsset: String? = null, val amountOut: String? = null, val amountOutAsset: String? = null, val amountFee: String? = null, val amountFeeAsset: String? = null, val feeDetails: Sep06FeeDetails? = null, val quoteId: String? = null, val from: String? = null, val to: String? = null, val externalExtra: String? = null, val externalExtraText: String? = null, val depositMemo: String? = null, val depositMemoType: String? = null, val withdrawAnchorAccount: String? = null, val withdrawMemo: String? = null, val withdrawMemoType: String? = null, val startedAt: String? = null, val updatedAt: String? = null, val completedAt: String? = null, val userActionRequiredBy: String? = null, val stellarTransactionId: String? = null, val externalTransactionId: String? = null, val message: String? = null, val refunded: Boolean? = null, val refunds: Sep06Refunds? = null, val requiredInfoMessage: String? = null, val requiredInfoUpdates: Map<String, Sep06Field>? = null, val instructions: Map<String, Sep06DepositInstruction>? = null, val claimableBalanceId: String? = null)

Represents a SEP-6 deposit or withdrawal transaction.

Contains information about the state and details of a transaction, including amounts, fees, status, and platform-specific fields for deposits and withdrawals.

Constructors

Sep06Transaction

constructor(id: String, kind: String, status: String, statusEta: Long? = null, moreInfoUrl: String? = null, amountIn: String? = null, amountInAsset: String? = null, amountOut: String? = null, amountOutAsset: String? = null, amountFee: String? = null, amountFeeAsset: String? = null, feeDetails: Sep06FeeDetails? = null, quoteId: String? = null, from: String? = null, to: String? = null, externalExtra: String? = null, externalExtraText: String? = null, depositMemo: String? = null, depositMemoType: String? = null, withdrawAnchorAccount: String? = null, withdrawMemo: String? = null, withdrawMemoType: String? = null, startedAt: String? = null, updatedAt: String? = null, completedAt: String? = null, userActionRequiredBy: String? = null, stellarTransactionId: String? = null, externalTransactionId: String? = null, message: String? = null, refunded: Boolean? = null, refunds: Sep06Refunds? = null, requiredInfoMessage: String? = null, requiredInfoUpdates: Map<String, Sep06Field>? = null, instructions: Map<String, Sep06DepositInstruction>? = null, claimableBalanceId: String? = null)

Properties

amountFee

@SerialName(value = "amount_fee")

val ~~amountFee~~: String?

Deprecated: Use feeDetails instead

amountFeeAsset

@SerialName(value = "amount_fee_asset")

val ~~amountFeeAsset~~: String?

Deprecated: Use feeDetails instead

amountIn

@SerialName(value = "amount_in")

val amountIn: String?

Amount received by the anchor

amountInAsset

@SerialName(value = "amount_in_asset")

val amountInAsset: String?

Asset of amountIn using Asset Identification Format

amountOut

@SerialName(value = "amount_out")

val amountOut: String?

Amount sent by the anchor to the user

amountOutAsset

@SerialName(value = "amount_out_asset")

val amountOutAsset: String?

Asset of amountOut using Asset Identification Format

claimableBalanceId

@SerialName(value = "claimable_balance_id")

val claimableBalanceId: String?

Claimable balance ID if deposit was sent as claimable balance

completedAt

@SerialName(value = "completed_at")

val completedAt: String?

ISO 8601 UTC timestamp when transaction completed

depositMemo

@SerialName(value = "deposit_memo")

val depositMemo: String?

Memo for the deposit Stellar payment

depositMemoType

@SerialName(value = "deposit_memo_type")

val depositMemoType: String?

Type of memo: text, id, or hash

externalExtra

@SerialName(value = "external_extra")

val externalExtra: String?

Extra information for the external account (routing number, BIC)

externalExtraText

@SerialName(value = "external_extra_text")

val externalExtraText: String?

Human-readable external info (bank name)

externalTransactionId

@SerialName(value = "external_transaction_id")

val externalTransactionId: String?

External payment system transaction ID

feeDetails

@SerialName(value = "fee_details")

val feeDetails: Sep06FeeDetails?

Detailed fee breakdown

from

@SerialName(value = "from")

val from: String?

Sending address (Stellar for withdrawals, external for deposits)

@SerialName(value = "id")

val id: String

Unique identifier for this transaction

instructions

@SerialName(value = "instructions")

val instructions: Map<String, Sep06DepositInstruction>?

Deposit instructions (SEP-9 financial account fields)

kind

@SerialName(value = "kind")

val kind: String

Type of transaction: deposit, deposit-exchange, withdrawal, or withdrawal-exchange

message

@SerialName(value = "message")

val message: String?

Human-readable message about the transaction

moreInfoUrl

@SerialName(value = "more_info_url")

val moreInfoUrl: String?

URL for additional transaction information

quoteId

@SerialName(value = "quote_id")

val quoteId: String?

SEP-38 quote ID if applicable

refunded

@SerialName(value = "refunded")

val ~~refunded~~: Boolean?

Deprecated: Use refunds object instead

refunds

@SerialName(value = "refunds")

val refunds: Sep06Refunds?

Refund information if applicable

requiredInfoMessage

@SerialName(value = "required_info_message")

val requiredInfoMessage: String?

Message about required information

requiredInfoUpdates

@SerialName(value = "required_info_updates")

val requiredInfoUpdates: Map<String, Sep06Field>?

Fields needed for information update

startedAt

@SerialName(value = "started_at")

val startedAt: String?

ISO 8601 UTC timestamp when transaction started

status

@SerialName(value = "status")

val status: String

Current status of the transaction

statusEta

@SerialName(value = "status_eta")

val statusEta: Long?

Estimated time in seconds until status changes

stellarTransactionId

@SerialName(value = "stellar_transaction_id")

val stellarTransactionId: String?

Stellar transaction hash

@SerialName(value = "to")

val to: String?

Receiving address (Stellar for deposits, external for withdrawals)

updatedAt

@SerialName(value = "updated_at")

val updatedAt: String?

ISO 8601 UTC timestamp when transaction was last updated

userActionRequiredBy

@SerialName(value = "user_action_required_by")

val userActionRequiredBy: String?

ISO 8601 UTC timestamp by which user action is required

withdrawAnchorAccount

@SerialName(value = "withdraw_anchor_account")

val withdrawAnchorAccount: String?

Anchor's Stellar account to send withdrawal payment to

withdrawMemo

@SerialName(value = "withdraw_memo")

val withdrawMemo: String?

Memo for the withdrawal Stellar payment

withdrawMemoType

@SerialName(value = "withdraw_memo_type")

val withdrawMemoType: String?

Type of memo for withdrawal: text, id, or hash

Functions

getKindEnum

fun getKindEnum(): Sep06TransactionKind?

Get the kind as a Sep06TransactionKind enum value.

getStatusEnum

fun getStatusEnum(): Sep06TransactionStatus?

Get the status as a Sep06TransactionStatus enum value.

isTerminal

fun isTerminal(): Boolean

Check if the transaction is in a terminal state.