DepositExchangeRequest class
Constructors
-
DepositExchangeRequest({required String destinationAsset, required String sourceAsset, required String amount, required String account, String? quoteId, String? memoType, String? memo, String? emailAddress, String? type, String? walletName, String? walletUrl, String? lang, String? onChangeCallback, String? countryCode, String? claimableBalanceSupported, String? customerId, String? locationId, String? jwt})
-
Properties
-
account
↔ String
-
The stellar or muxed account ID of the user that wants to deposit.
This is where the asset token will be sent. Note that the account
specified in this request could differ from the account authenticated
via SEP-10.
getter/setter pair
-
amount
↔ String
-
The amount of the source_asset the user would like to deposit to the
anchor's off-chain account. This field may be necessary for the anchor
to determine what KYC information is necessary to collect. Should be
equals to quote.sell_amount if a quote_id was used.
getter/setter pair
-
claimableBalanceSupported
↔ String?
-
(optional) true if the client supports receiving deposit transactions
as a claimable balance, false otherwise.
getter/setter pair
-
countryCode
↔ String?
-
(optional) The ISO 3166-1 alpha-3 code of the user's current address.
This field may be necessary for the anchor to determine what KYC
information is necessary to collect.
getter/setter pair
-
customerId
↔ String?
-
(optional) id of an off-chain account (managed by the anchor) associated
with this user's Stellar account (identified by the JWT's sub field).
If the anchor supports SEP-12, the customerId field should match the
SEP-12 customer's id. customerId should be passed only when the off-chain
id is know to the client, but the relationship between this id and the
user's Stellar account is not known to the Anchor.
getter/setter pair
-
destinationAsset
↔ String
-
The code of the on-chain asset the user wants to get from the Anchor
after doing an off-chain deposit. The value passed must match one of the
codes listed in the /info response's deposit-exchange object.
getter/setter pair
-
emailAddress
↔ String?
-
(optional) Email address of depositor. If desired, an anchor can use
this to send email updates to the user about the deposit.
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
jwt
↔ String?
-
jwt previously received from the anchor via the SEP-10 authentication flow
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. error fields
and other human readable messages in the response should be in
this language.
getter/setter pair
-
locationId
↔ String?
-
(optional) id of the chosen location to drop off cash
getter/setter pair
-
memo
↔ String?
-
(optional) (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 as well as memo_type can
be different than the values 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 the anchor should attach to the
Stellar payment transaction, one of text, id or hash.
getter/setter pair
-
onChangeCallback
↔ String?
-
(optional) A URL that the anchor should POST a JSON message to when the
status property of the transaction created as a result of this request
changes. The JSON message should be identical to the response format for
the /transaction endpoint. The callback needs to be signed by the anchor
and the signature needs to be verified by the wallet according to
the callback signature specification.
getter/setter pair
-
quoteId
↔ String?
-
(optional) The id returned from a SEP-38 POST /quote response.
If this parameter is provided and the user delivers the deposit funds
to the Anchor before the quote expiration, the Anchor should respect the
conversion rate agreed in that quote. If the values of destination_asset,
source_asset and amount conflict with the ones used to create the
SEP-38 quote, this request should be rejected with a 400.
getter/setter pair
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
sourceAsset
↔ String
-
The off-chain asset the Anchor will receive from the user. The value must
match one of the asset values included in a SEP-38
GET /prices?buy_asset=stellar:<destination_asset>:<asset_issuer> response
using SEP-38 Asset Identification Format.
getter/setter pair
-
type
↔ String?
-
(optional) Type of deposit. If the anchor supports multiple deposit
methods (e.g. SEPA or SWIFT), the wallet should specify type. This field
may be necessary for the anchor to determine which KYC fields to collect.
getter/setter pair
-
walletName
↔ String?
-
(deprecated, optional) In communications / pages about the deposit,
anchor should display the wallet name to the user to explain where funds
are going. However, anchors should use client_domain (for non-custodial)
and sub value of JWT (for custodial) to determine wallet information.
getter/setter pair
-
walletUrl
↔ String?
-
(deprecated, optional) Anchor should link to this when notifying the user
that the transaction has completed. However, anchors should use
client_domain (for non-custodial) and sub value of JWT (for custodial)
to determine wallet information.
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