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

Wire Company Inquiry

Enterprise SOAP API > API by Reference > Core Services > Wire Company Inquiry

Wire Company Inquiry

Wire Company Inquiry is a jXchange service designed to allow a consumer to inquire on the variables related to a company authorized to create wires as part of a financial institution suite of wire services.

Message Flow

In jXchange, the Wire Company Inquiry service uses a typical exchange of MType messages to allow a consumer to inquire on the variables related to a company authorized to create wires as part of a financial institution suite of wire services.

Primary Request

The consumer forwards the WireCompInqRq_MType message to the service provider.

The message contains the following simple elements:

  • WireCompId
  • WireCompType

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType

The message contains the following array:

  • IncXtendElem_AType

Primary Response

The service provider returns the WireCompInqRs_MType message to the consumer.

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType
  • WireCompInqRec_CType

Wire Company Inquiry Behavior

The Wire Company Inquiry (WireCompInq) service behavior is as follows.

The request requires a valid Wire Company Identification element (WireCompId) to be submitted.

The elements the Wire Company Information Record complex (WireCompInfoRec_CType) contains include the elements that convey the financial institution's wire behavioral aspects.

The Wire Company Information Record complex (WireCompInfoRec_CType) contains the account identifications (WireAcctIdArray_AType) and the company employees (WireEmpArray_AType) assigned to the wire company.

The Wire Account Identification Record complex (WireAcctIdRec_CType) contains the wire company employees (WireAcctIdEmpArray_AType), which conveys the employee's permissions as related to the account identification.

The standard Inquiry message tenets are applicable.

Adhere to the tenets related to Fault and Warnings conveyed in the message as related to business faults.

Adhere to the tenets related to Backwards Compatibility.

WireCompInqRq_MType

WireCompInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • IncXtendElem_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

WireCompId
The company identification for wire created transactions.
WireCompType
The type of wire company. Canonical values are:
  • Domst
  • Intl

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IncXtendElemArray_AType

IncXtendElemArray_AType is an array AType element. This is an array that lists x_ elements by name, which are to be included in the response.

Contains:

  • IncXtendElemInfo_CType
IncXtendElemInfo_CType

IncXtendElemInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

XtendElem
Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType
Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. 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 user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
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.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. 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 user credential complex element in accordance with the standards established by WS-Security.

WireCompInqRs_MType

WireCompInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • WireCompInqRec_CType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType
jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. 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 user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
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.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. 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 user credential complex element in accordance with the standards established by WS-Security.

MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.

WireCompInqRec_CType

WireCompInqRec_CType is a complex CType element.

Contains:

  • WireCompInfoRec_CType
Simple Elements

The following simple elements are contained within this complex.

AvlBalCalcDesc
A description of the code that would convey to the service provider the method to use for the calculation of the available balance.
WireCompId
The company identification for wire created transactions.
WireCompInfoRec_CType

WireCompInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • WireAcctIdArray_AType
Simple Elements

The following simple elements are contained within this complex.

CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
WireBalType

What type of account balance should be used for wire acceptance? Canonical values are:

  • Avl
  • Col
  • Ldgr
WireCompName
The name of the company approved for wire activity.
WireCompType
The type of wire company. Canonical values are:
  • Domst
  • Intl
WireOutgoingDlyLmtAmt
The amount limitations placed on outgoing wires per day.
WireOutgoingLmtAmt
The amount limitation placed on outgoing wires.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

WireAcctIdArray_AType

WireAcctIdArray_AType is an array AType element. This is an array of account identifications permissible for wire activity.

Contains:

  • WireAcctIdRec_CType
WireAcctIdRec_CType

WireAcctIdRec_CType is a complex CType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • WireEmplArray_AType
Simple Elements

The following simple elements are contained within this complex.

WireActAlwType
Answers the question: Is wire activity permissible for account identification? Canonical values are:
  • false
  • true
WireBalType

What type of account balance should be used for wire acceptance? Canonical values are:

  • Avl
  • Col
  • Ldgr
WireDlyAmt
The amount of wire activity for a business day.
WireOutgoingDlyLmtAmt
The amount limitations placed on outgoing wires per day.
WireOutgoingLmtAmt
The amount limitation placed on outgoing wires.
AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

WireEmplArray_AType

WireEmplArray_AType is an array AType element. This is an array of employees permissible for wire activity.

`

Contains:

  • WireEmplRec_CType
WireEmplRec_CType

WireEmplRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • EmplEmailArray_AType references EmailArray_AType
  • EmplName references PersonName_CType
  • EmplPhoneArray references PhoneArray_AType
  • RmkArray references Rmk_AType
  • WireAlwActArray_Atype
Simple Elements

The following simple elements are contained within this complex.

EmplId
The identification given to a company's employee.
EmplTitle
The title an employee holds in a corporation or business.
WireActAlwType
Answers the question: Is wire activity permissible for account identification? Canonical values are:
  • false
  • true
WireDlyAmt
The amount of wire activity for a business day.
WireDualCtrlAmt
The wire amount that would trigger dual control requirement.
WireDualCtrlReqType
Does wire activity require dual control? Canonical values are:
  • true
  • false
WireOutgoingDlyLmtAmt
The amount limitations placed on outgoing wires per day.
WireOutgoingLmtAmt
The amount limitation placed on outgoing wires.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EmplEmailArray

EmailArray_AType is an array AType element. This is an array used to define email contact information.

EmplEmailArray references EmailArray_AType.

Contains:

  • EmailInfo_CType
EmailInfo_CType

EmailInfo_Ctype is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

EmailAddr
Email address.
EmailType
Email type. Examples: Home, Work, Statement, Notice. Canonical values are:
  • Prim
  • Secd
  • OLB

EmailType is a hybrid open enumeration.

EmplName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

EmplName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
EmplPhoneArray

PhoneArray_AType is an array AType element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is optional.

EmplPhoneArray references PhoneArray_AType

Contains:

  • PhoneInfo_CType
PhoneInfo_CType

PhoneInfo_CType is a complex CType element. It contains basic phone contact information. This complex is optional.

Contains:
  • MobPhoneInfo_CType
Simple Elements

The following simple elements are contained within this complex.

ConEndTime
The Greenwich Mean time when contact availability ends.
ConStartTime
The Greenwich Mean time when contact availability starts.
PhoneExt
The phone extension.
PhoneNumDsp
Phone Number Display, based on format codes which may include special formatting. Examples include:
  • (XXX)XXX-XXXX
  • XXX-XXX-XXXX
  • XXX/XXX/XXXX
  • XXX.XXX.XXXX
  • XXX-XXX-XXXXXX
  • XXXXX-XXX-XXX-XXXX
PhoneNum
The phone number.
PhoneTime
Best phone usage time, day, or evening.
PhoneType
Phone type examples are: home, work, fax, cell. Canonical values are:
  • Home
  • SecdHome
  • Bus
  • SecdBus
  • HomeCell
  • BusCell
  • PersonalCell
  • HomeFax
  • BusFax
  • SecdBusCell

PhoneType is a hybrid open enumeration.

RmkArray

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

RmkArray references Rmk_AType

Contains:

  • RmkInfo_CType
RmkInfo_CType

RmkInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Rmk
Application or user remarks free-form text.
WireAlwActArray_AType

WireAlwActArray_AType is an array AType element. This is an array of processes allowable for wire activity.

Contains:

  • WireAlwActRec_CType
WireAlwActRec_CType

WireAlwActRec_CType is a complex CType element.

Contains:
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

WireAlwActType
The allowable processes for wires. Canonical values are:
  • CrtIntnet
  • CrtOneTime
  • CrtTmplt
  • EditOneTime
  • EditTmplt
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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 Mon Jan 24 2022