Sign in
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.

Changes

Changed in 1 of the 7 revisions of this API.32

  • c8fedcbd705e32See the full diff
    • ●

      added the new internal_server_error enum value to the error/type response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new not_found_error enum value to the error/type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new rate_limit_exceeded_error enum value to the error/type response property for the response status 429

      response-property-enum-value-added

    • ○

      added subschema #1 subschema #2 to the response body anyOf list for the response status 401

      response-body-any-of-added

    • ○

      removed subschema #1 subschema #2 from the response body anyOf list for the response status 401

      response-body-any-of-removed

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog