Create an on-ledger check, which is a deferred payment that can be cashed by its intended destination. The sender of this transaction is the sender of the check.
Requires the Checks amendment. Loading...
{
"Account": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
"TransactionType": "CheckCreate",
"SendMax": {
"currency": "FOO",
"issuer": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
"value": "100"
},
"Expiration": 1162029167,
"Destination": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"DestinationTag": 67
}In addition to the common fields, CheckCreate transactions use the following fields:
| Field | JSON Type | Internal Type | Description |
|---|---|---|---|
Destination | String | AccountID | The unique address of the account that can cash the Check. |
SendMax | Currency Amount | Amount | Maximum amount of source currency the Check is allowed to debit the sender, including transfer fees on non-XRP currencies. The Check can only credit the destination with the same currency (from the same issuer, for non-XRP currencies). For non-XRP amounts, the nested field names MUST be lower-case. |
DestinationTag | Number | UInt32 | (Optional) Arbitrary tag that identifies the reason for the Check, or a hosted recipient to pay. |
Expiration | Number | UInt32 | (Optional) Time after which the Check is no longer valid, in seconds since the Ripple Epoch. |
InvoiceID | String | UInt256 | (Optional) Arbitrary 256-bit hash representing a specific reason or identifier for this Check. |
Besides errors that can occur for all transactions, CheckCreate transactions can result in the following transaction result codes:
| Error Code | Description |
|---|---|
tecNO_PERMISSION | The Destination account is blocking incoming Checks. Requires the DisallowIncoming amendment. Loading... |
temREDUNDANT | The Destination is the sender of the transaction. |
tecNO_DST | The Destination account does not exist in the ledger. |
tecDST_TAG_NEEDED | The Destination account has the RequireDest flag enabled but the transaction does not include a DestinationTag field. |
tecFROZEN | SendMax specifies a token which is frozen. |
tecEXPIRED | The Expiration of the transaction is in the past. |
tecINSUFFICIENT_RESERVE | The sender does not have enough XRP to meet the owner reserve after adding the Check. |
tecDIR_FULL | Either the sender or the destination of the Check cannot own more objects in the ledger. This error is effectively impossible to receive if Requires the fixDirectoryLimit. Loading... is enabled. |