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

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.

The anchor will return an interactive URL where the user can complete the withdrawal process through a web interface. After the user sends funds to the anchor's Stellar account, the anchor will deliver the withdrawn assets through the specified off-chain channel.

Constructors

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

Properties

account

val account: String?

Stellar account (G...), muxed account (M...), or contract (C...) that will send the withdrawal. If omitted, the account from the SEP-10 JWT is used.

amount

val amount: String?

Amount the user intends to withdraw. The anchor may adjust this during the interactive flow.

assetCode

val assetCode: String

Code of the Stellar asset to withdraw (e.g., "USDC", "native" for XLM). This is the asset the user will send from their Stellar account.

assetIssuer

val assetIssuer: String?

Issuer of the asset. Omit for native XLM. Required when multiple assets share the same code.

customerId

val customerId: String?

SEP-12 customer ID if KYC has already been completed. Allows the anchor to skip redundant KYC collection.

destinationAsset

val destinationAsset: String?

Off-chain asset the user will receive, in SEP-38 format (e.g., "iso4217:USD"). Used when the withdrawal involves a currency conversion.

jwt

val jwt: String

SEP-10 JWT token for authentication. Required for all withdrawal requests.

kycFields

val kycFields: Map<String, String>?

SEP-9 KYC field values as key-value pairs (field name to value). Allows pre-populating KYC information in the interactive flow.

kycFiles

val kycFiles: Map<String, ByteArray>?

SEP-9 KYC file uploads as key-value pairs (field name to file bytes). Used for documents like ID photos or proof of address.

lang

val lang: String?

Language code (RFC 4646, e.g., "en", "en-US", "es") for the interactive UI and any returned messages.

memo

val ~~memo~~: String?

Deprecated: Use the sub value in the SEP-10 JWT instead. Previously used to identify the user when the Stellar account is shared.

memoType

val ~~memoType~~: String?

Deprecated: Use the sub value in the SEP-10 JWT instead. Previously specified the memo type.

quoteId

val quoteId: String?

SEP-38 quote ID for firm pricing. When provided, the anchor must honor the quoted price for the withdrawal.

refundMemo

val refundMemo: String?

Memo to use if the anchor needs to refund the withdrawal. Helps route refund payments back to the correct user.

refundMemoType

val refundMemoType: String?

Type of the refund memo: "text", "id", or "hash".

walletName

val walletName: String?

Name of the wallet application, displayed to the user during the interactive flow.

walletUrl

val walletUrl: String?

URL of the wallet application for anchor reference.