GETTING STARTED

Response Format

The API supports JSON and XML responses. Contact support to enable JSON for your account. Accounts that have not enabled JSON use XML.

Most response dates use Unix timestamps. Request date filters use the format specified by each endpoint. Check the endpoint parameters and examples before converting date values.

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

Documents can have the following statuses (status ID - status name):

  • 1 - Pending Release
  • 2 - Released
  • 3 - Processing
  • 4 - Sent Out
  • 5 - Returned
  • 6 - Rejected

Postage 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 - FedEx Express 2 Day
  • 6 - FedEx Express Overnight
  • 8 - USPS Overnight
  • 9 - USPS Certified Mail
  • 10 - FedEx Priority Overnight

XML response

XML responses use a wmc-response root element. Its status attribute is 1 for success or 0 for an error. Upload responses may also include a fileid attribute identifying the uploaded file. Review the endpoint examples for its complete response structure.

A successful XML response has the following structure:

XMLResponse example
<wmc-response status="1">
	...
</wmc-response>

Search documentation