Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Ping All

Enterprise SOAP API > API by Reference > Customer Relationship Management > Ping All

PingAll

PingAll is a jXchange service designed to allow a consumer to take advantage of functionality related to the specific release installed at a Financial Institution (FI) site.

Message Flow

In jXchange, the PingAll service uses a typical exchange of MType messages to provide consumers the ability to take advantage of functionality related to the specific release installed at an FI.

Primary Request

The consumer forwards the PingAllRq_MType message to the service provider. The message contains the following simple element:

  • IncNonProdEnv
  • InstRtId
  • PingRq
  • PrvdFamName
  • SvcPrvdName

Primary Response

The service provider returns the PingAllRs_MType message to the consumer. The message contains PingAllArray_AType.

Ping All Behavior

The Ping All service behavior is as follows.

PingAll is an aggregate service, meaning that users can submit a single request to receive an array of all providers supported via jX at the specified financial institution.

The PingAll message response returns the Service Provider Version for each of the providers.

PingAllRq_MType

PingAllRq_MType is a message MType element.

This is a common ping request to all service providers for checking, testing, and keeping alive.

Simple Elements

The following simple elements are contained within this message.

IncNonProdEnv
Answers the question: should financial institutions' non-production environments be included in the response? Canonical values are:
  • True
  • False
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

PingRq
Generic text for the ping request.
PrvdFamName
The category or group that the event owner is associated with. Canonical values are:
  • Card Services
  • CkImg
  • Core
  • CrCardServices
  • DocImg
  • Fraud
  • HumanCapMgmt
  • JES
  • OLB
  • PltFm
  • TellerSys
  • Wires
  • VR
SvcPrvdName
The message service providers. Canonical values are:
  • 4Sight
  • AlrtCenter
  • Argo
  • BrdCst
  • CIF2020
  • CoreDir
  • Cruise
  • DirectLineIntlWires
  • DirectLineWires
  • EL
  • ENS
  • EPS
  • EWF
  • iPay
  • iTalk
  • jXchange
  • MFA
  • NetTeller
  • ODI
  • OnBoardDep
  • OnBoardLn
  • Passport
  • PmtProcSols
  • Silhouette
  • SilverLake
  • Synapsys
  • Synergy
  • TimeTrack
  • TP_FISTBS
  • TP_IMM
  • Vertex

PingAllRs_MType

PingAllRs_MType is a message MType element.

This is a common ping response to all service providers which echoes back the string sent in the PingAllRq_MType.

Contains:

  • PingAllArray_AType

PingAllArray_AType

PingAllArray_AType is an array AType element. This is an array of ping responses from service providers.

Contains:

  • PingAllInfoRec_CType
PingAllInfoRec_CType

PingAllInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

FinInstName
The depository financial institution name.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

PingRs
String echoed back from the PingRq. The element value contains Error when the PingRq to a service provider is not successful. Canonical values are:
  • Error
PrvdFamName
The category or group that the event owner is associated with. Canonical values are:
  • Card Services
  • CkImg
  • Core
  • CrCardServices
  • DocImg
  • Fraud
  • HumanCapMgmt
  • JES
  • OLB
  • PltFm
  • TellerSys
  • Wires
  • VR
SvcProdVer
The product version structure is representative of major version, minor version, and build number. The service provider version must be populated with a standard format: YYYY.Point_Release.Coompatibility_Patch

An example of a service provider version: 2016.01.07.

SvcPrvdName
The message service providers. Canonical values are:
  • 4Sight
  • AlrtCenter
  • Argo
  • BrdCst
  • CIF2020
  • CoreDir
  • Cruise
  • DirectLineIntlWires
  • DirectLineWires
  • EL
  • ENS
  • EPS
  • EWF
  • iPay
  • iTalk
  • jXchange
  • MFA
  • NetTeller
  • ODI
  • OnBoardDep
  • OnBoardLn
  • Passport
  • PmtProcSols
  • Silhouette
  • SilverLake
  • Synapsys
  • Synergy
  • TimeTrack
  • TP_FISTBS
  • TP_IMM
  • Vertex
Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Tue Jan 25 2022