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

Account Reconciliation Item Inquiry

Enterprise SOAP API > API by Reference > Core Services > Account Reconciliation Item Inquiry

Account Reconciliation Item Inquiry

Account Reconciliation Item Inquiry is a jXchange service designed to allow a consumer to inquire on account reconciliation items.

Message Flow

In jXchange, the Account Reconciliation Item Inquiry service uses a typical exchange of MType messages to allow a consumer to inquire on account reconciliation items.

Primary Request

The consumer forwards the AcctReconItemInqRq_MType message to the service provider. The message contains the following simple elements:

  • AccountId_CType
  • ActIntentKey
  • BatchNum
  • ChkNum
  • Custom_CType
  • IssAmt
  • IssItemCrtDt
  • MsgRqHdr_CType
  • SeqNum

Primary Response

The service provider returns the AcctReconItemInqRs_MType message to the consumer. The message contains the following simple elements:

  • AccountId_CType
  • AcctReconItemInqRec_CType
  • ActIntent
  • ActIntentKey
  • BatchNum
  • ChkNum
  • Custom_CType
  • IssAmt
  • IssItemCrtDt
  • MsgRsHdr_CType
  • SeqNum

Account Reconciliation Item Inquiry Behavior

The Account Reconciliation Item Inquiry service behavior is as follows.

The Account Reconciliation Item Inquiry root request message (AcctReconItemInqRq_MType) requires a Valid Account Identification (AccountId_CType) and Issued Amount (IssAmt).

The Account Reconciliation Item Inquiry root request message (AcctReconItemInqRq_MType) optionally includes the Issued Item Creation Date (IssItemCrtDt), Check Number (ChkNum), Batch Number (BatchNum), and Sequence Number (SeqNum).

The Root request optionally includes the Activity Intention element (ActIntent) with the concurrency model tenet.

The Account Reconciliation Item Inquiry root request elements may be cached from the Account Reconciliation Item Search response (AcctReconItemSrchRs_MType).

The Account Reconciliation Item Inquiry root response message (AcctReconItemInqRs_MType) echoes back the elements from the root request.

The Account Reconciliation Item Inquiry root response message (AcctReconItemInqRs_MType) contains the Account Reconciliation Item Inquiry Record (AcctReconItemInqRec_CType).

The Account Reconciliation Item Inquiry Record (AcctReconItemInqRec_CType) contains the following elements:

  • Account Reconciliation Item Record (AcctReconItemRec_CType)
  • Account Reconciliation Violation Type (AcctReconViolType)
  • Dormant Date (DormantDt)
  • Effective Date (EffDt)
  • Exception Resolve Type (ExcResolveType)
  • Post Date (PostDt)
  • Stale Date (StaleDt)
  • Stop Check Expiration Date (StopChkExpDt)
  • Stop Check Placement Date (StopChkPlaceDt)
  • Transaction Amount (TrnAmt)
  • Transaction Code (TrnCodeCode)
  • Transaction Code Description (TrnCodeDesc)

The Account Reconciliation Item Record (AcctReconItemRec_CType) contains the following elements:

  • Account Reconciliation Violation Remark (AcctReconViolRmk)
  • Check Date (ChkDt)
  • Check Number (ChkNum)
  • Check Void Date (ChkVoidDt)
  • Issued Amount (IssAmt)
  • Payee Address (PayeeAddr_CType)
  • Payee Name (PayeeName)
  • Transaction Type (TrnType)
  • User Definition Information Array (UserDefInfoArray_AType)

Standard inquiry message tenets are applicable.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the correlation identifications.

Adhere to the tenets related to the concurrency models.

AcctReconItemInqRq_MType

AcctReconItemInqRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

BatchNum
The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
IssAmt
The amount or quantity.
IssItemCrtDt
The date an issued item was created in the application.
SeqNum
The integer assigned to a specific transaction.

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.

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.

AcctReconItemInqRs_MType

AcctReconItemInqRs_MType is a message MType element.

Contains:

  • AccountId_CType
  • AcctReconItemInqRec_CType
  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

ActIntentKey
The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
BatchNum
The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
IssAmt
The amount or quantity.
IssItemCrtDt
The date an issued item was created in the application.
SeqNum
The integer assigned to a specific transaction.

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

AcctReconItemInqRec_CType

AcctReconItemInqRec_CType is a complex CType element.

Contains:

  • AcctReconItemRec_CType
  • Custom_CType

Simple Elements

The following simple elements are contained within this complex.

AcctReconViolType
The type of violation. Canonical values are:
  • Dorm
  • Dup
  • InvAmt
  • InvPayee
  • MaxAmt
  • NotIss
  • PdnotIss
  • SerialMiss
  • StaleDt
  • StopPay
  • Void
DormantDt
The date the account went to a Dormant status.
EffDt
The date assigned to transactions when it is different from the posting date.
ExcResolveType
Answers the question: Should the account exception item be considered resolved? Canonical values are:
  • False
  • True
PostDt
The date a transaction has posted or is scheduled to be posted to an account.
StaleDt
The item stale date.
StopChkExpDt
The expiration date.
StopChkPlaceDt
The stop check placed date.
TrnAmt
The amount of transactions.
TrnCodeCode
The code that identifies the behavior of a monetary transaction.

AcctReconItemRec_CType

AcctReconItemRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • SvcPrvdInfo references AcctReconItemRec_EType
  • UserDefInfoArray_AType
Simple Elements

The following simple elements are contained within this complex.

AcctReconViolRmk
Application or user remarks free-form text.
ChkDt
The check date.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
ChkVoidDt
The date a check was voided.
IssAmt
The amount or quantity.
PayeeName
The name of the payee.
TrnType
The grouping of monetary transactions by a specific code.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

PayeeAddr

Addr_CType is a complex CType element containing address information. This element is optional.

PayeeAddr references Addr_CType.

Contains:

  • FreeFormAddr_AType
Simple Elements

The following simple elements are contained within this complex.

BusAddr
Answers the question: Is this a business address? Y states it is a business address.
City
The city name.
Cntry
The country name.
CntryType
The country abbreviation from ISO 3166.
County
The county name.
DlvryPt
The delivery point added to the ZIP code.
FornAddr
Is this a foreign address? Y states it is a foreign address.
InvAddr
Is this address invalid? Y states mail has been returned from this address.
PostalCode
The postal code or ZIP code.
StateCode
The two-character alpha code which represents a state. For example, MO.
StateProv
The state or province or region.
StreetAddr1
The street address.
StreetAddr2
The second line of street address.
StreetAddr3
The third line of street address.
FreeFormAddr_AType

FreeFormAddr_AType is an array AType element. This is an array of free form address lines 1–11 in a printable/usable form.

Contains:

  • AddrLineInfo_CType
AddrLineInfo_CType

AddrLineInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AddrLine
Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
SvcPrvdInfo

AcctReconItemRec_EType is an extended EType element.

SvcPrvdInfo references AcctReconItemRec_EType.

Contains:

  • AcctReconItemRec_CType
UserDefInfoArray_AType

UserDefInfoArray_AType is an array AType element. This is an array of UserDefInfo simple elements used to describe user-defined information.

Contains:

  • UserDefInfo_CType
UserDefInfo_CType

UserDefInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

OvrrdInstRtId
Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
UserDefCode
The code that represents the answer to the UserDefTxt.
UserDefDesc
The description of what the UserDefCode represents.
UserDefDt
A date field that has a relationship with the UserDefTxt or UserDefCode.
UserDefInfo1
Additional information that may accompany any of the user supplied codes.
UserDefInfo2
Additional information that may accompany any of the user supplied codes.
UserDefInfo3
Additional information that may accompany any of the user supplied codes.
UserDefTxt
User Defined Text is part of a matched pair array that describes the proceeding elements.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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.

©1999-2020 Jack Henry & Associates, Inc.

Dates are provided as estimates only and can be changed at any time at the sole discretion of JHA.

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