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

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

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

Constructors

constructor(destinationAsset: String, sourceAsset: String, amount: String, account: String, jwt: String, quoteId: String? = null, memoType: String? = null, memo: String? = null, emailAddress: String? = null, type: String? = null, fundingMethod: String? = null, countryCode: String? = null, claimableBalanceSupported: Boolean? = 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 (G...), muxed account (M...), or contract (C...) that will receive the deposited funds.

amount

val amount: String

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

claimableBalanceSupported

val claimableBalanceSupported: Boolean?

Set to true if the client supports receiving funds via claimable balances.

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.

destinationAsset

val destinationAsset: String

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

emailAddress

val emailAddress: String?

Email address of the depositor for status updates.

extraFields

val extraFields: Map<String, String>?

Additional fields required by the anchor.

fundingMethod

val fundingMethod: String?

Method of funding the deposit (replaces deprecated type field).

jwt

val jwt: String

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

lang

val lang: String?

Language code (RFC 4646) for error messages.

locationId

val locationId: String?

ID of the chosen location for cash drop-off.

memo

val memo: String?

Value of memo to attach to the transaction. For hash type, this should be base64-encoded.

memoType

val memoType: String?

Type of memo the anchor should attach to the Stellar payment transaction: "text", "id", or "hash".

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 deposit is completed before the quote expires.

sourceAsset

val sourceAsset: String

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

type

val ~~type~~: String?

Deprecated: Use fundingMethod instead. Type of deposit method.

walletName

val ~~walletName~~: String?

Deprecated: Use client_domain in SEP-10 JWT instead.

walletUrl

val ~~walletUrl~~: String?

Deprecated: Use client_domain in SEP-10 JWT instead.