API Check Writing, Document Printing, and Mailings
Developers Welcome to the developer documentation for the The Check Issuing Company API.
API Documentation The Checkissuing Company API allows you to securely import data directly into our systems for processing. To use the API, please contact us to sign up for an account. Once you’ve received an API key, you can begin implementation by following the instructions in this documentation.
API functions include:
- Easy Payment Upload
- Easy Account Management and Uploads
- File Mapping Assistance
- Conversion of File Applications
- Input Postage Codes for your Mailing Options per Payment
The Check Issuing API was developed to assist you with integrating your back-office systems with the Check Issuing system. It allows you to notify us of deposits, submit payments for processing, and to look up your payments, deposits, and general account information. The API is utilized by doing standard HTTPS POST requests. It returns XML formatted results.
Live system requests go via https://api.checkissuing.com/
To use our sand box system for integration testing, please use https://apisb.checkissuing.com/ (please contact support for help setting this up if you require it and have not already been granted access)
Before you can begin using the API, you must obtain your user account parameters, Client ID and API Key. To obtain these values, take these steps:
- 1. Log into your primary Check Issuing user account within the client panel.
- 2. Go to the your Account page (top right).
- 3. Navigate to the API Access page (top right). Here you will find both your Client ID and API Key. The API Key must be kept secure and confidential. If the account password is changed, the API key will also be changed and will need to be updated within your application to ensure continued access.
Failure to authenticate will produce the following response from the system:
The API system will respond using standard XML format. This will vary depending on the outcome of the action taken.
Our standard response format will be contained within a wmc-response parent item, with a status attribute to indicate whether your request was successful, with status 1 being success, and status 0 indicating there was an error during your request under most circumstances. This parent item may also contain a file id attribute applicable to Payment File’s uploaded.
As an example success response, please see below:
In most scenarios dates will be formatted using UNIX stamp format.
Payments can have the following statuses (status ID – status name):
- 1 – Pending Release
- 2 – Released
- 3 – Processing
- 4 – Sent Out
- 5 – Posted / Cashed
- 6 – Returned
- 7 – Cancelled
- 8 – Reissued
- 9 – WMC Reissued
- 10 – Expired
Postgage Codes can have the following values (code – postage type):
- 1 – USPS First Class
- 2 – USPS Priority
- 3 – USPS Priority + Delivery Confirmation
- 4 – USPS Priority + Signature Confirmation
- 5 – Two Day Courier Service with FedEx or DHL
- 6 – One Day Courier Service with FedEx or DHL
When the API system responds with a status code of 0, usually you will be given a set of error messages to accompany this.
Error messages will be contained within error elements, as children to the wmc-response parent item. There can be one, or multiple.
As an example error response, please see below:
To view our full API Documentation, Click Here.