## Retrieve Cheque Deposit-Ready PDF (Digital Only) `print_mail.cheques.retrieve_with_deposit_ready_pdf(strid) -> Cheque` **get** `/print-mail/v1/cheques/{id}/with_deposit_ready_pdf` Retrieve the deposit-ready PDF for a digital-only cheque. The endpoint can only be called by users with 'Admin' role. In test mode, the preview PDF of the digitalOnly cheque and the deposit-ready PDF are the same. In live mode, the deposit-ready will have the full account number. ### Parameters - `id: str` ### Returns - `class Cheque: …` - `id: str` A unique ID prefixed with cheque_ - `amount: int` The amount of the cheque in cents. - `bank_account: str` The bank account (ID) associated with the cheque. - `created_at: datetime` The UTC time at which this resource was created. - `currency_code: Literal["USD", "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: str` A unique ID prefixed with contact_ - `address_line1: str` The first line of the contact's address. - `address_status: Literal["verified", "corrected", "failed"]` One of `verified`, `corrected`, or `failed`. - `"verified"` - `"corrected"` - `"failed"` - `country_code: str` The ISO 3611-1 country code of the contact's address. - `created_at: datetime` The UTC time at which this resource was created. - `live: bool` `true` if this is a live mode resource else `false`. - `object: Literal["contact"]` Always `contact`. - `"contact"` - `updated_at: datetime` The UTC time at which this resource was last updated. - `address_errors: Optional[str]` A series of human-readable errors/warnings that were raised when running the provided address through our address verification. - `address_line2: Optional[str]` Second line of the contact's address, if applicable. - `city: Optional[str]` The city of the contact's address. - `company_name: Optional[str]` Company name of the contact. - `description: Optional[str]` An optional string describing this resource. Will be visible in the API and the dashboard. - `email: Optional[str]` Email of the contact. - `first_name: Optional[str]` First name of the contact. - `force_verified_status: Optional[bool]` If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise. - `job_title: Optional[str]` Job title of the contact. - `last_name: Optional[str]` Last name of the contact. - `metadata: Optional[Dict[str, object]]` See the section on Metadata. - `phone_number: Optional[str]` Phone number of the contact. - `postal_or_zip: Optional[str]` The postal or ZIP code of the contact's address. - `province_or_state: Optional[str]` Province or state of the contact's address. - `skip_verification: Optional[bool]` If `true`, PostGrid will skip running this contact's address through our address verification system. - `live: bool` `true` if this is a live mode resource else `false`. - `mailing_class: Literal["first_class", "standard_class", "express", 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: Literal["cheque"]` Always `cheque`. - `"cheque"` - `send_date: datetime` 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: Literal["ready", "printing", "processed_for_delivery", 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. - `updated_at: datetime` The UTC time at which this resource was last updated. - `cancellation: Optional[Cancellation]` The cancellation details of this order. Populated if the order has been cancelled. - `reason: Literal["user_initiated", "invalid_content", "invalid_order_mailing_class"]` The reason for the cancellation. - `"user_initiated"` - `"invalid_content"` - `"invalid_order_mailing_class"` - `cancelled_by_user: Optional[str]` The user ID who cancelled the order. - `note: Optional[str]` An optional note provided by the user who cancelled the order. - `deposit_ready_pdfurl: Optional[str]` A link to the deposit-ready PDF for a digital-only cheque, returned if requested and available. - `description: Optional[str]` An optional string describing this resource. Will be visible in the API and the dashboard. - `digital_only: Optional[DigitalOnly]` The digitalOnly object contains data for digital-only cheques. A watermark must be provided. - `watermark: str` Text to be displayed as a watermark on the digital cheque. - `envelope: Optional[Union[Literal["standard"], str, null]]` The envelope of the cheque. If a custom envelope ID is not specified, defaults to `standard`. - `Literal["standard"]` The envelope of the cheque. If a custom envelope ID is not specified, defaults to `standard`. - `"standard"` - `str` - `imb_date: Optional[datetime]` The last date that the IMB status was updated. See `imbStatus` for more details. - `imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "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"` - `imb_zip_code: Optional[str]` The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an `imbStatus` is present. - `logo_url: Optional[str]` 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[str]` The memo of the cheque. - `merge_variables: Optional[Dict[str, object]]` 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[str]` The message of the cheque. - `metadata: Optional[Dict[str, object]]` See the section on Metadata. - `number: Optional[int]` 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. - `tracking_number: Optional[str]` The tracking number of this order. Populated after an express/certified order has been processed for delivery. - `url: Optional[str]` 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 ```python import os from postgrid import PostGrid client = PostGrid( print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"), # This is the default and can be omitted ) cheque = client.print_mail.cheques.retrieve_with_deposit_ready_pdf( "id", ) print(cheque.id) ``` #### 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", "digitalOnly": { "watermark": "TEST" }, "depositReadyPDFURL": "https://example.s3.amazonaws.com/deposit_ready.pdf" } ```