Get a paper check

Returns a paper check for the specified payroll item.

Use an Accept: application/pdf request header to download the paper check as a PDF document.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Paper checks are printed on the top one-third of the page with the bottom two-thirds reserved for the paystub.

Optionally pass a payment_id query parameter (pyt_…) to scope the printed check amount to a single net-pay-split payment instead of the full net pay. This is useful when reissuing one failed direct deposit as a paper check. The paystub portion of the PDF still shows the full earnings statement. The payment_id values are available on paystub responses under net_pay_split.splits[].payment_id.

Check supports the DLT159 check format. This format is the check-on-top custom check stock format and can be ordered online from Deluxe here. You may see ‘DLT 159’ listed in other websites as “Laser Top Check, Multi-Purpose 7.5 Voucher” checkstock, but be sure to match the design directly as it will impact the print alignment. Paper checks have residence address of the payee printed on them and are designed to fit in #9 Double Windowed Envelopes, which can be ordered here.

Note that you can also associate the payroll item for your printed checks with their paper check number using the update a payroll item API.

Path Params
string
required

ID of the payroll item to return

Query Params
string

Optional ID of a single net-pay-split payment (pyt_…). When provided, the check amount is scoped to just that split's payment (e.g. to reissue one failed direct deposit) instead of the full net pay. Rejected unless that payment can be reissued (e.g. it already paid, is still in flight, or was reversed).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain