AnchorTransaction class

Represents an anchor transaction

Constructors

AnchorTransaction({required String id, required String kind, required String status, int? statusEta, String? moreInfoUrl, String? amountIn, String? amountInAsset, String? amountOut, String? amountOutAsset, String? amountFee, String? amountFeeAsset, FeeDetails? feeDetails, String? quoteId, String? from, String? to, String? externalExtra, String? externalExtraText, String? depositMemo, String? depositMemoType, String? withdrawAnchorAccount, String? withdrawMemo, String? withdrawMemoType, String? startedAt, String? updatedAt, String? completedAt, String? stellarTransactionId, String? externalTransactionId, String? message, bool? refunded, TransactionRefunds? refunds, String? requiredInfoMessage, Map<String, AnchorField>? requiredInfoUpdates, Map<String, DepositInstruction>? instructions, String? claimableBalanceId})

AnchorTransaction.fromJson(Map<String, dynamic> json)

factory

Properties

amountFee ↔ String?

(deprecated, optional) Amount of fee charged by anchor. Should be equals to quote.fee.total if a quote_id was used.

getter/setter pair

amountFeeAsset ↔ String?

(deprecated, optional) The asset in which fees are calculated in. Must be present if the deposit/withdraw was made using quotes. The value must be in SEP-38 Asset Identification Format. Should be equals to quote.fee.asset if a quote_id was used.

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. Should be equals to quote.sell_asset if a quote_id was used.

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 quotes. The value must be in SEP-38 Asset Identification Format.

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. Should be equals to quote.buy_asset if a quote_id was used.

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 quotes. The value must be in SEP-38 Asset Identification Format.

getter/setter pair

claimableBalanceId ↔ String?

(optional) ID of the Claimable Balance used to send the asset initially requested. Only relevant for deposit transactions.

getter/setter pair

completedAt ↔ String?

(optional) Completion date and time of transaction - UTC ISO 8601 string.

getter/setter pair

depositMemo ↔ String?

(optional) If this is a deposit, 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 depositMemo.

getter/setter pair

externalExtra ↔ String?

(optional) Extra information for the external account involved. It could be a bank routing number, BIC, or store number for example.

getter/setter pair

externalExtraText ↔ String?

(optional) Text version of external_extra. This is the name of the bank or store

getter/setter pair

externalTransactionId ↔ String?

(optional) ID of transaction on external network that either started the deposit or completed the withdrawal.

getter/setter pair

feeDetails ↔ FeeDetails?

Description of fee charged by the anchor. If quote_id is present, it should match the referenced quote's fee object.

getter/setter pair

from ↔ String?

(optional) Sent from address (perhaps BTC, IBAN, or bank account in the case of a deposit, Stellar address in the case of a withdrawal).

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ String

Unique, anchor-generated id for the deposit/withdrawal.

getter/setter pair

instructions ↔ Map<String, DepositInstruction>?

(optional) JSON object containing the SEP-9 financial account fields that describe how to complete the off-chain deposit in the same format as the /deposit response. This field should be present if the instructions were provided in the /deposit response or if it could not have been previously provided synchronously. This field should only be present once the status becomes pending_user_transfer_start, not while the transaction has any statuses that precede it such as incomplete, pending_anchor, or pending_customer_info_update.

getter/setter pair

kind ↔ String

deposit, deposit-exchange, withdrawal or withdrawal-exchange.

getter/setter pair

message ↔ String?

(optional) Human readable explanation of transaction status, if needed.

getter/setter pair

moreInfoUrl ↔ String?

(optional) A URL the user can visit if they want more information about their account / status.

getter/setter pair

quoteId ↔ String?

(optional) The ID of the quote used to create this transaction. Should be present if a quote_id was included in the POST /transactions request. Clients should be aware though that the quote_id may not be present in older implementations.

getter/setter pair

refunded ↔ bool?

(deprecated, optional) This field is deprecated in favor of the refunds object. 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 ↔ TransactionRefunds?

(optional) An object describing any on or off-chain refund associated with this transaction.

getter/setter pair

requiredInfoMessage ↔ String?

(optional) A human-readable message indicating any errors that require updated information from the user.

getter/setter pair

requiredInfoUpdates ↔ Map<String, AnchorField>?

(optional) A set of fields that require update from the user described in the same format as /info. This field is only relevant when status is pending_transaction_info_update.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

startedAt ↔ String?

(optional) 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?

(optional) 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.

getter/setter pair

withdrawAnchorAccount ↔ String?

(optional) If this is a withdrawal, this is the anchor's Stellar account that the user transferred (or will transfer) their issued asset to.

getter/setter pair

withdrawMemo ↔ String?

(optional) Memo used when the user transferred to withdrawAnchorAccount.

getter/setter pair

withdrawMemoType ↔ String?

(optional) Memo type for withdrawMemo.

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