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

Package-level declarations

Types

@Serializable

data class Sep06DepositAsset(val enabled: Boolean, val authenticationRequired: Boolean? = null, val minAmount: String? = null, val maxAmount: String? = null, val feeFixed: String? = null, val feePercent: String? = null, val fields: Map<String, Sep06Field>? = null)

Configuration for a deposit asset supported by the anchor.

Sep06DepositExchangeAsset

@Serializable

data class Sep06DepositExchangeAsset(val enabled: Boolean, val authenticationRequired: Boolean? = null, val fields: Map<String, Sep06Field>? = null)

Configuration for a deposit-exchange asset supported by the anchor.

Sep06DepositExchangeRequest

data class Sep06DepositExchangeRequest(val destinationAsset: String, val sourceAsset: String, val amount: String, val account: String, val jwt: String, val quoteId: String? = null, val memoType: String? = null, val memo: String? = null, val emailAddress: String? = null, val type: String? = null, val fundingMethod: String? = null, val countryCode: String? = null, val claimableBalanceSupported: Boolean? = null, val customerId: String? = null, val locationId: String? = null, val walletName: String? = null, val walletUrl: String? = null, val lang: String? = null, val onChangeCallback: String? = null, val extraFields: Map<String, String>? = null)

Request to initiate a programmatic deposit with asset conversion (SEP-38 exchange).

Sep06DepositInstruction

@Serializable

data class Sep06DepositInstruction(val value: String, val description: String)

Instructions for completing an off-chain deposit.

Sep06DepositRequest

data class Sep06DepositRequest(val assetCode: String, val account: String, val jwt: String, val assetIssuer: String? = null, val memoType: String? = null, val memo: String? = null, val emailAddress: String? = null, val type: String? = null, val fundingMethod: String? = null, val amount: String? = null, val countryCode: String? = null, val claimableBalanceSupported: Boolean? = null, val customerId: String? = null, val locationId: String? = null, val walletName: String? = null, val walletUrl: String? = null, val lang: String? = null, val onChangeCallback: String? = null, val extraFields: Map<String, String>? = null)

Request to initiate a programmatic deposit with a Stellar anchor.

Sep06DepositResponse

@Serializable

data class Sep06DepositResponse(val how: String? = null, val id: String? = null, val eta: Long? = null, val minAmount: String? = null, val maxAmount: String? = null, val feeFixed: String? = null, val feePercent: String? = null, val extraInfo: Sep06ExtraInfo? = null, val instructions: Map<String, Sep06DepositInstruction>? = null)

Response from initiating a deposit operation.

Sep06ExtraInfo

@Serializable

data class Sep06ExtraInfo(val message: String? = null)

Additional information from the anchor.

Sep06FeatureFlags

@Serializable

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

Feature flags indicating anchor capabilities.

Sep06FeeDetail

@Serializable

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

Individual fee component in a fee breakdown.

Sep06FeeDetails

@Serializable

data class Sep06FeeDetails(val total: String, val asset: String, val details: List<Sep06FeeDetail>? = null)

Detailed fee breakdown for a transaction.

Sep06FeeEndpointInfo

@Serializable

data class Sep06FeeEndpointInfo(val enabled: Boolean? = null, val authenticationRequired: Boolean? = null, val description: String? = null)

Configuration for the /fee endpoint.

Sep06FeeRequest

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

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

Sep06FeeResponse

@Serializable

data class Sep06FeeResponse(val fee: String)

Response from the /fee endpoint.

Sep06Field

@Serializable

data class Sep06Field(val description: String? = null, val optional: Boolean? = null, val choices: List<String>? = null)

Describes a field that needs to be provided for a transaction.

Sep06InfoResponse

@Serializable

data class Sep06InfoResponse(val deposit: Map<String, Sep06DepositAsset>? = null, val depositExchange: Map<String, Sep06DepositExchangeAsset>? = null, val withdraw: Map<String, Sep06WithdrawAsset>? = null, val withdrawExchange: Map<String, Sep06WithdrawExchangeAsset>? = null, val fee: Sep06FeeEndpointInfo? = null, val transaction: Sep06TransactionEndpointInfo? = null, val transactions: Sep06TransactionsEndpointInfo? = null, val features: Sep06FeatureFlags? = null)

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

Sep06PatchTransactionRequest

data class Sep06PatchTransactionRequest(val id: String, val fields: Map<String, String>, val jwt: String)

Request to update a transaction with additional information requested by the anchor.

Sep06RefundPayment

@Serializable

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

Individual refund payment.

Sep06Refunds

@Serializable

data class Sep06Refunds(val amountRefunded: String, val amountFee: String, val payments: List<Sep06RefundPayment>)

Refund information for a transaction.

Sep06Service

class Sep06Service

SEP-6 Programmatic Deposit and Withdrawal service client.

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.

Sep06TransactionEndpointInfo

@Serializable

data class Sep06TransactionEndpointInfo(val enabled: Boolean? = null, val authenticationRequired: Boolean? = null)

Configuration for the /transaction endpoint.

Sep06TransactionKind

enum Sep06TransactionKind : Enum<Sep06TransactionKind>

Transaction kinds for SEP-6 deposit and withdrawal operations.

Sep06TransactionRequest

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

Request to query a single transaction by its identifier.

Sep06TransactionResponse

@Serializable

data class Sep06TransactionResponse(val transaction: Sep06Transaction)

Response containing a single transaction.

Sep06TransactionsEndpointInfo

@Serializable

data class Sep06TransactionsEndpointInfo(val enabled: Boolean? = null, val authenticationRequired: Boolean? = null)

Configuration for the /transactions endpoint.

Sep06TransactionsRequest

data class Sep06TransactionsRequest(val assetCode: String, val account: 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 an account with a Stellar anchor.

Sep06TransactionsResponse

@Serializable

data class Sep06TransactionsResponse(val transactions: List<Sep06Transaction>)

Response containing a list of transactions.

Sep06TransactionStatus

enum Sep06TransactionStatus : Enum<Sep06TransactionStatus>

Transaction statuses for SEP-6 deposit and withdrawal operations.

Sep06WithdrawAsset

@Serializable

data class Sep06WithdrawAsset(val enabled: Boolean, val authenticationRequired: Boolean? = null, val minAmount: String? = null, val maxAmount: String? = null, val feeFixed: String? = null, val feePercent: String? = null, val types: Map<String, Sep06WithdrawType>? = null)

Configuration for a withdrawal asset supported by the anchor.

Sep06WithdrawExchangeAsset

@Serializable

data class Sep06WithdrawExchangeAsset(val enabled: Boolean, val authenticationRequired: Boolean? = null, val types: Map<String, Sep06WithdrawType>? = null)

Configuration for a withdrawal-exchange asset supported by the anchor.

Sep06WithdrawExchangeRequest

data class Sep06WithdrawExchangeRequest(val sourceAsset: String, val destinationAsset: String, val amount: String, val type: String, val jwt: String, val fundingMethod: String? = null, val quoteId: String? = null, val dest: String? = null, val destExtra: String? = null, val account: String? = null, val memo: String? = null, val memoType: String? = null, val countryCode: String? = null, val refundMemo: String? = null, val refundMemoType: String? = null, val customerId: String? = null, val locationId: String? = null, val walletName: String? = null, val walletUrl: String? = null, val lang: String? = null, val onChangeCallback: String? = null, val extraFields: Map<String, String>? = null)

Request to initiate a programmatic withdrawal with asset conversion (SEP-38 exchange).

Sep06WithdrawRequest

data class Sep06WithdrawRequest(val assetCode: String, val type: String, val jwt: String, val fundingMethod: String? = null, val dest: String? = null, val destExtra: String? = null, val account: String? = null, val memo: String? = null, val memoType: String? = null, val amount: String? = null, val countryCode: String? = null, val refundMemo: String? = null, val refundMemoType: String? = null, val customerId: String? = null, val locationId: String? = null, val walletName: String? = null, val walletUrl: String? = null, val lang: String? = null, val onChangeCallback: String? = null, val extraFields: Map<String, String>? = null)

Request to initiate a programmatic withdrawal from a Stellar anchor.

Sep06WithdrawResponse

@Serializable

data class Sep06WithdrawResponse(val accountId: String? = null, val memoType: String? = null, val memo: String? = null, val id: String? = null, val eta: Long? = null, val minAmount: String? = null, val maxAmount: String? = null, val feeFixed: String? = null, val feePercent: String? = null, val extraInfo: Sep06ExtraInfo? = null)

Response from initiating a withdrawal operation.

Sep06WithdrawType

@Serializable

data class Sep06WithdrawType(val fields: Map<String, Sep06Field>? = null)

Configuration for a withdrawal type (e.g., bank_account, crypto, cash).