Skip to main content
PUT
Batch print paper checks

Authorizations

X-API-KEY
string
header
required

Body

application/json

Request body for batch printing queued checks.

Use this endpoint to print multiple queued checks at once. Check numbers will be assigned sequentially starting from first_check_number.

paper_check_ids
integer[]
required

List of paper check IDs to print. Checks must have status 'not_printed'. The order of IDs determines the order of checks in the PDF and check number assignment.

Example:
first_check_number
integer | null

Starting check number for this batch. If None, auto-assigns from bank account sequence. Subsequent checks will be numbered sequentially.

Required range: x >= 1
Example:

10001

template_id
integer | null

Optional ID of a PaperCheckTemplate to use for formatting. If not provided, the default template will be used.

Example:

1

Response

OK

Schema for batch print response.

Contains the merged PDF with all checks and metadata about each printed check.

pdf_content
string
required

Base64-encoded PDF content containing all printed checks

printed_checks
PublicPrintBatchResponseItem · object[]
required

List of checks that were printed with their assigned check numbers

total_printed
integer
required

Total number of checks printed in this batch

Example:

5

Last modified on July 13, 2026