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

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.

A deposit occurs when a user sends an external asset (fiat via bank transfer, crypto from another blockchain, etc.) to an anchor, and the anchor sends an equivalent amount of the corresponding Stellar asset to the user's account.

Unlike SEP-24's interactive flow, SEP-6 deposits are fully programmatic - all required information must be provided in the API request.

Constructors

Sep06DepositRequest

constructor(assetCode: String, account: String, jwt: String, assetIssuer: String? = null, memoType: String? = null, memo: String? = null, emailAddress: String? = null, type: String? = null, fundingMethod: String? = null, amount: 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. May differ from the account authenticated via SEP-10.

amount

val amount: String?

Amount the user intends to deposit. May be necessary for the anchor to determine KYC requirements.

assetCode

val assetCode: String

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

assetIssuer

val assetIssuer: String?

Issuer of the asset. 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.

countryCode

val countryCode: String?

ISO 3166-1 alpha-3 code of the user's current address. May be necessary for the anchor to determine KYC requirements.

customerId

val customerId: String?

SEP-12 customer ID if the off-chain account is already known to the anchor but not linked to this Stellar account.

emailAddress

val emailAddress: String?

Email address of the depositor. The anchor may use this to send status updates about the deposit.

extraFields

val extraFields: Map<String, String>?

Additional fields required by the anchor beyond the standard parameters. Keys should match field names from the /info response.

fundingMethod

val fundingMethod: String?

Method of funding the deposit (replaces deprecated type field). Values come from the /info endpoint's funding_methods for the asset.

jwt

val jwt: String

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

lang

val lang: String?

Language code (RFC 4646, e.g., "en", "es") for error messages and human-readable content. Defaults to "en".

locationId

val locationId: String?

ID of the chosen location for cash drop-off, if applicable.

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 where the anchor should POST transaction status updates. The callback message format matches the /transaction endpoint response.

type

val ~~type~~: String?

Deprecated: Use fundingMethod instead. Type of deposit method (e.g., SEPA, SWIFT) if the anchor supports multiple deposit methods.

walletName

val ~~walletName~~: String?

Deprecated: Use client_domain in SEP-10 JWT instead. Name of the wallet application for display purposes.

walletUrl

val ~~walletUrl~~: String?

Deprecated: Use client_domain in SEP-10 JWT instead. URL of the wallet application.