Teller Transaction Search Behavior
The Teller Transaction Search (TellerTrnSrch
) service behavior is as
follows.
The Teller Transaction Search root request message (TellerTrnSrchRq_MType
)
contains a documented filter statement where the elements at the root are optional but at
least one of the elements are required. The root elements are:
- Account Identification (AcctId)
- Account Type (AcctType)
- Cash In High Amount (CashInHighAmt)
- Cash In Low Amount (CashInLowAmt)
- Cash Out High Amount (CashOutHighAmt)
- Cash Out Low Amount (CashOutLowAmt)
- Remark (Rmk)
- Teller Business Date End (TellerBusDtEnd)
- Teller Business Date Start (TellerBusDtStart)
- Transaction Detail High Amount (TrnDetHighAmt)
- Transaction Detail Low Amount (TrnDetLowAmt)
- Teller Drawer Identification Array (TellerDrwIdArray)
- Teller Transaction Code (TellerTrnCode)
- Transaction User Identification (TrnUsrId)
The Teller Drawer Identification Array (TellerDrwIdArray) includes the Teller Drawer Identification (TellerDrwId).
The Teller Drawer array allows for multiple Teller Drawers to be searched for in one request. This array is an or statement, not an and statement that can optionally be used in addition to the other filters.
A consumer request with Account Identification (AcctId) and Account Type (AcctType) returns all the qualified transactions for the requested Account Identification and Account Type.
A consumer request with only an Account Type returns all the qualified transactions for the requested Account Type.
The Remark (Rmk) element allows wild card searches. The service provider supports the Search Type attribute canonical values Exact, StartsWith, and Contains.
The service provider reserves the right to limit the response set.
The Teller Transaction Search root response (TellerTrnSrchRs_MType
) echoes
back the request elements along with the Transaction Search Record Array
(TrnSrchRecArray_AType
) which returns all the items related to the
Transaction Search request documented filters and two additional informational simple
elements, Transaction Date (TrnDt) and Transaction Entry Time
(TrnEntryTime).
The standard Search message header tenets are applicable.
The standard Search message tenets are applicable.
Adhere to the tenets for fault reporting.
Adhere to the tenets related to the correlation identifications.
TellerTrnSrchRq_MType
TellerTrnSrchRq_MType
is a message MType
element.
Contains:
Custom_CType
SrchMsgRqHdr_CType
TellerDrwIdArray_AType
Simple Elements
The following simple elements are contained within this message.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- CashInHighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- CashInLowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- CashOutHighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- CashOutLowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- Rmk
- Application or user remarks free form text.
- TellerBusEndDt
- The date that designates the ending point for date selections.
- TellerBusStartDt
- The date that designates the starting point for date selections.
- TellerTrnCode
- The type of teller transaction.
- TrnDetHighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- TrnDetLowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- TrnUsrId
- The user identification that initiated a transaction.
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_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.
- 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_CType
and the Message Request HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.
TellerDrwIdArray_AType
TellerDrwIdArray_AType
is an array
AType
element. This is an array of teller drawer identifications.
Contains:
TellerDrwIdRec_CType
TellerDrwIdRec_CType
TellerDrwIdRec_CType
is a complex CType
element.
Simple Elements
The following simple elements are contained within this message.
- TellerDrwId
- This is the teller drawer identification.
TellerTrnSrchRs_MType
TellerTrnSrchRs_MType
is a message MType
element.
Contains:
Custom_CType
SrchMsgRsHdr_CType
TellerDrwIdArray_AType
TellerTrnSrchRecArray_AType
Simple Elements
The following simple elements are contained within this message.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- CashInHighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- CashInLowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- CashOutHighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- CashOutLowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- Rmk
- Application or user remarks free form text.
- TellerBusEndDt
- The date that designates the ending point for date selections.
- TellerBusStartDt
- The date that designates the starting point for date selections.
- TellerTrnCode
- The type of teller transaction.
- TrnDetHighAmt
- The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
- TrnDetLowAmt
- The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
- TrnUsrId
- The user identification that initiated a transaction.
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_CType
MsgRecInfoArray_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_CType
and the Message Request HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.
TellerDrwIdArray_AType
TellerDrwIdArray_AType
is an array
AType
element. This is an array of teller drawer identifications.
Contains:
TellerDrwIdRec_CType
TellerDrwIdRec_CType
TellerDrwIdRec_CType
is a complex CType
element.
Simple Elements
The following simple elements are contained within this message.
- TellerDrwId
- This is the teller drawer identification.
TellerTrnSrchRecArray_AType
TellerTrnSrchRecArray_AType
is an array
AType
element. This is an array of teller transaction information that
provides general information about the transaction.
Contains:
TellerTrnSrchRec_CType