Print Partner API

You can now integrate Checkeeper's check fulfillment capabilities into your own web and desktop applications with an easy to use API from Checkeeper! Accept payment from customers faster, simplify accounting tasks for staff, or simply offer your own white-labeled check fulfillment service.

Request API Tokens

How it works

With the Checkeeper authorized partner API you can submit checks 24 hours a day directly to the Checkeeper print server. As soon as your data is submitted, its processed and queued for high-quality industrial grade printing.

Getting started

You must obtain a Checkeeper auth token first to begin using the Checkeeper check fulfillment API. With this, you can create new check fulfillment orders, as well as request the status of fulfillment orders.

Creating a check

To have a new check printed by Checkeeper, create a new check order by making a POST request of the outlined JSON object. A JSON object will be returned with either an error, or a check_id string if successful.

Field Required Description
token req API auth token string provided by Checkeeper.
test opt Set to 1 (one) if this is a test transaction. It WILL NOT be printed. Defaults to 0 (zero)
payer req The entity writing the check
-name req Name or business of entity writing the checks
-address
 --line1 req Street address line 1 of entity writing the check
 --line2 opt Street address line 2 of entity writing the check
-city req U.S. city of entity writing the check
-state req U.S. State of entity writing the check
-zip req 5-digit U.S. zip code
-signer req Name to appear on 'authorized signature' line
payee req The entity receiving the check
-name req Name or business of entity receiving the checks
-address
 --line1 req Street address line 1 of entity writing the check
 --line2 opt Street address line 2 of entity writing the check
-city req U.S. Citty of entity receiving the checks
-state req U.S. State of entity receiving the checks
-zip req 5-digit U.S. zip code of entity receiving the checks
amount req Numeric value of check. No currency signs.
date opt If no date is set, the current date will be used.
memo opt Optional memo message for the check.
note opt Optional note for the check. Will be truncated at 200 characters.
check_number req Number used for check.
bank_routing req 9-digit ABA routing number.
bank_account req bank account number associated with routing number
return_pdf opt TRUE for a pdf of the check to be returned. Defaults to False to have the check fulfilled through checkeeper.

 

Check check status

Want to know the whereabouts of a check just submitted to Checkeeper? Make a GET request with your check_id and you shall have the answer you seek.

GET- https://my.checkeeper.com/api/status/{check_id}

pending   Check has been received, and is in the print queue.
printed   Check has been printed, and is waiting to be enveloped.
mailed   Check has been stuffed and stamped and given to mail currier.

Example JSON post

POST- https://my.checkeeper.com/api/create/

{
"token" : "lpa87H2js1AOphfHwqwrzNvc62M90bw",
"test" : 1, "payer" : {
"name" : "Widgets Inc.",
"address" : {
"line1" : "827 Random Street",
"line2" : "Suite 102",
},
"city" : "Anytown",
"state" : "N.Y.",
"zip" : "14850",
"signer" : "John Hancock"
},
"payee" {
"name" : "Bob's Supplies",
"address" : {
"line1" : "114 Project Lane",
"line2" : "Apartment 107",
},
"city" : "Tinkertown",
"state" : "CA",
"zip" : "90210"
},
"amount" : "5,320.00",
"date" : "06/14/2013",
"memo" : "Widget supply order",
"note" : "15 hours",
"check_number" : "372",
"bank_routing" : "012345678",
"bank_account" : "938763720122",
"return_pdf": true
}

Response

{
  "check_id"	: "nGPfLI3GCv2awYC0QShK",
"pdf" : "...[base64 encoded pdf]..." }