Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CheckCash

Attempts to redeem a Check object in the ledger to receive up to the amount authorized by the corresponding CheckCreate transaction. Only the Destination address of a Check can cash it with a CheckCash transaction.

Hierarchy

  • BaseTransaction
    • CheckCash

Index

Properties

Account

Account: string

Optional AccountTxnID

AccountTxnID: string

Optional Amount

Amount: Amount

Redeem the Check for exactly this amount, if possible. The currency must match that of the SendMax of the corresponding CheckCreate transaction. You. must provide either this field or DeliverMin.

CheckID

CheckID: string

The ID of the Check ledger object to cash, as a 64-character hexadecimal. string.

Optional DeliverMin

DeliverMin: Amount

Redeem the Check for at least this amount and for as much as possible. The currency must match that of the SendMax of the corresponding CheckCreate. transaction. You must provide either this field or Amount.

Optional Fee

Fee: string

Optional Flags

Flags: number | GlobalFlags

Optional LastLedgerSequence

LastLedgerSequence: number

Optional Memos

Memos: { Memo: Memo }[]

Optional Sequence

Sequence: number

Optional Signers

Signers: Signer[]

Optional SigningPubKey

SigningPubKey: string

Optional SourceTag

SourceTag: number

Optional TicketSequence

TicketSequence: number

TransactionType

TransactionType: "CheckCash"

Optional TxnSignature

TxnSignature: string

Generated using TypeDoc