Options
All
  • Public
  • Public/Protected
  • All
Menu

Record containing exchange details.

Hierarchy

  • Exchange

Index

Properties

amount

amount: Decimal

Amount in source account currency.

confirmedAt

confirmedAt: number | null

Epoch timestamp when transaction was confirmed or null if not yet confirmed.

exchangeFee

exchangeFee: Decimal

Exchange fee in target account currency, calculated as amount X exchangeRate X feeRate.

See ExchangeSettings.

exchangeRate

exchangeRate: ExchangeRate

Exchange rate used.

exchangeRates

Exchange rates at the time exchange was made. This can be used to display amounts in local currency to the user.

exchangeSettings

exchangeSettings: ExchangeSettings

Exchange settings used.

fromAccountId

fromAccountId: string

Source Account identifier.

fromCurrency

fromCurrency: CurrencyCode

Currency from which exchange was made.

id

id: string

Identifier

incomingTransactionFee

incomingTransactionFee: Decimal

Return Transaction fee.

incomingTransactionId

incomingTransactionId: string | null

Return Transaction identifier.

nonce

nonce: string | null

Exchange nonce or null. Used to prevent double spend.

outgoingTransactionFee

outgoingTransactionFee: Decimal

Outgoing transaction fee.

outgoingTransactionId

outgoingTransactionId: string | null

Outgoing Transaction identifier.

returnAmount

returnAmount: Decimal

Amount that user receives in target account currency, calculated as amount X exchangeRate X (1 - feeRate) - withdrawFee.

See ExchangeSettings.

status

Exchange status.

submittedAt

submittedAt: number

Epoch timestamp when transaction was submitted.

timestamp

timestamp: number

Alias of submittedAt timestamp. Provided for convenience to match Transaction record structure.

toAccountId

toAccountId: string

Target Account identifier.

toCurrency

toCurrency: CurrencyCode

Currency to which exchange was made.

Legend

  • Property
  • Method
  • Private property
  • Private method
  • Property
  • Inherited property
  • Static property

Generated using TypeDoc