CheckCash
Attempts to redeem a Check object in the ledger to receive up to the amount authorized by the corresponding CheckCreate transaction.
[Source]
(Added by the [Checks amendment][].)
Example
CheckID
String
Hash256
The ID of the Check ledger object to cash, as a 64-character hexadecimal string.
Amount
Amount
(Optional) 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
.
DeliverMin
[Currency Amount][]
Amount
(Optional) 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
.
The transaction must include either Amount
or DeliverMin
, but not both.
Error Cases
If the sender of the CheckCash transaction is not the
Destination
of the check, the transaction fails with the result codetecNO_PERMISSION
.If the Check identified by the
CheckID
field does not exist, the transaction fails with the resulttecNO_ENTRY
.If the Check identified by the
CheckID
field has already expired, the transaction fails with the resulttecEXPIRED
.If the destination of the Check has the
RequireDest
flag enabled but the Check, as created, does not have a destination tag, the transaction fails with the result codetecDST_TAG_NEEDED
.If the transaction specifies both
Amount
andDeliverMin
, or omits both, the transaction fails with the resulttemMALFORMED
.If the
Amount
orDeliverMin
does not match the currency (and issuer, if not XAH) of the Check, the transaction fails with the resulttemBAD_CURRENCY
.
Last updated