Get Check PDF | Mercoa | Documentation

Get a PDF of the check for the invoice. If the invoice does not have check as the disbursement method, an error will be returned. If the disbursement option for the check is set to 'MAIL', a void copy of the check will be returned. If the disbursement option for the check is set to 'PRINT', a printable check will be returned. If the invoice is NOT marked as PAID, the check will be a void copy.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

invoiceIdstringRequired

Invoice ID or Invoice ForeignID

Response

Link to the PDF file. Will expire after 1 hour.

mimeTypestring

typeenum

uristring

idstring

ID of the document. If not provided, this is a dynamic document that is generated on the fly.

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented

Bearer authentication of the form Bearer <token>, where token is your auth token.

Invoice ID or Invoice ForeignID

Link to the PDF file. Will expire after 1 hour.

ID of the document. If not provided, this is a dynamic document that is generated on the fly.

$	curl https://api.mercoa.com/invoice/in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9/check/generate \
>	-H "Authorization: Bearer <token>"

1	{
2	"mimeType": "application/pdf",
3	"type": "CHECK",
4	"uri": "https://mercoa.com/pdf/not-real.pdf"
5	}