v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Get a paper check

Returns a paper check for the specified contractor payment.

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

get/contractor_payments/{contractor_payment}/paper_check

Path parameters

contractor_paymentstring required

ID of the contractor payment 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

urlstring

Example response

{
  "url": "string"
}