Check
Last updated
Was this helpful?
Last updated
Was this helpful?
(Added by the [Checks amendment][].)
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. (The potential payment has already been approved by its sender, but no money moves until it is cashed. Unlike an Escrow, the money for a Check is not set aside, so cashing the Check could fail due to lack of funds.)
A Check object has the following fields:
Account
String
Account
Yes
The sender of the Check. Cashing the Check debits this address's balance.
Destination
String
Account
Yes
The intended recipient of the Check. Only this address can cash the Check, using a [CheckCash transaction][].
DestinationNode
String
UInt64
No
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
UInt32
No
An arbitrary tag to further specify the destination for this Check, such as a hosted recipient at the destination address.
Expiration
Number
UInt32
No
Indicates the time after which this Check is considered expired. See [Specifying Time][] for details.
Flags
Number
UInt32
Yes
A bit-map of boolean flags enabled for this object. Currently, the protocol defines no flags for Check objects. The value is always 0.
InvoiceID
String
Hash256
No
Arbitrary 256-bit hash provided by the sender as a specific reason or identifier for this Check.
LedgerEntryType
String
UInt16
Yes
The value 0x0043, mapped to the string Check, indicates that this object is a Check object.
OwnerNode
String
UInt64
Yes
A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages. Note: The object does not contain a direct link to the owner directory containing it, since that value can be derived from the Account.
PreviousTxnID
String
Hash256
Yes
The identifying hash of the transaction that most recently modified this object.
PreviousTxnLgrSeq
Number
UInt32
Yes
The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this object.
SendMax
String or Object
Amount
Yes
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
UInt32
Yes
The sequence number of the [CheckCreate transaction][] that created this check.
SourceTag
Number
UInt32
No
An arbitrary tag to further specify the source for this Check, such as a hosted recipient at the sender's address.
The ID of a Check object is the [SHA-512Half][] of the following values, concatenated in order:
The Check space key (0x0043)
The AccountID of the sender of the [CheckCreate transaction][] that created the Check object
The Sequence number of the [CheckCreate transaction][] that created the Check object. If the CheckCreate transaction used a Ticket, use the TicketSequence value instead.