Cheques

Cancel Cheque With Note

Changed on

Cancel a cheque by ID with a note. Note that this operation cannot be undone and that only cheques with a status of ready can be cancelled.

post/print-mail/v1/cheques/{id}/cancellation

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/cheques/{id}/cancellation
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

The ID of the cheque you want to cancel.

Request body

notestring required

Response

The cancelled cheque

status'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled' required
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.

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.

mailingClass'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' required
object'cheque' required

Always cheque.

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.

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

letterHTMLstring

The raw HTML content for a letter attached to the cheque, if any. You can supply either this, letterTemplate, or letterPDF, but not more than one.

letterTemplatestring

A Template ID for the letter attached to the cheque, if any.

returnEnvelopestring

The return envelope (ID) sent out with the cheque, if any. Note that you must first order return envelopes using the Return Envelopes API.

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' required

Enum representing the supported cheque sizes.

depositReadyPDFURLstring uri

A link to the deposit-ready PDF for a digital-only cheque, returned if requested and available.

letterUploadedPDFstring uri

A signed URL pointing to the original PDF of the letter attached to the cheque, if any.

Changes

  • 54cf11f8a76fRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property ///// to the response with the status

  • c8fedcbd705eRevision changes
    • info

      endpoint added