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

Sep06WithdrawRequest

data class Sep06WithdrawRequest(val assetCode: String, val type: String, val jwt: String, val fundingMethod: String? = null, val dest: String? = null, val destExtra: String? = null, val account: String? = null, val memo: String? = null, val memoType: String? = null, val amount: 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 from a Stellar anchor.

A withdrawal occurs when a user sends a Stellar asset to an anchor's account, and the anchor delivers the equivalent amount in an off-chain asset (fiat to bank account, crypto to external blockchain, cash pickup, etc.).

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

Constructors

Sep06WithdrawRequest

constructor(assetCode: String, type: String, jwt: String, fundingMethod: String? = null, dest: String? = null, destExtra: String? = null, account: String? = null, memo: String? = null, memoType: String? = null, amount: 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 (G...) or muxed account (M...) that will send the withdrawal. May differ from the account authenticated via SEP-10.

amount

val amount: String?

Amount the user intends to withdraw. May be necessary for KYC determination.

assetCode

val assetCode: String

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

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 (crypto address, bank account number, IBAN, mobile number, or email address).

destExtra

val destExtra: String?

Additional destination information such as routing number, BIC, memo, or partner name handling the withdrawal.

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. Only needed if SEP-10 authentication is not used.

memoType

val ~~memoType~~: String?

Deprecated: Type of memo ("text", "id", or "hash"). Memos for user identification should use type "id".

onChangeCallback

val onChangeCallback: String?

URL for transaction status update callbacks.

refundMemo

val refundMemo: String?

Memo the anchor must use when sending refund payments. If not specified, the anchor uses the same memo from the original payment.

refundMemoType

val refundMemoType: String?

Type of the refund memo: "id", "text", or "hash". Required if refundMemo is specified.

type

val ~~type~~: String

Type of withdrawal method: "crypto", "bank_account", "cash", "mobile", "bill_payment", or other custom values. Deprecated but still required for compatibility. Use fundingMethod for new implementations.

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.