Batch print paper checks
Print multiple queued paper checks in a batch.
This endpoint prints all specified checks, assigns sequential check numbers, and returns a merged PDF containing all checks.
Prerequisites:
- All specified checks must have status ‘not_printed’
- Use
POST /print-later/to queue checks first
Check number assignment:
Check numbers are assigned sequentially starting from first_check_number.
The order of paper_check_ids in the request determines:
- The order of checks in the PDF
- The order of check number assignment
Example:
If first_check_number=1001 and you print 3 checks, they will be numbered 1001, 1002, 1003.
Returns:
pdf_content: Base64-encoded PDF with all checksprinted_checks: List showing each check ID and its assigned check numbertotal_printed: Count of checks printed
Authorizations
Headers
Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.
255Body
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.
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.
Starting check number for this batch. If None, auto-assigns from bank account sequence. Subsequent checks will be numbered sequentially.
x >= 110001
Optional ID of a PaperCheckTemplate to use for formatting. If not provided, the default template will be used.
1
Response
OK
Schema for batch print response.
Contains the merged PDF with all checks and metadata about each printed check.