Sign in
OpenAPI 3.1.02026-08-122324681.8 MB

34b7cf5b4b6c

Paper Checks

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:

  1. The order of checks in the PDF
  2. 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 checks
  • printed_checks: List showing each check ID and its assigned check number
  • total_printed: Count of checks printed
put/public/v2/paper-checks/print-batch/

Headers

Idempotency-Keystring

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.

Request body

paper_check_idsinteger[] 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.

first_check_numberinteger nullable

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

template_idinteger nullable

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

Example request

{
  "paper_check_ids": [
    101,
    102,
    103
  ],
  "first_check_number": 10001,
  "template_id": 1
}

Response

OK

pdf_contentstring required

Base64-encoded PDF content containing all printed checks

total_printedinteger required

Total number of checks printed in this batch

Example response

{
  "printed_checks": [
    {
      "paper_check_id": 12345,
      "check_number": "10542"
    }
  ],
  "total_printed": 5
}