Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Teller Transaction Inquiry

Enterprise SOAP API > API by Reference > Teller System > Teller Transaction Inquiry

Teller Transaction Inquiry

Teller Transaction Inquiry is a jXchange service designed to allow consumers to inquire on teller transactions that consist of cash deposits, check deposits, cash withdrawals, and cash checks.

Message Flow

In jXchange, the Teller Transaction Inquiry service uses a typical exchange of MType messages to allow consumers to inquire on teller transactions that consist of cash deposits, check deposits, cash withdrawals, and cash checks.

Primary Request

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

  • ActIntentKey
  • TrnRcptId

Primary Response

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

  • ActIntent
  • ActIntentKey
  • TrnRcptId

Teller Transaction Inquiry Behavior

The Teller Transaction Inquiry (TellerTrnInq) service behavior is as follows.

The Teller Transaction Inquiry root request message (TellerTrnInqRq_MType) requires a Transaction Receipt Identification (TrnRcptId) simple element.

The Teller Transaction Inquiry root request message (TellerTrnInqRq_MType) optionally includes the Activity Intention element (ActIntent) with the default canonical value ReadOnly. The canonical values Upd and Dlt require the service provider to return the Activity Intention Key simple element (ActIntentKey) used for subsequent modification service with the adopted concurrency model.

The Teller Transaction Inquiry root response message (TellerTrnInqRs_MType) returns the Teller Transaction Information Record complex (TellerTrnInfoRec_CType), Activity Intention Key (ActIntentKey), Transaction Receipt Identification (TrnRcptId) echoed back from request and Activity Intention (ActIntent) echoed back from request.

The Teller Transaction Information Record complex (TellerTrnInfoRec_CType) includes Teller Transaction Information (TellerTrnInfo_CType), Teller Drawer Identification (TellerDrwId), Teller Transaction Code Description (TellerTrnCodeDesc), and Teller Business Date (TellerBusDt).

The standard Inquiry message tenets are applicable.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the correlation identifications.

Adhere to the tenets related to the Concurrency model.

TellerTrnInqRq_MType

TellerTrnInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

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

The default value is ReadOnly.

TrnRcptId
The receipt provided for a successful transaction entry.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRqHdr_CType

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

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType
Simple Elements

The following simple elements are contained within this complex.

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

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

Simple Elements

The following simple elements are contained within this complex.

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

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

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

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
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 credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

TellerTrnInqRs_MType

TellerTrnInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • TellerTrnInfoRec_CType

Simple Elements

The following simple elements are contained within this message.

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

The default value is ReadOnly.

ActIntentKey
The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
TrnRcptId
The receipt provided for a successful transaction entry.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

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

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType
jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

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

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
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 credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
MsgRecInfoArray_AType

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

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The Soap Header Fault 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.

TellerTrnInfoRec_CType

TellerTrnInfoRec_CType is a complex CType element.

Contains:

  • TellerTrnInfo_CType
Simple Elements

The following simple elements are contained within this message.

TellerBusDt
The teller business date.
TellerDrwId
This is the teller drawer identification.
TellerTrnCodeDesc
The description of the teller transaction code.
TellerTrnInfo_CType

TellerTrnInfo_CType is a complex CType element.

Contains:

  • CashMachArray_AType
  • TellerDrwComptArray_AType
  • TellerTrnDetArray_AType
Simple Elements

The following simple elements are contained within this message.

CashIn
Cash-in amount.
CashOut
Cash-out amount.
ChkCashAmt
The total number of checks cashed.
ChkDepAmt
The total number of checks deposited.
TellerTrnCode
The type of teller transaction.
TrnAmt
The amount of transactions.
TrnDt
The date assigned to transactions when it is different from the posting date.
TrnEntryTime
The time a transaction was accepted.
TrnUsrId
The user identification that initiated a transaction.
CashMachArray_AType

CashMachArray_AType is an array AType element. This is an array of cash machine information.

Contains:

  • CashMachTrnDet_CType
CashMachTrnDet_CType

CashMachTrnDet_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this message.

CashIn
Cash-in amount.
CashOut
Cash-out amount.
TellerDrwId
This is the teller drawer identification.
TellerDrwComptArray_AType

TellerDrwComptArray_AType is an array AType element. This is an array of compartment information.

Contains:

  • TellerDrwComptRec_CType
TellerDrwComptRec_CType

TellerDrwComptRec_CType is a complex CType element.

Contains:

  • CashCntDet_CType
Simple Elements

The following simple elements are contained within this message.

CashCntType
The cash type. Canonical values are:
  • CashIn
  • CashOut
ComptId
The compartment identification.
CashCntDet_CType

CashCntDet_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this message.

CashAmt
The amount or quantity.
CashItemCnt
The number/count for a specific currency.
CurrDenomCode
The code that references the type of currency denomination.
CurrDenomDesc
The description of the currency code denomination.
TellerTrnDetArray_AType

TellerTrnDetArray_AType is an array AType element. This is an array of teller transaction information.

Contains:

  • TellerTrnDet_CType
Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Jan 24 2022