API Reference

Print Mail

Cheques

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Cheque Preview

print_mail.cheques.retrieve_url(strid) -> ChequeRetrieveURLResponse

GET/print-mail/v1/cheques/{id}/url

Retrieve a cheque preview URL.

This is only available for customers with our document management addon, which offers document generation and hosting capabilities. This endpoint has a much higher rate limit than the regular order retrieval endpoint, so it is suitable for customer-facing use-cases.

ParametersExpand Collapse

id: str

ReturnsExpand Collapse

class ChequeRetrieveURLResponse: …

id: str

A unique ID prefixed with cheque_

object: str

url: str

A signed URL linking to the order preview PDF. The link remains valid for 15 minutes from the time of the API call.

formaturi

Get Cheque Preview

Python

HTTP

TypeScript

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
)
response = client.print_mail.cheques.retrieve_url(
    "id",
)
print(response.id)

200 example

{
  "id": "cheque_123456",
  "object": "cheque_url",
  "url": "https://pg-prod-bucket-1.s3.amazonaws.com/test/cheque_uzTtdAPiBVC25hjEYDvyLk?AWSAccessKeyId=AKIA5GFUILSULWTWCR64&Expires=1736192587&Signature=GS6kJK3fgWWy49jq1Yb%2FRn%2BQjD4%3D"
}

Returns Examples

200 example

{
  "id": "cheque_123456",
  "object": "cheque_url",
  "url": "https://pg-prod-bucket-1.s3.amazonaws.com/test/cheque_uzTtdAPiBVC25hjEYDvyLk?AWSAccessKeyId=AKIA5GFUILSULWTWCR64&Expires=1736192587&Signature=GS6kJK3fgWWy49jq1Yb%2FRn%2BQjD4%3D"
}