Health Check
Tutorials
>
Health Check
I would like to perform a health check to verify that jXchange is operational.
Ping API Overview
You may notice the Ping API in the XSD/WSDL and consider implementing it. However, the Ping API is a legacy API that relies on a default configuration applied within jXchange.
Limitations:
- Ping only confirms that the jXchange instance is online.
- It does not provide status information for service providers or cores.
- It does not indicate whether a specific provider (e.g., Silverlake) is available for a given FI.
Recommended Approach
Similar health‑check behavior can be achieved using Search or Inquiry‑type APIs, which do not rely on default configurations and provide more meaningful results.
For example:
- To verify that Silverlake is online for a specific FI, a vendor can invoke a search‑type API such as CustSrch.
- A successful response confirms that both jXchange and the underlying core provider are responding for that FI.
This approach offers a more reliable validation of end‑to‑end availability than the Ping API.
Have a Question?
- Have a how-to question? Seeing a weird error? Get help on StackOverflow.
- Register for the Developer Office Hours where we answer technical Q&A from the audience.
Did this page help you?
Last updated Fri Feb 6 2026