v1

latestOpenAPI 3.0.02026-07-14106203730.9 KB

Cheques

Get Cheque Preview

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.

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

Path parameters

idstring required

The ID of the cheque to retrieve the preview URL for.

Response

the Cheque Preview URL.

idstring required

A unique ID prefixed with cheque_

objectstring required

urlstring uri required

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