Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Check

A Check object describes a check, similar to a paper personal check, which can be cashed by its destination to get money from its sender.

Hierarchy

  • default
    • Check

Index

Properties

Account: string

The sender of the Check. Cashing the Check debits this address's balance.

Destination: string

The intended recipient of the Check. Only this address can cash the Check, using a CheckCash transaction.

DestinationNode?: string

A hint indicating which page of the destination's owner directory links to this object, in case the directory consists of multiple pages.

DestinationTag?: number

An arbitrary tag to further specify the destination for this Check, such as a hosted recipient at the destination address.

Expiration?: number

Indicates the time after which this Check is considered expired.

Flags: 0

A bit-map of boolean flags. No flags are defined for Checks, so this value is always 0.

InvoiceID?: string

Arbitrary 256-bit hash provided by the sender as a specific reason or identifier for this Check.

LedgerEntryType: "Check"
OwnerNode: string

A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.

PreviousTxnID: string

The identifying hash of the transaction that most recently modified this object.

PreviousTxnLgrSeq: number

The index of the ledger that contains the transaction that most recently modified this object.

SendMax: Amount

The maximum amount of currency this Check can debit the sender. If the Check is successfully cashed, the destination is credited in the same currency for up to this amount.

Sequence: number

The sequence number of the CheckCreate transaction that created this check.

SourceTag?: number

An arbitrary tag to further specify the source for this Check, such as a hosted recipient at the sender's address.

index: string

Generated using TypeDoc