stellar-sdk/com.soneso.stellar.sdk.sep.sep24

Package-level declarations

Types

@Serializable

data class Sep24AssetInfo(val enabled: Boolean, val minAmount: String? = null, val maxAmount: String? = null, val feeFixed: String? = null, val feePercent: String? = null, val feeMinimum: String? = null)

Asset configuration for deposit or withdrawal operations.

Sep24DepositRequest

data class Sep24DepositRequest(val assetCode: String, val jwt: String, val assetIssuer: String? = null, val sourceAsset: String? = null, val amount: String? = null, val quoteId: String? = null, val account: String? = null, val memo: String? = null, val memoType: String? = null, val walletName: String? = null, val walletUrl: String? = null, val lang: String? = null, val claimableBalanceSupported: Boolean? = null, val customerId: String? = null, val kycFields: Map<String, String>? = null, val kycFiles: Map<String, ByteArray>? = null)

Request to initiate an interactive deposit flow with a Stellar anchor.

Sep24Features

@Serializable

data class Sep24Features(val accountCreation: Boolean = true, val claimableBalances: Boolean = false)

Feature flags indicating anchor capabilities.

Sep24FeeDetail

@Serializable

data class Sep24FeeDetail(val name: String, val amount: String, val description: String? = null)

Individual fee component in a fee breakdown.

Sep24FeeDetails

@Serializable

data class Sep24FeeDetails(val total: String, val asset: String, val breakdown: List<Sep24FeeDetail>? = null)

Detailed fee breakdown for a transaction.

Sep24FeeEndpointInfo

@Serializable

data class Sep24FeeEndpointInfo(val enabled: Boolean, val authenticationRequired: Boolean = false)

Configuration for the /fee endpoint.

Sep24FeeRequest

data class Sep24FeeRequest(val operation: String, val assetCode: String, val amount: String, val jwt: String? = null, val type: String? = null)

Request to query the fee for a deposit or withdrawal operation.

Sep24FeeResponse

@Serializable

data class Sep24FeeResponse(val fee: String? = null)

Response from the /fee endpoint.

Sep24InfoResponse

@Serializable

data class Sep24InfoResponse(val depositAssets: Map<String, Sep24AssetInfo>? = null, val withdrawAssets: Map<String, Sep24AssetInfo>? = null, val feeEndpoint: Sep24FeeEndpointInfo? = null, val features: Sep24Features? = null)

Response from the /info endpoint containing anchor capabilities and supported assets.

Sep24InteractiveResponse

@Serializable

data class Sep24InteractiveResponse(val type: String, val url: String, val id: String)

Response from initiating an interactive deposit or withdrawal flow.

Sep24RefundPayment

@Serializable

data class Sep24RefundPayment(val id: String, val idType: String, val amount: String, val fee: String)

Individual refund payment.

Sep24Refunds

@Serializable

data class Sep24Refunds(val amountRefunded: String, val amountFee: String, val payments: List<Sep24RefundPayment>)

Refund information for a transaction.

Sep24Service

class Sep24Service(serviceAddress: String, httpClient: HttpClient? = null, httpRequestHeaders: Map<String, String>? = null)

SEP-24 Hosted Deposit and Withdrawal service client.

Sep24Transaction

@Serializable

data class Sep24Transaction(val id: String, val kind: String, val status: String, val statusEta: Int? = null, val kycVerified: Boolean? = 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: Sep24FeeDetails? = null, val quoteId: String? = null, val startedAt: String? = null, val completedAt: String? = null, val updatedAt: String? = null, val userActionRequiredBy: String? = null, val stellarTransactionId: String? = null, val externalTransactionId: String? = null, val message: String? = null, val refunded: Boolean? = null, val refunds: Sep24Refunds? = null, val from: String? = null, val to: String? = null, val depositMemo: String? = null, val depositMemoType: String? = null, val claimableBalanceId: String? = null, val withdrawAnchorAccount: String? = null, val withdrawMemo: String? = null, val withdrawMemoType: String? = null)

Represents a SEP-24 deposit or withdrawal transaction.

Sep24TransactionRequest

data class Sep24TransactionRequest(val jwt: String, val id: String? = null, val stellarTransactionId: String? = null, val externalTransactionId: String? = null, val lang: String? = null)

Request to query a single transaction by its identifier.

Sep24TransactionResponse

@Serializable

data class Sep24TransactionResponse(val transaction: Sep24Transaction)

Response containing a single transaction.

Sep24TransactionsRequest

data class Sep24TransactionsRequest(val assetCode: String, val jwt: String, val noOlderThan: String? = null, val limit: Int? = null, val kind: String? = null, val pagingId: String? = null, val lang: String? = null)

Request to query transaction history for the authenticated account.

Sep24TransactionsResponse

@Serializable

data class Sep24TransactionsResponse(val transactions: List<Sep24Transaction>)

Response containing a list of transactions.

Sep24TransactionStatus

enum Sep24TransactionStatus : Enum<Sep24TransactionStatus>

Transaction statuses for SEP-24 deposit and withdrawal operations.

Sep24WithdrawRequest

data class Sep24WithdrawRequest(val assetCode: String, val jwt: String, val assetIssuer: String? = null, val destinationAsset: String? = null, val amount: String? = null, val quoteId: String? = null, val account: String? = null, val memo: String? = null, val memoType: String? = null, val walletName: String? = null, val walletUrl: String? = null, val lang: String? = null, val refundMemo: String? = null, val refundMemoType: String? = null, val customerId: String? = null, val kycFields: Map<String, String>? = null, val kycFiles: Map<String, ByteArray>? = null)

Request to initiate an interactive withdrawal flow with a Stellar anchor.