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

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.

The anchor will return an interactive URL where the user can complete the deposit process through a web interface. After the user completes the flow, the anchor will send the deposited funds to the specified Stellar account.

Constructors

Sep24DepositRequest

constructor(assetCode: String, jwt: String, assetIssuer: String? = null, sourceAsset: 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, claimableBalanceSupported: Boolean? = 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 receive the deposited funds. If omitted, the account from the SEP-10 JWT is used.

amount

val amount: String?

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

assetCode

val assetCode: String

Code of the Stellar asset to deposit (e.g., "USDC", "native" for XLM). This is the asset the user will receive on Stellar.

assetIssuer

val assetIssuer: String?

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

claimableBalanceSupported

val claimableBalanceSupported: Boolean?

Set to true if the client supports receiving funds via claimable balances. Allows deposits to accounts without a trustline.

customerId

val customerId: String?

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

jwt

val jwt: String

SEP-10 JWT token for authentication. Required for all deposit 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?

Memo to attach to the Stellar payment transaction. Used to identify the deposit recipient when the account is shared.

memoType

val memoType: String?

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

quoteId

val quoteId: String?

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

sourceAsset

val sourceAsset: String?

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

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. The anchor may redirect the user here after completing the deposit flow.