## Create Cheque **post** `/print-mail/v1/cheques` Create a cheque. This endpoint allows you to create a new cheque with the specified details. If you would like to create a digitalOnly cheque, the digitalOnly object with the watermark will need to be passed in. Feature is available on request, e-mail support@postgrid.com for access. Example request body: ```json { "from": "contact_123", "bankAccount": "bank_123", "amount": 1000, "currencyCode": "USD", "number": 123456, "size": "us_letter", "digitalOnly": { "watermark": "VOID" } } ``` ### Body Parameters - `amount: number` The amount of the cheque in cents. - `bankAccount: string` The bank account (ID) associated with the cheque. - `from: ContactCreateWithFirstName or ContactCreateWithCompanyName or string` The contact information of the sender. You can pass contact information inline here just like you can for the `to`. - `ContactCreateWithFirstName = object { addressLine1, countryCode, firstName, 13 more }` - `addressLine1: string` The first line of the contact's address. - `countryCode: string` The ISO 3611-1 country code of the contact's address. - `firstName: string` - `addressLine2: optional string` Second line of the contact's address, if applicable. - `city: optional string` The city of the contact's address. - `companyName: optional string` Company name of the contact. - `description: optional string` An optional string describing this resource. Will be visible in the API and the dashboard. - `email: optional string` Email of the contact. - `forceVerifiedStatus: optional boolean` If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise. - `jobTitle: optional string` Job title of the contact. - `lastName: optional string` Last name of the contact. - `metadata: optional map[unknown]` See the section on Metadata. - `phoneNumber: optional string` Phone number of the contact. - `postalOrZip: optional string` The postal or ZIP code of the contact's address. - `provinceOrState: optional string` Province or state of the contact's address. - `skipVerification: optional boolean` If `true`, PostGrid will skip running this contact's address through our address verification system. - `ContactCreateWithCompanyName = object { addressLine1, companyName, countryCode, 13 more }` - `addressLine1: string` The first line of the contact's address. - `companyName: string` - `countryCode: string` The ISO 3611-1 country code of the contact's address. - `addressLine2: optional string` Second line of the contact's address, if applicable. - `city: optional string` The city of the contact's address. - `description: optional string` An optional string describing this resource. Will be visible in the API and the dashboard. - `email: optional string` Email of the contact. - `firstName: optional string` First name of the contact. - `forceVerifiedStatus: optional boolean` If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise. - `jobTitle: optional string` Job title of the contact. - `lastName: optional string` Last name of the contact. - `metadata: optional map[unknown]` See the section on Metadata. - `phoneNumber: optional string` Phone number of the contact. - `postalOrZip: optional string` The postal or ZIP code of the contact's address. - `provinceOrState: optional string` Province or state of the contact's address. - `skipVerification: optional boolean` If `true`, PostGrid will skip running this contact's address through our address verification system. - `string` - `to: ContactCreateWithFirstName or ContactCreateWithCompanyName or string` The recipient of this order. You can either supply the contact information inline here or provide a contact ID. PostGrid will automatically deduplicate contacts regardless of whether you provide the information inline here or call the contact creation endpoint. - `ContactCreateWithFirstName = object { addressLine1, countryCode, firstName, 13 more }` - `ContactCreateWithCompanyName = object { addressLine1, companyName, countryCode, 13 more }` - `string` - `currencyCode: optional "USD" or "CAD"` The currency code of the cheque. This will be set to the default currency of the bank account (`USD` for US bank accounts and `CAD` for Canadian bank accounts) if not provided. You can set this value to `USD` if you want to draw USD from a Canadian bank account or vice versa. - `"USD"` - `"CAD"` - `description: optional string` An optional string describing this resource. Will be visible in the API and the dashboard. - `digitalOnly: optional DigitalOnly` The digitalOnly object contains data for digital-only cheques. A watermark must be provided. - `watermark: string` Text to be displayed as a watermark on the digital cheque. - `envelope: optional "standard" or string` The envelope of the cheque. If a custom envelope ID is not specified, defaults to `standard`. - `"standard"` The envelope of the cheque. If a custom envelope ID is not specified, defaults to `standard`. - `"standard"` - `string` - `logoURL: optional string` An optional logo URL for the cheque. This will be placed next to the recipient address at the top left corner of the cheque. This needs to be a public link to an image file (e.g. a PNG or JPEG file). - `mailingClass: optional "first_class" or "standard_class" or "express" or 23 more` The mailing class of this order. If not provided, automatically set to `first_class`. - `"first_class"` - `"standard_class"` - `"express"` - `"certified"` - `"certified_return_receipt"` - `"registered"` - `"usps_first_class"` - `"usps_standard_class"` - `"usps_eddm"` - `"usps_express_2_day"` - `"usps_express_3_day"` - `"usps_first_class_certified"` - `"usps_first_class_certified_return_receipt"` - `"usps_first_class_registered"` - `"usps_express_3_day_signature_confirmation"` - `"usps_express_3_day_certified"` - `"usps_express_3_day_certified_return_receipt"` - `"ca_post_lettermail"` - `"ca_post_personalized"` - `"ca_post_neighbourhood_mail"` - `"ups_express_overnight"` - `"ups_express_2_day"` - `"ups_express_3_day"` - `"royal_mail_first_class"` - `"royal_mail_second_class"` - `"au_post_second_class"` - `memo: optional string` The memo of the cheque. - `mergeVariables: optional map[unknown]` These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template _exactly_ as they are case-sensitive. Note that these _do not_ apply to PDFs uploaded with the order. - `message: optional string` The message of the cheque. - `metadata: optional map[unknown]` See the section on Metadata. - `number: optional number` The number of the cheque. If you don't provide this, it will automatically be set to an incrementing number starting from 1 across your entire account, ensuring that every cheque has a unique number. - `redirectTo: optional ContactCreateWithFirstName or ContactCreateWithCompanyName or string` Providing this inserts a blank page at the start of the cheque with the recipient you provide here. This leaves the cheque that follows intact, which means you can use this to intercept at cheque at the redirected address and then mail it forward to the final recipient yourself. One use case for this is signing cheques at your office before mailing them out yourself. - `ContactCreateWithFirstName = object { addressLine1, countryCode, firstName, 13 more }` - `ContactCreateWithCompanyName = object { addressLine1, companyName, countryCode, 13 more }` - `string` - `sendDate: optional string` This order will transition from `ready` to `printing` on the day after this date. You can use this parameter to schedule orders for a future date. - `size: optional ChequeSize` Enum representing the supported cheque sizes. - `"us_letter"` - `"us_legal"` ### Returns - `Cheque = object { id, amount, bankAccount, 27 more }` - `id: string` A unique ID prefixed with cheque_ - `amount: number` The amount of the cheque in cents. - `bankAccount: string` The bank account (ID) associated with the cheque. - `createdAt: string` The UTC time at which this resource was created. - `currencyCode: "USD" or "CAD"` The currency code of the cheque. This can be `USD` even if drawing from a Canadian bank account and vice versa. Defaults to the currency of the bank account country if not otherwise specified. - `"USD"` - `"CAD"` - `from: Contact` The contact information of the sender. - `id: string` A unique ID prefixed with contact_ - `addressLine1: string` The first line of the contact's address. - `addressStatus: "verified" or "corrected" or "failed"` One of `verified`, `corrected`, or `failed`. - `"verified"` - `"corrected"` - `"failed"` - `countryCode: string` The ISO 3611-1 country code of the contact's address. - `createdAt: string` The UTC time at which this resource was created. - `live: boolean` `true` if this is a live mode resource else `false`. - `object: "contact"` Always `contact`. - `"contact"` - `updatedAt: string` The UTC time at which this resource was last updated. - `addressErrors: optional string` A series of human-readable errors/warnings that were raised when running the provided address through our address verification. - `addressLine2: optional string` Second line of the contact's address, if applicable. - `city: optional string` The city of the contact's address. - `companyName: optional string` Company name of the contact. - `description: optional string` An optional string describing this resource. Will be visible in the API and the dashboard. - `email: optional string` Email of the contact. - `firstName: optional string` First name of the contact. - `forceVerifiedStatus: optional boolean` If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise. - `jobTitle: optional string` Job title of the contact. - `lastName: optional string` Last name of the contact. - `metadata: optional map[unknown]` See the section on Metadata. - `phoneNumber: optional string` Phone number of the contact. - `postalOrZip: optional string` The postal or ZIP code of the contact's address. - `provinceOrState: optional string` Province or state of the contact's address. - `skipVerification: optional boolean` If `true`, PostGrid will skip running this contact's address through our address verification system. - `live: boolean` `true` if this is a live mode resource else `false`. - `mailingClass: "first_class" or "standard_class" or "express" or 23 more` The mailing class of this order. This determines the speed and cost of delivery. See `OrderMailingClass` for more details. - `"first_class"` - `"standard_class"` - `"express"` - `"certified"` - `"certified_return_receipt"` - `"registered"` - `"usps_first_class"` - `"usps_standard_class"` - `"usps_eddm"` - `"usps_express_2_day"` - `"usps_express_3_day"` - `"usps_first_class_certified"` - `"usps_first_class_certified_return_receipt"` - `"usps_first_class_registered"` - `"usps_express_3_day_signature_confirmation"` - `"usps_express_3_day_certified"` - `"usps_express_3_day_certified_return_receipt"` - `"ca_post_lettermail"` - `"ca_post_personalized"` - `"ca_post_neighbourhood_mail"` - `"ups_express_overnight"` - `"ups_express_2_day"` - `"ups_express_3_day"` - `"royal_mail_first_class"` - `"royal_mail_second_class"` - `"au_post_second_class"` - `object: "cheque"` Always `cheque`. - `"cheque"` - `sendDate: string` This order will transition from `ready` to `printing` on the day after this date. For example, if this is a date on Tuesday, the order will transition to `printing` on Wednesday at midnight eastern time. - `size: ChequeSize` Enum representing the supported cheque sizes. - `"us_letter"` - `"us_legal"` - `status: "ready" or "printing" or "processed_for_delivery" or 2 more` See `OrderStatus` for more details on the status of this order. - `"ready"` - `"printing"` - `"processed_for_delivery"` - `"completed"` - `"cancelled"` - `to: Contact` The recipient of this order. This will be provided even if you delete the underlying contact. - `updatedAt: string` The UTC time at which this resource was last updated. - `cancellation: optional object { reason, cancelledByUser, note }` The cancellation details of this order. Populated if the order has been cancelled. - `reason: "user_initiated" or "invalid_content" or "invalid_order_mailing_class"` The reason for the cancellation. - `"user_initiated"` - `"invalid_content"` - `"invalid_order_mailing_class"` - `cancelledByUser: optional string` The user ID who cancelled the order. - `note: optional string` An optional note provided by the user who cancelled the order. - `depositReadyPDFURL: optional string` A link to the deposit-ready PDF for a digital-only cheque, returned if requested and available. - `description: optional string` An optional string describing this resource. Will be visible in the API and the dashboard. - `digitalOnly: optional DigitalOnly` The digitalOnly object contains data for digital-only cheques. A watermark must be provided. - `watermark: string` Text to be displayed as a watermark on the digital cheque. - `envelope: optional "standard" or string` The envelope of the cheque. If a custom envelope ID is not specified, defaults to `standard`. - `"standard"` The envelope of the cheque. If a custom envelope ID is not specified, defaults to `standard`. - `"standard"` - `string` - `imbDate: optional string` The last date that the IMB status was updated. See `imbStatus` for more details. - `imbStatus: optional "entered_mail_stream" or "out_for_delivery" or "returned_to_sender"` The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders. - `"entered_mail_stream"` - `"out_for_delivery"` - `"returned_to_sender"` - `imbZIPCode: optional string` The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an `imbStatus` is present. - `logoURL: optional string` An optional logo URL for the cheque. This will be placed next to the recipient address at the top left corner of the cheque. This needs to be a public link to an image file (e.g. a PNG or JPEG file). - `memo: optional string` The memo of the cheque. - `mergeVariables: optional map[unknown]` These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template _exactly_ as they are case-sensitive. Note that these _do not_ apply to PDFs uploaded with the order. - `message: optional string` The message of the cheque. - `metadata: optional map[unknown]` See the section on Metadata. - `number: optional number` The number of the cheque. If you don't provide this, it will automatically be set to an incrementing number starting from 1 across your entire account, ensuring that every cheque has a unique number. - `trackingNumber: optional string` The tracking number of this order. Populated after an express/certified order has been processed for delivery. - `url: optional string` PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all `GET` endpoints which produce this order. This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the `GET` endpoint again. ### Example ```http curl https://api.postgrid.com/print-mail/v1/cheques \ -H 'Content-Type: application/json' \ -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY" \ -d '{ "amount": 1000, "bankAccount": "bank_123", "from": "contact_123", "to": "contact_123" }' ``` #### Response ```json { "id": "cheque_123456", "object": "cheque", "status": "ready", "live": false, "to": { "id": "contact_pxd7wnnD1xY6H6etKNvjb4", "object": "contact", "live": false, "companyName": "PostGrid", "addressLine1": "90 CANAL ST STE 600", "city": "BOSTON", "provinceOrState": "MA", "postalOrZip": "90210-1234", "countryCode": "US", "skipVerification": false, "forceVerifiedStatus": false, "addressStatus": "verified", "createdAt": "2022-02-16T15:08:41.052Z", "updatedAt": "2022-02-16T15:08:41.052Z" }, "from": { "id": "contact_pxd7wnnD1xY6H6etKNvjb4", "object": "contact", "live": false, "companyName": "PostGrid", "addressLine1": "90 CANAL ST STE 600", "city": "BOSTON", "provinceOrState": "MA", "postalOrZip": "90210-1234", "countryCode": "US", "skipVerification": false, "forceVerifiedStatus": false, "addressStatus": "verified", "createdAt": "2022-02-16T15:08:41.052Z", "updatedAt": "2022-02-16T15:08:41.052Z" }, "bankAccount": "bank_123", "amount": 1000, "currencyCode": "USD", "number": 123456, "size": "us_letter", "sendDate": "2020-11-12T23:23:47.974Z", "createdAt": "2020-11-12T23:23:47.974Z", "updatedAt": "2020-11-12T23:23:47.974Z", "mailingClass": "first_class" } ```