API By Provider/Reference

The API by Provider and API by Reference pages present the same API information, organized differently to suit various user needs:

• API by Provider: Lists providers that use jXchange-SOAP APIs, along with the specific APIs each provider supports.
• API by Reference: Organizes APIs by banking-related services, showing which APIs are used for each service.

Navigating API Listings

When you select an API (e.g., AcctAdd), you’ll gain access to several sub-reference pages:

Message Brief (MB)

The MB page is the landing page for each API. It provides generalized information about the API and describes each element defined in the API’s contract.

Key points about message briefs:

• MBs are written at the contract level and are provider agnostic.
• Providers may choose not to implement every field in a contract, so some fields listed in the MB may not be available from all providers.
• MBs may include optional behavioral details about the API.
• Some default values are only documented in the MB.

Developer Resources

Each API includes a Developer Resources page offering technical guidance and examples. These typically include:

• Technical Details Chart:
  • SOAPAction
  • Input Name / Output Name
  • Input Namespace
  • XSD Group Name
  • XSD Container
• XML Examples
• FAQ
• (Optional) Additional tips or context for using the API effectively

Providers

This page lists all Jack Henry providers that support the selected API.

Banking Core Providers Mappings and Errors

For core banking systems (Core Director, CIF 20/20, SilverLake), additional mapping and error documentation is available:

• Mappings Page: Shows all elements used by the core for the selected API.
• Errors Page: Lists potential validation errors, faults, or warnings that may occur during API usage.
  • The listed errors for an API may not be a comprehensive list.
  • Information on managing the various ErrCat array responses may be found on our jXchange Error Handling page.