Cheques

Get Cheque Preview

Changed on

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

Request

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

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

  • c8fedcbd705eRevision changes
    • warning

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

    • warning

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

    • warning

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

    • info

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

    • info

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