Cheques

Create and manage cheque orders.

Cheque

Name	Type	Description
id	string	A unique ID prefixed with cheque_
object	string	Always cheque
status	string	See Tracking
to	Contact	The recipient
from	Contact	The sender
imbStatus	string or null	See Intelligent-Mail Tracking
live	boolean	true if this is a live mode cheque else false
url	string or null	Signed link to a preview of this letter order
description	string or null	Optional line describing this cheque
sendDate	Date	Date when the cheque will be sent
bankAccount	string	A Bank Account ID, the drawee
currencyCode	string	3-letter code representing currency of amount
amount	integer	The cheque amount as an integer representing cents
memo	string or null	An optional memo to be printed on the cheque (Max 40 characters long)
logo	string or null	An optional logo image URL which will be printed on the cheque
number	integer	The cheque number
message	string or null	An optional (HTML) message to print on the same page as the cheque
letterHTML	string or null	The raw HTML for the attached letter, if any
letterTemplate	string or null	A Template ID for the attached letter, if any
letterUploadedPDF	string or null	A URL pointing to the original PDF of the attached letter
mailingClass	first_class or standard_class	Defaults to first_class. See mailing class
mergeVariables	object or null	Merge Variables for the message/attached letter
metadata	object or null	See Metadata
digitalOnly	object or null, {"watermark": "File Copy"}	Field is present only when a cheque is created as a digital-only check. This is available only if it is enabled for your organization. Please reach out to [email protected] for more information.