Account History Search
Account History Search
Account History Search is a jXchange service designed to allow the consumer to perform searches on account history.
Message Flow
In jXchange, the Account History Search service uses a typical exchange of MType
messages to perform searches on account history to a service provider.
Primary Request
The third-party consumer forwards the AcctHistSrchRq_MType message to
the service provider. The message contains the following simple elements:
- ChkNumEnd
- ChkNumStart
- EFTOnly
- EndDt
- HighAmt
- InclLnPmtBrkdwnType
- LowAmt
- SrtMthd
- StartDt
- TrnType
The message contains the following complex elements:
SrchMsgRqHdr_CTypeCustom_CType
The message contains the following array:
IncXtendElemArray_AType
Primary Response
The service provider returns the AcctHistSrchRs_MType message to
the third-party consumer. The message contains the following complex elements:
Custom_CTypeSrchMsgRsHdr_CType
The message contains the following array:
AcctHistSrchRecArray_AType
Account History Search Behavior
Account History Search service behavior is as follows.
The consumer's application must retain the confirmation key created for the
transfer service. This confirmation number is provided in the transfer service addition
XferAdd response
message.
The confirmation key is provided as an additional filter for history search services. It can be used with the existing filters in the corresponding request message.
The provider returns memo-posted history items when the Memo Post Included (MemoPostInc) value is true. The memo-posted history items return based on the account history search LIFO response method. The memo-posted item's history is included in the Transaction History Balance Amount (TrnHistBalAmt). The History running balance (TrnHistBalAmt) does not return when the Sort Method (SrtMthd) is not Posted or EffDt. History running balance (TrnHistBalAmt) does not return if check number range, amount range, Transaction Type Filter, EFT Only Filter, Transfer Key, or Transaction Receipt ID is submitted on the request.
The Service Gateway Aggregation passes through the canonical value true to the service provider much like the Memo Post Included (MemoPostInc) canonical value Excl.
Account History Search Business Case
The consumer is searching for a check in this business case.
The Third Party Consumer sends the AcctHistSrchRq message to the
Service Provider with the following values.
| Complex Element | Simple Element | Entry Value |
|---|---|---|
InAcctId | AcctId | 0002235555550015 |
AcctType | D |
| Complex Element | Simple Element | Entry Value |
|---|---|---|
ChkNumStart | 1234 | |
ChkNumEnd | 1236 | |
StartDt | 2008-05-01 | |
EndDt | 2008-05-29 | |
TrnType | D |
The Service Provider returns the AcctHistSrchRs_MType containing
the AcctHistSrchRecArray_AType with
the AcctHistSrchRec_CType
containing the following values within DepHistSrchRec_CType.
| Complex Element | Simple Element | Entry Value |
|---|---|---|
DepAcctId | AcctId | 0002235555550015 |
AcctType | D |
| Complex Element | Simple Element | Entry Value |
|---|---|---|
TrnStat | A | |
PostDt | 2008-05-18 | |
Amt | 100.56 | |
BatchNum | 53 | |
TrnType | D | |
ImgNum | 00012697 | |
ChkNum | 1235 |
AcctHistSrchRq_MType
AcctHistSrchRq_MType is a message MType element.
Contains:
Custom_CTypeIdAcctIdreferencesAccountId_CTypeIncXtendElemArray_ATypeSrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ChkNumEnd
- The numbers or characters that designate an ending point for check number selections.
- ChkNumStart
- The numbers or characters that designate a starting point for check number selections.
- EFTOnly
- Response only returns electronic funds transfer transaction types.
Canonical values are:
- false
- true
- EndDt
- The date that designates the ending point for date selections.
- HighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- InclLnPmtBrkdwnType
- Include the Loan Payment Breakdown Array? Canonical values are:
- True
- False
- LowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- MemoPostInc
Determines the behavior searching history search for memo-posted items. Canonical values are:
- Excl
- Only
- True
The default value is Excl (exclude).
- SrtMthd
- The order that transactions are returned in a response.
Canonical values are:
- Amt
- ChkNum
- EffDt
- PostDt
- StartDt
- The date that designates the starting point for date selections.
- TrnType
- The grouping of monetary transactions by a specific code.
This is the end of the documented filter statement.
- XferKey
- The transfer key returned in search/inquiry requests and is needed to modify or delete a transfer.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
IdAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
IdAcctId references AccountId_CType.
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
IncXtendElemArray_AType
IncXtendElemArray_AType is an array
AType element.
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.
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.
AcctHistSrchRs_MType
AcctHistSrchRs_MType is a message
MType element.
Contains:
AcctHistSrchRecArray_ATypeCustom_CTypeSrchMsgRsHdr_CType
AcctHistSrchRecArray_AType
AcctHistSrchRecArray_AType is an
array AType element. This is an array that contains the
responses for an account history search.
Contains:
AcctHistSrchRec_CType
AcctHistSrchRec_CType
AcctHistSrchRec_CType is a complex
CType element.
Contains:
CustomAcctHistSrchRecreferencesCustom_CTypeDepHistSrchRec_CTypeLnHistSrchRec_CTypeSafeDepHistSrchRec_CTypeTimeDepHistSrchRec_CType
CustomAcctHistSrchRec
Custom_CType is a complex CType element.
CustomAcctHistSrchRec references
Custom_CType.
This element is optional.
DepHistSrchRec_CType
DepHistSrchRec_CType is a complex CType element.
Contains:
DepAcctIdreferencesAccountId_CTypeEftDescArray_ATypeMemoPost_CTypeSvcPrvdInforeferencesDepHistSrchRec_ETypex_EFTCardHistSrchRec_CTypex_StmtDataHistSrchRec_CType
Simple Elements
The following simple elements are contained within this complex.
- AffCodeDesc
- The description of the code that designates the behavior influenced values of an account.
- AffCode
- The code that designates how the behavior influenced values of an account.
- Amt
- The amount or quantity.
- 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.
- EffDt
- The date assigned to transactions when it is different from the posting date.
- EFTTrnId
- A document reference assigned to an EFT transaction by the originating entity.
- HistRecId
- The recorded identifier assigned to a history item.
- ImgNum
- The numbers or characters that identify the key of the transaction's stored image.
- MemoPostHldOvr
- Answers the question: Should the memo-post routed transaction be
held over into the service provider's next business day? Canonical values
are:
- false
- true
- ODPrvlgTrnType
- Answers the question: Was the transaction subject to the Overdraft
Privilege regulatory occurrence counter? Canonical values are:
- false
- true
- OldRate
- The prior interest rate when a new interest rate was instituted.
- 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.
- SrcCodeDesc
- The description of the code that designates the original entry of a transaction.
- StmtPasCode
- The code that designates if the account holder has a passbook
for transaction posting. Canonical values are:
- NA
- Pas
- Stmt
- TellerNum
- The numbers or characters that designate the teller who initiated the transaction.
- TrnAcptTimeDt
- The date and time a transaction was accepted.
- 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.
- TrnHistBalAmt
- The impact to the balance of the transaction history. The transaction history balance amount is only returned if the sort method is Post Date or Effective Date. The transaction history balance amount is not returned if the Check Number range, Amount range, Transaction Type Filter, EFT Only Filter, Transfer Key, or Transaction Receipt ID is submitted on the request.
- TrnRcptId
- The receipt provided for a successful transaction entry.
- TrnStat
- The status that represents the state or condition of a monetary transaction.
- TrnType
- The grouping of monetary transactions by a specific code.
- TrnUsrId
- The user identification that initiated a transaction.
- TrnWsId
- 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.
- XferKey
- The transfer key returned in search/inquiry requests and is needed to modify or delete a transfer.
DepAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
DepAcctId references AccountId_CType.
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
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.
MemoPost_CType
MemoPost_CType is a complex
CType element.
Contains
MemoPostRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- MemoDtEntry
- The date the memo-posted item was created.
- MemoPost
- A reference that indicates if the transaction is a memo-posted item.
- MemoTimeEntry
- The time of day that the memo-posted item was created.
MemoPostRmk_AType
MemoPostRmk_AType is an array
AType element. This is an array of memo post
remarks.
Contains:
MemoPostRmkInfo_CType
MemoPostRmkInfo_CType
MemoPostRmkInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- MemoPostRmk
- A free-format description that further defines pertinent information about the memo-post activity.
SvcPrvdInfo
SvcPrvdInfo is available only for JH
Consumers.
SvcPrvdInfo references SafeDepInfoRec_EType.
x_EFTCardHistSrchRec_CType
x_EFTCardHistSrchRec_CType is a complex
CType element.
Contains:
Custom_CTypeEFTCardHistSrchRec_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EFTCardHistSrchRec_CType
EFTCardHistSrchRec_CType is a
complex CType
element.
Contains:
EFTDescArray_ATypeRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- AddrVerifCode
- The code that describes the address verification for the cardholder when the transaction was accepted.
- AddrVerifDesc
- The description of the code that describes the address verification for the cardholder when the transaction was accepted.
- AddrVerifText
- Any textual values provided by the transaction initiator regarding the address verification.
- AppTrnGenr
- Answers the question: Did the EFT transaction application provider
generate a transaction? Canonical values are:
- false
- true
- ATMTrnSttlType
- Answers the question: Was the EFT transaction settled at the time
of the initiated transaction? Canonical values are:
- false
- true
- CashDistrType
- Answers the question: Was cash distributed/dispensed for the EFT
transaction? Canonical values are:
- false
- true
- EFTAtUsATMType
- Answers the question: Was the EFT transaction initiated by one of the
financial institution's ATM terminals? Canonical values are:
- false
- true
- EFTCardCapType
- Answers the question: What process was used to capture the EFT card
data? Canonical values are:
- BarCode
- CertMagRead
- ChipRead
- ElecMer
- Keyed
- MagRead
- OCR
- Trak
- UnCertChipRead
- EFTCardExpDt
- The expiration date given to an EFT card.
- EFTCardNum
- The number that is assigned to an EFT card. The card number includes the ISO number.
- EFTCardSufxNum
- The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.
- EFTCashTrnRqAmt
- The cash transaction amount requested by the card holder.
- EFTExcAmt
- The amount of the transaction that is not accepted and is considered an exception.
- EFTNtwkId
- The identification that defines the network for the original acquirer of the transaction.
- EFTOnUsTrnType
- Answers the question: Was the EFT transaction initiated by the
financial institution's account holder? Canonical values are:
- false
- true
- EFTPrvdApprvBalAmt
- The balance that was used by the EFT card processor for transaction approval when the application provider was not available.
- EFTPrvdApprvTrn
- Answers the question: Was the transaction approved by the EFT card
processor? Canonical values are:
- false
- true
- EFTSwchSeqId
- The identification given to the transaction by the card switch provider.
- EFTSwchTrnDt
- The card switch date of the transaction.
- EFTSwchTrnTime
- The card switch time of the transaction.
- EFTTrnActIdType
- Describes the type of EFT transaction activity identification.
Canonical values are:
- ForcePost
- Rev
- Rq
- EFTTrnAmt
- The actual amount of the transaction accepted by the provider.
- EFTTrnAuthBalAmt
- The balance that was used for authorization of the EFT transaction.
- EFTTrnCode
- The code that defines the type of EFT transaction.
- EFTTrnCorrelId
- An identification provided by a network to correlate a pre-authorization with the EFT transaction.
- EFTTrnDesc
- The description of the code that defines the type of EFT transaction.
- EFTTrnDt
- The date of the transaction.
- EFTTrnProcDt
- The date the transaction application provider processed the transaction.
- EFTTrnProcDt
- The date the transaction application provider processed the transaction.
- EFTTrnRcptBalAmt
- The balance that was printed on the receipt for the EFT transaction.
- EFTTrnRqAmt
- The transaction amount requested by the card holder.
- EFTTrnSeqId
- The identification given to the transaction by the provider.
- EFTTrnStatDesc
- The description of the status of the EFT transaction.
- EFTTrnStatRmk
- Any additional free-form remarks regarding the status of the EFT transaction.
- EFTTrnStat
- The status of the EFT transaction.
- EFTTrnTime
- The time of the transaction.
- EFTXferToAcctId
- The recipient account identification of an EFT transfer transaction.
- EFTXferToAcctType
- The numbers or characters that categorize the
EFTXferToAcctId. - ExcRsnCode
- The code that describes the reason for the exception.
- ExcRsnDesc
- The description of the code that describes the reason for the exception.
- MerName
- The name of the merchant that processed the POS transaction.
- MerPartAuth
- Answers the question: Does the POS merchant support/accept partial
authorizations? Canonical values are:
- false
- true
- PreAuthExpDt
- The expiration date for the pre-authorized transaction.
- PreAuthRemDays
- The number of days remaining for the pre-authorized transaction.
- RecurTrnType
- Identifies a transaction as recurring. Canonical values are:
- false
- true
- SerChgAmt
- The amount of service charge assessed to an account.
- StdIndustCode
- The standard industry code.
- StdIndustDesc
- The standard industry code description.
- SurChgAmt
- The amount of the transaction that is part of the charges for the transactional activity.
- SwchTrnType
- Answers the question: Was the EFT transaction processed through
a switch network? Canonical values are:
- false
- true
- TrnSttlDt
- The date a transaction was settled.
- TrnSttlTime
- The time a transaction was settled.
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.
Rmk_AType
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
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.
x_StmtDataHistSrchRec_CType
x_StmtDataHistSrchRec_CType is a complex CType element.
Contains:
Custom_CTypeStmtDataHistSrchRec_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
StmtDataHistSrchRec_CType
StmtDataHistSrchRec_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- TrnStmtDesc
- The description related to a transaction code used for customer statements.
LnHistSrchRec_CType
LnHistSrchRec_CType is a complex CType element.
Contains:
EFTDescArray_ATypeLoanAcctIdreferencesAccountId_CTypeLnHistPmtInfoSrchArray_ATypeMemoPost_CTypex_ACHHistSrchRec_CTypex_EFTCardHistSrchRec_CTypex_StmtDataHistSrchRec_CType
Simple Elements
The following simple elements are contained within this complex.
- AffCodeDesc
- The description of the code that designates the behavior influenced values of an account.
- AffCode
- The code that designates how the behavior influenced values of an account.
- Amt
- The amount or quantity.
- 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.
- EffDt
- The date assigned to transactions when it is different from the posting date.
- HistRecId
- The recorded identifier assigned to a history item.
- ImgNum
- The numbers or characters that identify the key of the transaction's stored image.
- LnSvcTrnCodeDesc
- The description of the transaction code for serviced loans to designate the type of transaction.
- LnSvcTrnCode
- The transaction code for serviced loans to designate the type of transaction.
- MemoPostHldOvr
- Answers the question: Should the memo-post routed transaction be
held over into the service provider's next business day? Canonical values
are:
- false
- true
- NewRate
- The current interest rate for a specific account on a specific date.
- OldRate
- The prior interest rate when a new interest rate was instituted.
- PmtDueDt
- The date established for a scheduled payment.
- PostDt
- The date a transaction has posted or is scheduled to be posted to an account.
- PostSeq
- The posting sequence of payments.
- SeqNum
- The integer assigned to a specific transaction.
- SplitPostSeq
- A sequence number assigned to transactions that references the order a transaction was split out. For example, a gross transaction was net out to two transactions, and the sequence number would reference the order of the net transactions.
- SrcCodeDesc
- The description of the code that designates the original entry of a transaction.
- TellerNum
- The numbers or characters that designate the teller who initiated the transaction.
- TrnAcptTimeDt
- The date and time a transaction was accepted.
- 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.
- TrnHistBalAmt
- The impact to the balance of the transaction history. The transaction history balance amount is only returned if the sort method is Post Date or Effective Date. The transaction history balance amount is not returned if the Check Number range, Amount range, Transaction Type Filter, EFT Only Filter, Transfer Key, or Transaction Receipt ID is submitted on the request.
- TrnRcptId
- The receipt provided for a successful transaction entry.
- TrnStat
- The status that represents the state or condition of a monetary transaction.
- TrnType
- The grouping of monetary transactions by a specific code.
- TrnUsrId
- The user identification that initiated a transaction.
- TrnWsId
- 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.
- XferKey
- The transfer key returned in search/inquiry requests and is needed to modify or delete a transfer.
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.
LoanAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
LoanAcctId references AccountId_CType.
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
LnHistPmtInfoSrchArray_AType
LnHistPmtInfoSrchArray_AType is an array AType element. This element is an
array of loan payment breakdown information.
Contains:
LnHistPmtInfoSrchRec_CType
LnHistPmtInfoSrchRec_CType
LnHistPmtInfoSrchRec_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- AffCodeDesc
- The description of the code that designates the behavior influenced values of an account.
- AffCode
- The code that designates how the behavior influenced values of an account.
- Amt
- The amount or quantity.
- HistRecId
- The recorded identifier assigned to a history item.
- PmtDueDt
- The date established for a scheduled payment.
- PostSeq
- The posting sequence of payments.
- SplitPostSeq
- A sequence number assigned to transactions that references the order a transaction was split out. For example, a gross transaction was net out to two transactions, and the sequence number would reference the order of the net 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.
- TrnHistBalAmt
- The impact to the balance of the transaction history. The transaction history balance amount is only returned if the sort method is Post Date or Effective Date. The transaction history balance amount is not returned if the Check Number range, Amount range, Transaction Type Filter, EFT Only Filter, Transfer Key, or Transaction Receipt ID is submitted on the request.
- TrnStmtDesc
- The description related to a transaction code used for customer statements.
- TrnType
- The grouping of monetary transactions by a specific code.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
MemoPost_CType
MemoPost_CType is a complex
CType element.
Contains
MemoPostRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- MemoDtEntry
- The date the memo-posted item was created.
- MemoPost
- A reference that indicates if the transaction is a memo-posted item.
- MemoTimeEntry
- The time of day that the memo-posted item was created.
MemoPostRmk_AType
MemoPostRmk_AType is an array
AType element. This is an array of memo post
remarks.
Contains:
MemoPostRmkInfo_CType
MemoPostRmkInfo_CType
MemoPostRmkInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- MemoPostRmk
- A free-format description that further defines pertinent information about the memo-post activity.
x_ACHHistSrchRec_CType
x_ACHHistSrchRec_CType is a complex
CType element.
Contains:
ACHHistSrchRec_CTypeCustom_CType
ACHHistSrchRec_CType
ACHHistSrchRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- ACHAddeType
Does ACH addenda exist for this entity/resource? Canonical values are:
- true
- false
- ACHCompDiscrData
- The ACH company discretionary data, as governed by Nacha® rules.
- ACHCompDtDesc
- A date created by the ACH originator for descriptive purposes and never used for any timing controls.
- ACHCompEntryDesc
- The ACH company entry description, as governed by Nacha® rules.
- ACHCompId
- The ACH company ID.
- ACHCompName
- The ACH company name, as governed by Nacha® rules.
- ACHDtSttl
- The date on which the ACH participating financial institution is scheduled to be debited or credited FRB. This is not of type date due to the format of the date governed by Fed.
- ACHEffDt
- The date assigned to transactions when it is different from the posting date.
- ACHIndvDiscrData
- The ACH individual discretionary data as governed by Nacha® rules.
- ACHIndvId
- The ID entered by the originator provides additional identification for the ACH receiver and may be helpful in identifying the consumer.
- ACHIndvName
- The name entered by the originator provides additional identification for the ACH receiver and may be helpful in identifying the consumer.
- ACHRetRsnCode
- The Nacha® governed standard return reason codes to describe the reason for returning an ACH entry.
- ACHRetRsnDesc
- The Nacha® governed standard return reason codes to describe the reason for returning an ACH entry.
- ACHStdEntryClass
- The ACH standard entry class.
- ACHSvcClass
- The general classification of dollar entries for ACH exchange as governed by Nacha®.
- ACHTraceId
- The ACH trace number that uniquely identifies each entry detail record within a batch in an ACH file.
- ACHTraceNum
- The ACH trace number that uniquely identifies each entry detail
record within a batch in an ACH file.Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2018–01–01.
- ACHTrnCode
- The transaction code to be used for the ACH item, as governed by Nacha® rules.
- ACHTrnDesc
- The description of the transaction code to be used for the ACH item, as governed by Nacha® rules.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
x_EFTCardHistSrchRec_CType
x_EFTCardHistSrchRec_CType is a complex
CType element.
Contains:
Custom_CTypeEFTCardHistSrchRec_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EFTCardHistSrchRec_CType
EFTCardHistSrchRec_CType is a
complex CType
element.
Contains:
EFTDescArray_ATypeRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- AddrVerifCode
- The code that describes the address verification for the cardholder when the transaction was accepted.
- AddrVerifDesc
- The description of the code that describes the address verification for the cardholder when the transaction was accepted.
- AddrVerifText
- Any textual values provided by the transaction initiator regarding the address verification.
- AppTrnGenr
- Answers the question: Did the EFT transaction application provider
generate a transaction? Canonical values are:
- false
- true
- ATMTrnSttlType
- Answers the question: Was the EFT transaction settled at the time
of the initiated transaction? Canonical values are:
- false
- true
- CashDistrType
- Answers the question: Was cash distributed/dispensed for the EFT
transaction? Canonical values are:
- false
- true
- EFTAtUsATMType
- Answers the question: Was the EFT transaction initiated by one of the
financial institution's ATM terminals? Canonical values are:
- false
- true
- EFTCardCapType
- Answers the question: What process was used to capture the EFT card
data? Canonical values are:
- BarCode
- CertMagRead
- ChipRead
- ElecMer
- Keyed
- MagRead
- OCR
- Trak
- UnCertChipRead
- EFTCardExpDt
- The expiration date given to an EFT card.
- EFTCardNum
- The number that is assigned to an EFT card. The card number includes the ISO number.
- EFTCardSufxNum
- The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.
- EFTCashTrnRqAmt
- The cash transaction amount requested by the card holder.
- EFTExcAmt
- The amount of the transaction that is not accepted and is considered an exception.
- EFTNtwkId
- The identification that defines the network for the original acquirer of the transaction.
- EFTOnUsTrnType
- Answers the question: Was the EFT transaction initiated by the
financial institution's account holder? Canonical values are:
- false
- true
- EFTPrvdApprvBalAmt
- The balance that was used by the EFT card processor for transaction approval when the application provider was not available.
- EFTPrvdApprvTrn
- Answers the question: Was the transaction approved by the EFT card
processor? Canonical values are:
- false
- true
- EFTSwchSeqId
- The identification given to the transaction by the card switch provider.
- EFTSwchTrnDt
- The card switch date of the transaction.
- EFTSwchTrnTime
- The card switch time of the transaction.
- EFTTrnActIdType
- Describes the type of EFT transaction activity identification.
Canonical values are:
- ForcePost
- Rev
- Rq
- EFTTrnAmt
- The actual amount of the transaction accepted by the provider.
- EFTTrnAuthBalAmt
- The balance that was used for authorization of the EFT transaction.
- EFTTrnCode
- The code that defines the type of EFT transaction.
- EFTTrnCorrelId
- An identification provided by a network to correlate a pre-authorization with the EFT transaction.
- EFTTrnDesc
- The description of the code that defines the type of EFT transaction.
- EFTTrnDt
- The date of the transaction.
- EFTTrnProcDt
- The date the transaction application provider processed the transaction.
- EFTTrnProcDt
- The date the transaction application provider processed the transaction.
- EFTTrnRcptBalAmt
- The balance that was printed on the receipt for the EFT transaction.
- EFTTrnRqAmt
- The transaction amount requested by the card holder.
- EFTTrnSeqId
- The identification given to the transaction by the provider.
- EFTTrnStatDesc
- The description of the status of the EFT transaction.
- EFTTrnStatRmk
- Any additional free-form remarks regarding the status of the EFT transaction.
- EFTTrnStat
- The status of the EFT transaction.
- EFTTrnTime
- The time of the transaction.
- EFTXferToAcctId
- The recipient account identification of an EFT transfer transaction.
- EFTXferToAcctType
- The numbers or characters that categorize the
EFTXferToAcctId. - ExcRsnCode
- The code that describes the reason for the exception.
- ExcRsnDesc
- The description of the code that describes the reason for the exception.
- MerName
- The name of the merchant that processed the POS transaction.
- MerPartAuth
- Answers the question: Does the POS merchant support/accept partial
authorizations? Canonical values are:
- false
- true
- PreAuthExpDt
- The expiration date for the pre-authorized transaction.
- PreAuthRemDays
- The number of days remaining for the pre-authorized transaction.
- RecurTrnType
- Identifies a transaction as recurring. Canonical values are:
- false
- true
- SerChgAmt
- The amount of service charge assessed to an account.
- StdIndustCode
- The standard industry code.
- StdIndustDesc
- The standard industry code description.
- SurChgAmt
- The amount of the transaction that is part of the charges for the transactional activity.
- SwchTrnType
- Answers the question: Was the EFT transaction processed through
a switch network? Canonical values are:
- false
- true
- TrnSttlDt
- The date a transaction was settled.
- TrnSttlTime
- The time a transaction was settled.
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.
Rmk_AType
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
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.
x_StmtDataHistSrchRec_CType
x_StmtDataHistSrchRec_CType is a complex CType element.
Contains:
Custom_CTypeStmtDataHistSrchRec_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
StmtDataHistSrchRec_CType
StmtDataHistSrchRec_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- TrnStmtDesc
- The description related to a transaction code used for customer statements.
SafeDepHistSrchRec_CType
SafeDepHistSrchRec_CType is a
complex CType element.
Contains:
MemoPost_CTypeSafeDepAcctIdreferencesAccountId_CTypex_StmtDataHistSrchRec_CType
Simple Elements
The following simple elements are contained within this complex.
- AffCodeDesc
- The description of the code that designates the behavior influenced values of an account.
- AffCode
- The code that designates how the behavior influenced values of an account.
- Amt
- The amount or quantity.
- BatchNum
- The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
- HistRecId
- The recorded identifier assigned to a history item.
- ImgNum
- The numbers or characters that identify the key of the transaction's stored image.
- PmtDueDt
- The date established for a scheduled payment.
- PostDt
- The date a transaction has posted or is scheduled to be posted to an account.
- SeqNum
- The integer assigned to a specific transaction.
- SrcCodeDesc
- The description of the code that designates the original entry of a transaction.
- TellerNum
- The numbers or characters that designate the teller who initiated the transaction.
- 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.
- TrnStat
- The status that represents the state or condition of a monetary transaction.
- TrnType
- The grouping of monetary transactions by a specific code.
- TrnUsrId
- The user identification that initiated a transaction.
- TrnWsId
- 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.
MemoPost_CType
MemoPost_CType is a complex
CType element.
Contains
MemoPostRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- MemoDtEntry
- The date the memo-posted item was created.
- MemoPost
- A reference that indicates if the transaction is a memo-posted item.
- MemoTimeEntry
- The time of day that the memo-posted item was created.
MemoPostRmk_AType
MemoPostRmk_AType is an array
AType element. This is an array of memo post
remarks.
Contains:
MemoPostRmkInfo_CType
MemoPostRmkInfo_CType
MemoPostRmkInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- MemoPostRmk
- A free-format description that further defines pertinent information about the memo-post activity.
SafeDepAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
SafeDepAcctId references AccountId_CType.
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
x_StmtDataHistSrchRec_CType
x_StmtDataHistSrchRec_CType is a complex CType element.
Contains:
Custom_CTypeStmtDataHistSrchRec_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
StmtDataHistSrchRec_CType
StmtDataHistSrchRec_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- TrnStmtDesc
- The description related to a transaction code used for customer statements.
TimeDepHistSrchRec_CType
TimeDepHistSrchRec_CType is a complex CType element.
Contains:
MemoPost_CTypeTimeDepAcctId_CTypereferencesAccountId_CTypex_StmtDataHistSrchRec_CType
Simple Elements
The following simple elements are contained within this complex.
- AffCodeDesc
- The description of the code that designates the behavior influenced values of an account.
- AffCode
- The code that designates how the behavior influenced values of an account.
- Amt
- The amount or quantity.
- 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.
- EffDt
- The date assigned to transactions when it is different from the posting date.
- HistRecId
- The recorded identifier assigned to a history item.
- ImgNum
- The numbers or characters that identify the key of the transaction's stored image.
- MemoPostHldOvr
- Answers the question: Should the memo-post routed transaction be
held over into the service provider's next business day? Canonical values
are:
- false
- true
- NewRate
- The current interest rate for a specific account on a specific date.
- OldRate
- The prior interest rate when a new interest rate was instituted.
- PostDt
- The date a transaction has posted or is scheduled to be posted to an account.
- SeqNum
- The integer assigned to a specific transaction.
- SrcCodeDesc
- The description of the code that designates the original entry of a transaction.
- TellerNum
- The numbers or characters that designate the teller who initiated the transaction.
- 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.
- TrnHistBalAmt
- The impact to the balance of the transaction history. The transaction history balance amount is only returned if the sort method is Post Date or Effective Date. The transaction history balance amount is not returned if the Check Number range, Amount range, Transaction Type Filter, EFT Only Filter, Transfer Key, or Transaction Receipt ID is submitted on the request.
- TrnStat
- The status that represents the state or condition of a monetary transaction.
- TrnType
- The grouping of monetary transactions by a specific code.
- TrnUsrId
- The user identification that initiated a transaction.
- TrnWsId
- 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.
- XferKey
- The transfer key returned in search/inquiry requests and is needed to modify or delete a transfer.
MemoPost_CType
MemoPost_CType is a complex
CType element.
Contains
MemoPostRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- MemoDtEntry
- The date the memo-posted item was created.
- MemoPost
- A reference that indicates if the transaction is a memo-posted item.
- MemoTimeEntry
- The time of day that the memo-posted item was created.
MemoPostRmk_AType
MemoPostRmk_AType is an array
AType element. This is an array of memo post
remarks.
Contains:
MemoPostRmkInfo_CType
MemoPostRmkInfo_CType
MemoPostRmkInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- MemoPostRmk
- A free-format description that further defines pertinent information about the memo-post activity.
TimeDepAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
TimeDepAcctId references AccountId_CType.
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
x_StmtDataHistSrchRec_CType
x_StmtDataHistSrchRec_CType is a complex CType element.
Contains:
Custom_CTypeStmtDataHistSrchRec_CType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
StmtDataHistSrchRec_CType
StmtDataHistSrchRec_CType is a complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- TrnStmtDesc
- The description related to a transaction code used for customer statements.
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.