SEP24WithdrawRequest class

Request of the withdraw endpoint.

Constructors

SEP24WithdrawRequest()

Properties

account ↔ String?

(optional) The Stellar (G...) or muxed account (M...) the client wants to use as the destination of the payment sent by the anchor. Defaults to the account authenticated via SEP-10 if not specified.

getter/setter pair

amount ↔ String?

(optional) Amount of asset requested to withdraw. If this is not provided it will be collected in the interactive flow.

getter/setter pair

assetCode ↔ String

Code of the asset the user wants to withdraw. The value passed must match one of the codes listed in the /info response's withdraw object. 'native' is a special asset_code that represents the native XLM token.

getter/setter pair

assetIssuer ↔ String?

(optional) The issuer of the stellar asset the user wants to withdraw with the anchor. If asset_issuer is not provided, the anchor should use the asset issued by themselves as described in their TOML file. If 'native' is specified as the asset_code, asset_issuer must be not be set.

getter/setter pair

customFields ↔ Map<String, String>?

Custom SEP-9 fields that you can use for transmission (fieldname,value)

getter/setter pair

customFiles ↔ Map<String, Uint8List>?

Custom SEP-9 files that you can use for transmission (fieldname, value)

getter/setter pair

destinationAsset ↔ String?

(optional) string in Asset Identification Format - The asset user wants to receive. It's an off-chain or fiat asset. If this is not provided, it will be collected in the interactive flow. When quote_id is specified, this parameter must match the quote's buy_asset asset code or be omitted.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

jwt ↔ String

jwt previously received from the anchor via the SEP-10 authentication flow

getter/setter pair

kycFields ↔ StandardKYCFields?

Additionally, any SEP-9 parameters may be passed as well to make the onboarding experience simpler.

getter/setter pair

lang ↔ String?

(optional) Defaults to en if not specified or if the specified language is not supported. Language code specified using RFC 4646 which means it can also accept locale in the format en-US. error fields in the response, as well as the interactive flow UI and any other user-facing strings returned for this transaction should be in this language.

getter/setter pair

memo ↔ String?

(deprecated, optional) This field was originally intended to differentiate users of the same Stellar account. However, the anchor should use the sub value included in the decoded SEP-10 JWT instead. Anchors should still support this parameter to maintain support for outdated clients. See the Shared Account Authentication section for more information. https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#shared-omnibus-or-pooled-accounts

getter/setter pair

memoType ↔ String?

(deprecated, optional) Type of memo. One of text, id or hash. Deprecated because memos used to identify users of the same Stellar account should always be of type of id.

getter/setter pair

quoteId ↔ String?

(optional) The id returned from a SEP-38 POST /quote response.

getter/setter pair

refundMemo ↔ String?

(optional) The memo the anchor must use when sending refund payments back to the user. If not specified, the anchor should use the same memo used by the user to send the original payment. If specified, refund_memo_type must also be specified.

getter/setter pair

refundMemoType ↔ String?

(optional) The type of the refund_memo. Can be id, text, or hash. See the memos documentation for more information. If specified, refund_memo must also be specified. https://developers.stellar.org/docs/encyclopedia/memos

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

walletName ↔ String?

(optional) In communications / pages about the withdrawal, anchor should display the wallet name to the user to explain where funds are coming from.

getter/setter pair

walletUrl ↔ String?

(optional) Anchor can show this to the user when referencing the wallet involved in the withdrawal (ex. in the anchor's transaction history).

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited