v1
latestOpenAPI 3.1.02026-07-241642423.7 KBGet 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.
get/payroll_items/{payroll_item}/paper_check
Path parameters
payroll_itemstring required
ID of the payroll item to return
Query parameters
payment_idstring
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
Acceptstring
application/pdf
Response
202
Example response
{
"url": "string"
}