SEP24Transaction class
Represents an anchor transaction
Constructors
- SEP24Transaction(String id, String kind, String status, int? statusEta, bool? kycVerified, String moreInfoUrl, String? amountIn, String? amountInAsset, String? amountOut, String? amountOutAsset, String? amountFee, String? amountFeeAsset, String? quoteId, String startedAt, String? completedAt, String? updatedAt, String? userActionRequiredBy, String? stellarTransactionId, String? externalTransactionId, String? message, bool? refunded, Refund? refunds, String? from, String? to, String? depositMemo, String? depositMemoType, String? claimableBalanceId, String? withdrawAnchorAccount, String? withdrawMemo, String? withdrawMemoType)
-
SEP24Transaction.fromJson(Map<
String, dynamic> json) -
factory
Properties
- amountFee ↔ String?
-
(optional) Amount of fee charged by anchor.
getter/setter pair
- amountFeeAsset ↔ String?
-
(optional) The asset in which fees are calculated in. Must be present if the deposit/withdraw was made using non-equivalent assets.
The value must be in SEP-38 Asset Identification Format.
https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format
See also the Asset Exchanges section for more information.
https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#asset-exchanges
getter/setter pair
- amountIn ↔ String?
-
(optional) Amount received by anchor at start of transaction as a string with up to 7 decimals. Excludes any fees charged before the anchor received the funds.
getter/setter pair
- amountInAsset ↔ String?
-
(optional) The asset received or to be received by the Anchor. Must be present if the deposit/withdraw was made using non-equivalent assets.
The value must be in SEP-38 Asset Identification Format.
https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format
See also the Asset Exchanges section for more information.
https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#asset-exchanges
getter/setter pair
- amountOut ↔ String?
-
(optional) Amount sent by anchor to user at end of transaction as a string with up to 7 decimals.
Excludes amount converted to XLM to fund account and any external fees.
getter/setter pair
- amountOutAsset ↔ String?
-
(optional) The asset delivered or to be delivered to the user. Must be present if the deposit/withdraw was made using non-equivalent assets.
The value must be in SEP-38 Asset Identification Format.
https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format
See also the Asset Exchanges section for more information.
https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md#asset-exchanges
getter/setter pair
- claimableBalanceId ↔ String?
-
(optional) ID of the Claimable Balance used to send the asset initially requested.
getter/setter pair
- completedAt ↔ String?
-
(optional) The date and time of transaction reaching completed or refunded status. UTC ISO 8601 string
getter/setter pair
- depositMemo ↔ String?
-
(optional) This is the memo (if any) used to transfer the asset to the to Stellar address.
getter/setter pair
- depositMemoType ↔ String?
-
(optional) Type for the deposit_memo.
getter/setter pair
- externalTransactionId ↔ String?
-
(optional) ID of transaction on external network that either started the deposit or completed the withdrawal.
getter/setter pair
- from ↔ String?
-
In case of deposit: Sent from address, perhaps BTC, IBAN, or bank account.
In case of withdraw: Stellar address the assets were withdrawn from.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- id ↔ String
-
Unique, anchor-generated id for the deposit/withdrawal.
getter/setter pair
- kind ↔ String
-
deposit or withdrawal.
getter/setter pair
- kycVerified ↔ bool?
-
(optional) True if the anchor has verified the user's KYC information for this transaction.
getter/setter pair
- message ↔ String?
-
(optional) Human readable explanation of transaction status, if needed.
getter/setter pair
- moreInfoUrl ↔ String
-
(optional) A URL that is opened by wallets after the interactive flow is complete. It can include banking information for users to start deposits, the status of the transaction, or any other information the user might need to know about the transaction.
getter/setter pair
- quoteId ↔ String?
-
(optional) The ID of the quote used when creating this transaction. Should be present if a quote_id
was included in the POST /transactions/deposit/interactive or POST /transactions/withdraw/interactive request.
Clients should be aware that the quote_id may not be present in older implementations.
getter/setter pair
- rateLimitLimit ↔ int?
-
getter/setter pairinherited
- rateLimitRemaining ↔ int?
-
getter/setter pairinherited
- rateLimitReset ↔ int?
-
getter/setter pairinherited
- refunded ↔ bool?
-
(deprecated, optional) This field is deprecated in favor of the refunds object and the refunded status.
True if the transaction was refunded in full. False if the transaction was partially refunded or not refunded.
For more details about any refunds, see the refunds object.
getter/setter pair
- refunds ↔ Refund?
-
(optional) An object describing any on or off-chain refund associated with this transaction.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startedAt ↔ String
-
Start date and time of transaction. UTC ISO 8601 string
getter/setter pair
- status ↔ String
-
Processing status of deposit/withdrawal.
getter/setter pair
- statusEta ↔ int?
-
(optional) Estimated number of seconds until a status change is expected.
getter/setter pair
- stellarTransactionId ↔ String?
-
(optional) transaction_id on Stellar network of the transfer that either completed the deposit or started the withdrawal.
getter/setter pair
- to ↔ String?
-
In case of deposit: Stellar address the deposited assets were sent to.
In case of withdraw: Sent to address (perhaps BTC, IBAN, or bank account in the case of a withdrawal, Stellar address in the case of a deposit).
getter/setter pair
- updatedAt ↔ String?
-
(optional) The date and time of transaction reaching the current status. UTC ISO 8601 string
getter/setter pair
- userActionRequiredBy ↔ String?
-
(optional) The date and time by when the user action is required.
In certain statuses, such as pending_user_transfer_start or incomplete,
anchor waits for the user action and user_action_required_by field should
be used to show the time anchors gives for the user to make an action
before transaction will automatically be moved into a different status
(such as expired or to be refunded). user_action_required_by should
only be specified for statuses where user action is required,
and omitted for all other. Anchor should specify the action waited on
using message or more_info_url.
getter/setter pair
- withdrawAnchorAccount ↔ String?
-
If this is a withdrawal, this is the anchor's Stellar account that the user transferred (or will transfer) their asset to.
getter/setter pair
- withdrawMemo ↔ String?
-
Memo used when the user transferred to withdraw_anchor_account.
Assigned null if the withdraw is not ready to receive payment, for example if KYC is not completed.
getter/setter pair
- withdrawMemoType ↔ String?
-
Memo type for withdraw_memo.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setHeaders(
Map< String, String> headers) → void -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited