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

jXchangeHdr Information

Enterprise SOAP API > Getting Started > jXchange Environment > jXchangeHdr Information

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element. It is required for all messages except for Ping.

Simple Elements

JxVer

This is an optional element. Service Gateway populates it with the installed version of the framework whether the consumer includes it on the request or not. It is included on the request to the provider and should be echoed back to the consumer.

AuditUsrId

This is a required element. The provider may or may not use this value for auditing but will be echoed back to the consumer.

AuditWsId

This is a required element. This value may or may not be used by the provider for auditing but will be echoed back to the consumer.

AuthenUsrId

This is an optional element, which is deprecated and replaced with AuthenUsrCred in the MsgRqHdr.

This element depreciates in three years in accordance with XSD contract tenets. The effective date is 01–01–2012. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication usercredential complex element in accordance with the standards established by WS-Security.

ConsumerName

This is an optional element. This value may or may not be used by the provider but will be echoed back to the consumer.

Ver_1

This is an element that conveys the version of the type. It is required if any element below it is present.

jXLogTrackingId

This is an optional element; if no value is included on the request from the consumer, then Service Gateway will populate with a GUID, and this value will be echoed back to the consumer.

Ver_2

See Ver_1.

InstRtld

This is an optional element. If a value is included on the request, Service Gateway will use it as part of the authentication process. If it is not included, Service Gateway will attempt to use the default institution for the user credentials specified; the value will be echoed back to the consumer.

InstEnv

This is an optional element. If a value is included on the request, Service Gateway will use it as part of the authentication process. If it is not included, Service Gateway will attempt to use the default environment for the user credentials specified for the specified InstRtId. The value will be echoed back to the consumer. Authentication will fail if the environment is sent in but the InstRtId is not

Ver_3

See Ver_1.

BusCorrelId

This is an optional element; if a value is not included on the request, Service Gateway will populate with a GUID; Service Gateway will return to the consumer the value returned from the provider which may or may not be the same value the consumer specified.

Ver_4

See Ver_1.

WorkflowCorrelld

This is an optional element that is used by the Workflow application. The value returned by Service Gateway to the consumer will be the value returned by Workflow, which may or may not be the same value the consumer specified.

ValidConsmName (Security Requirement)

The consumer name that is assigned by the Product Adoption group. This value will be used for all integration endpoints.

ValidConsmProd (Security Requirement)

The consumer product that is associated with the consumer name and is assigned by the Product Adoption group. This value will be used for all integration endpoints.

Ver_5

See Ver_1.

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 Thu Jul 14 2022