CheckCash

Cashes a check to receive the specified amount of XRP or issued currency.

See the canonical spec:

TypeScript
import { Client, Wallet } from 'xrpl';

async function cashCheck(): Promise<void> {
  const client = new Client('wss://honeycluster.dev');
  await client.connect();

  const wallet = Wallet.fromSeed('s...');
  const prepared = await client.autofill({
    TransactionType: 'CheckCash',
    Account: wallet.address,
    CheckID: 'ABC...',
    Amount: '1000000',
  });
  const signed = wallet.sign(prepared);
  const res = await client.submitAndWait(signed.tx_blob);
  console.log(res);
  await client.disconnect();
}

cashCheck().catch(console.error);

Parameters

Field	Type	Required	Description
`Account`	String	Yes	The address of the account cashing the check
`CheckID`	String	Yes	The unique identifier of the check to cash
`Amount`	String/Object	No	Amount to cash (for issued currency)
`DeliverMin`	String/Object	No	Minimum amount to deliver (alternative to Amount)

CheckID:

•
Unique identifier returned from CheckCreate
•
The check will be consumed and removed from the ledger

Amount vs DeliverMin:

•
For XRP: Use DeliverMin to specify minimum XRP to receive
•
For issued currency: Use Amount to specify exact amount to receive
•
Only one of these fields should be specified

Note:

•
Can only be executed by the check destination
•
The check is consumed and cannot be cashed again

Notes

•
Executes a previously created check
•
CheckID identifies the specific check to cash
•
Amount specifies how much to receive (for issued currency)
•
The check is consumed and removed from the ledger
•
Always use autofill to set fees and sequence safely when using the XRPL client library

CheckCreate

CheckCancel