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

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).

A withdrawal exchange allows a user to send a Stellar asset to an anchor and receive a different off-chain asset in return. For example, sending USDC on Stellar and receiving EUR in a bank account. This requires coordination with SEP-38 for obtaining quotes.

Constructors

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

Properties

account

val account: String?

Stellar account that will send the withdrawal.

amount

val amount: String

Amount of the source asset the user will send to the anchor. Should equal quote.sell_amount if a quote_id is provided.

countryCode

val countryCode: String?

ISO 3166-1 alpha-3 code of the user's current address.

customerId

val customerId: String?

SEP-12 customer ID if already known to the anchor.

dest

val dest: String?

Destination account for the withdrawal.

destExtra

val destExtra: String?

Additional destination information.

destinationAsset

val destinationAsset: String

Off-chain asset the user will receive, in SEP-38 Asset Identification Format (e.g., "iso4217:EUR"). Must match a value from SEP-38 /prices.

extraFields

val extraFields: Map<String, String>?

Additional fields required by the anchor.

fundingMethod

val fundingMethod: String?

Method of delivering the withdrawal (replaces deprecated type).

jwt

val jwt: String

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

lang

val lang: String?

Language code (RFC 4646) for error messages.

locationId

val locationId: String?

ID of the chosen location for cash pickup.

memo

val memo: String?

Memo value for the Stellar transaction.

memoType

val ~~memoType~~: String?

Deprecated: Type of memo.

onChangeCallback

val onChangeCallback: String?

URL for transaction status update callbacks.

quoteId

val quoteId: String?

SEP-38 quote ID for firm pricing. When provided, the anchor must honor the quoted conversion rate if the Stellar transaction is created before the quote expires.

refundMemo

val refundMemo: String?

Memo for refund payments.

refundMemoType

val refundMemoType: String?

Type of the refund memo.

sourceAsset

val sourceAsset: String

Code of the on-chain asset the user wants to withdraw. Must match a code in the /info response's withdraw-exchange object.

type

val ~~type~~: String

Type of withdrawal method. Deprecated but still required for compatibility.