v1

latestOpenAPI 3.0.02026-07-14106203730.9 KB

Cheques

Create Cheque

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:

{
  "from": "contact_123",
  "bankAccount": "bank_123",
  "amount": 1000,
  "currencyCode": "USD",
  "number": 123456,
  "size": "us_letter",
  "digitalOnly": {
    "watermark": "VOID"
  }
}

post/print-mail/v1/cheques

Request body

mergeVariablesobject

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.

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

sendDatestring date-time

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.

bankAccountstring required

The bank account (ID) associated with the cheque.

amountinteger required

The amount of the cheque in cents.

memostring

The memo of the cheque.

messagestring

The message of the cheque.

logoURLstring uri

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).

numberinteger

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.

size'us_letter' | 'us_legal'

Enum representing the supported cheque sizes.

Response

the created Cheque.

status'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled' required

mergeVariablesobject

trackingNumberstring

The tracking number of this order. Populated after an express/certified order has been processed for delivery.

imbStatus'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender'

imbZIPCodestring

The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.

imbDatestring date-time

The last date that the IMB status was updated. See imbStatus for more details.

urlstring uri

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.

idstring required

A unique ID prefixed with cheque_

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.

sendDatestring date-time required

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.

object'cheque' required

Always cheque.