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

{
    "Account": "rfkE1aSy9G8Upk4JssnwBxhEv5p4mn2KTy",
    "TransactionType": "CheckCash",
    "Amount": "100000000",
    "CheckID": "838766BA2B995C00744175F69A1B11E32C3DBC40E64801A4056FCBD657F57334",
    "Fee": "12"
}

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 code tecNO_PERMISSION.

  • If the Check identified by the CheckID field does not exist, the transaction fails with the result tecNO_ENTRY.

  • If the Check identified by the CheckID field has already expired, the transaction fails with the result tecEXPIRED.

  • 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 code tecDST_TAG_NEEDED.

  • If the transaction specifies both Amount and DeliverMin, or omits both, the transaction fails with the result temMALFORMED.

  • If the Amount or DeliverMin does not match the currency (and issuer, if not XAH) of the Check, the transaction fails with the result temBAD_CURRENCY.

Last updated