Account Reconciliation Item Search
Account Reconciliation Item Search
Account Reconciliation Item Search is a jXchange service designed to allow a consumer to obtain an account's transactional data. This information is typically used for a reconciliation process as part of business or personal finance management applications.
Message Flow
In jXchange, the Account Reconciliation Item Search service uses a typical
exchange of MType messages
to allow a consumer to obtain an account's transactional data.
Primary Request
The consumer forwards the AcctReconItemSrchRq_MType message
to the service provider. The message contains the following simple elements:
- AcctReconBatchId
- ActIntent
- ChkNum
- IssAmt
- IssItemCrtDt
- PayeeName
The message contains the following complex elements:
AccountId_CTypeCustom_CTypeSrchMsgRqHdr_CType
Primary Response
The service provider returns the AcctReconItemSrchRs_MType message
to the consumer. The message contains the following simple elements:
- AcctReconBatchId
- ActIntent
- ChkNum
- IssAmt
- IssItemCrtDt
- PayeeName
The message contains the following complex elements:
AccountId_CTypeCustom_CTypeSrchMsgRsHdr_CType
The message contains the following extended element:
SvcPrvdInforeferencesAcctReconItemSrchRs_EType
The message contains the following array:
AcctReconItemSrchArray_AType
Account Reconciliation Item Search Behavior
Account Reconciliation Item Search is a jXchange service designed to allow a consumer to obtain an account's transactional data. This information is typically used for a reconciliation process as part of business or personal finance management applications.
The Account Reconciliation Item Search behavior is as follows.
The Account Reconciliation Item Search root request message
(AcctReconItemSrchRq_MType) requires a valid Account Identification
(AccountId_CType) and Account Reconciliation Batch Identifier
(AcctReconBatchId) simple element. The system obtains the Account
Reconciliation Batch Identifier (AcctReconBatchId) from the Account
Reconciliation Batch Search service (AcctReconBatchSrch).
The Payee Name (PayeeName) search type attribute SrchType must support Exact, StartsWith, and Contains. The Activity Intention Key (ActIntentKey) only returns with the Activity Intention element (ActIntent) for the canonical values Update (Upd) and Delete (Dlt). The service provider is allowed the discretion when to return the Activity Intention Key (ActIntentKey) if the response set is so large that the management of the Activity Intention Key (ActIntentKey) becomes unmanageable. The Activity Intention (ActIntent) and Activity Intention Key (ActIntentKey) behavior are only allowed on search services when the response set is part of a subset. For example, Account Reconciliation Item Search requires the Account Identifier (AcctId) element, making the account reconciliation items in the return response limited to a specific account identifier.
The Account Reconciliation Item Search root response message
(AcctReconItemSrchRs_MType) contains the Account Identification
(AccountId_CType), Account Reconciliation Batch Identifier
(AcctReconBatchId) simple element, and Account Reconciliation Item
Search Array (AcctReconItemSrchArray_AType).
The Account Reconciliation Item Search Array (AcctReconItemSrchArray_AType)
contains the Account Reconciliation Item Search Record complex
(AcctReconItemSrchRec_CType) which contains the following elements:
- Account Recon Transaction Item Array (
AcctReconTrnItemArray) - Batch Number (BatchNum)
- Check Date (ChkDt)
- Check Number (ChkNum)
- Check Void Date (ChkVoidDt)
- EFT Description Array (
EftDescArray_AType) - Issued Amount (IssAmt)
- Payee Address (
PayeeAddr_CType) - Payee Name (PayeeName)
- Post Date (PostDt)
- Transaction Amount (TrnAmt)
- Transaction Code Code (TrnCodeCode)
- Transaction Code Description (TrnCodeDesc)
- Transaction Type (TrnType)
- Sequence Number (SeqNum)
The standard search message tenets are applicable.
Adhere to the tenets related to the Concurrency model.
Adhere to the tenets for fault reporting.
Adhere to the tenets related to the correlation identifications.
AcctReconItemSrchRq_MType
AcctReconItemSrchRq_MType is a message MType element.
Contains:
AccountId_CTypeCustom_CTypeSrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- AcctReconBatchId
- The account reconciliation identifier for a specific batch.
- 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.
- 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.
- PayeeName
- The name of the payee.
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.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType is a complex
CType element. This is a
standard request message header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MaxRec
- The maximum number of records when multiple records are returned.
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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
AcctReconItemSrchRs_MType
AcctReconItemSrchRs_MType is a message MType element.
Contains:
AccountId_CTypeAcctReconItemSrchArray_ATypeCustom_CTypeSrchMsgRsHdr_CTypeSvcPrvdInforeferencesAcctReconItemSrchRs_EType
Simple Elements
The following simple elements are contained within this complex.
- AcctReconBatchId
- The account reconciliation identifier for a specific batch.
- 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.
- 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.
- PayeeName
- The name of the payee.
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
AcctReconItemSrchArray_AType
AcctReconItemSrchArray_AType is an array AType element. This is an array of
elements for account reconciliation outputs.
Contains:
AcctReconItemSrchRec_CType
AcctReconItemSrchRec_CType
AcctReconItemSrchRec_CType is a complex CType element.
Contains:
AcctReconTrnItemArray_ATypeCustom_CTypeEFTDescArray_ATypePayeeAddrreferencesAddr_CTypeSvcPrvdInforeferencesAcctReconItemSrchRec_EType
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
- 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.
- 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.
- DormantDt
- The date the account went to a Dormant status.
- ExcResolveType
- Answers the question: Should the account exception item be
considered resolved? Canonical values are:
- False
- True
- IssAmt
- The amount or quantity.
- IssItemCrtDt
- The date an issued item was created in the application.
- ItemRetDt
- The date an issued item was returned.
- PayeeName
- The name of the payee.
- PostDt
- The date a transaction has posted or is scheduled to be posted to an account.
- SeqNum
- The integer assigned to a specific transaction.
- 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.
- TrnCodeDesc
- The description of the code that identifies the behavior of a monetary transaction.
- TrnType
- The grouping of monetary transactions by a specific code.
AcctReconTrnItemArray_AType
AcctReconTrnItemArray_AType is an array AType element. This is an array of
different transaction types for account reconciliation.
Contains:
AcctReconTrnItemRec_CType
AcctReconTrnItemRec_CType
AcctReconTrnItemRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- TrnItemDesc
- The description of a specific transaction item.
- TrnItemType
- The type of transactional item. Canonical values are:
- Pd
- Ret
- Stop
- Void
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.
EFTDescArray_AType
EFTDescArray_AType is an array
AType element.
Contains:
EftDescInfo_CType
EftDescInfo_CType
EftDescInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- EftDesc
- A free-format description that further defines pertinent information about the transactions. Often associated with electronic transaction types.
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
AcctReconItemSrchRec_EType is an extended EType element.
SvcPrvdInfo references AcctReconItemSrchRec_CType.
Contains:
AcctReconItemSrchRec_CType
AcctReconItemSrchRec_CType
AcctReconItemSrchRec_CType is a complex CType element.
Contains:
AcctReconTrnItemArray_ATypeCustom_CTypeEFTDescArray_ATypePayeeAddrreferencesAddr_CTypeSvcPrvdInforeferencesAcctReconItemSrchRec_EType
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
- 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.
- 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.
- DormantDt
- The date the account went to a Dormant status.
- ExcResolveType
- Answers the question: Should the account exception item be
considered resolved? Canonical values are:
- False
- True
- IssAmt
- The amount or quantity.
- IssItemCrtDt
- The date an issued item was created in the application.
- ItemRetDt
- The date an issued item was returned.
- PayeeName
- The name of the payee.
- PostDt
- The date a transaction has posted or is scheduled to be posted to an account.
- SeqNum
- The integer assigned to a specific transaction.
- 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.
- TrnCodeDesc
- The description of the code that identifies the behavior of a monetary transaction.
- TrnType
- The grouping of monetary transactions by a specific code.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType is a complex
CType element. It searches
specific message response headers.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MoreRec
- Indicates if there are more records that could be returned.
Canonical values are:
- false
- true
- SentRec
- The number of records sent in the response.
- TotRec
- Indicates the total records the request selected, which could be
larger than
MaxRec.
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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.