SEP24DepositRequest class

Request of the deposit endpoint.

Constructors

SEP24DepositRequest()

Properties

account ↔ String?

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

getter/setter pair

amount ↔ String?

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

getter/setter pair

assetCode ↔ String

The code of the stellar asset the user wants to receive for their deposit with the anchor. The value passed must match one of the codes listed in the /info response's deposit 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 receive for their deposit with the anchor. If assetIssuer is not provided, the anchor will use the asset issued by themselves as described in their TOML file. If 'native' is specified as the assetCode, assetIssuer must be not be set.

getter/setter pair

claimableBalanceSupported ↔ String?

(optional) True if the client supports receiving deposit transactions as a claimable balance, false otherwise.

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

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?

(optional) Value of memo to attach to transaction, for hash this should be base64-encoded. Because a memo can be specified in the SEP-10 JWT for Shared Accounts, this field can be different than the value included in the SEP-10 JWT. For example, a client application could use the value passed for this parameter as a reference number used to match payments made to account.

getter/setter pair

memoType ↔ String?

(optional) type of memo that anchor should attach to the Stellar payment transaction, one of text, id or hash

getter/setter pair

quoteId ↔ String?

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

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sourceAsset ↔ String?

(optional) - string in Asset Identification Format - The asset user wants to send. Note, that this is the asset user initially holds (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 sell_asset asset code or be omitted.

getter/setter pair

walletName ↔ String?

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

getter/setter pair

walletUrl ↔ String?

(optional) Anchor should link to this when notifying the user that the transaction has completed.

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