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 Addition

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

Teller Transaction Addition

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

Message Flow

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

Primary Request

The consumer forwards the TellerTrnAddRq_MType message to the service provider.

The message contains the following simple elements:

  • TellerBusId
  • TellerDrwId

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType
  • TellerTrn_CType

The message contains the following array:

  • ErrOvrRdInfoArray_AType

Primary Response

The service provider returns the TellerTrnAddRs_MType message to the consumer.

The message contains the following simple elements:

  • RsStat
  • TrnRcptId

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

Teller Transaction Addition Behavior

The Teller Transaction Addition (TellerTrnAdd) service behavior is as follows:

The Teller Transaction Addition root request message (TellerTrnAdd_MType) requires a Teller Drawer Identification (TellerDrwId) and Teller Transaction complex (TellerTrn_CType).

The Teller Transaction Addition root request message (TellerTrnAdd_MType) optionally includes the Teller Business Date (TellerBusDt) simple element.

The Teller Transaction complex (TellerTrn_CType) includes Teller Transaction Code (TellerTrnCode), Cash In (CashIn), Cash Out (CashOut), Check Deposit Amount (ChkDepAmt), Check Cash Amount (ChkCashAmt), Transaction Amount (TrnAmt), Transaction Date (TrnDt), Transaction Entry Time (TrnEntryTime), Teller Transaction Detail Array (TllerTrnDetArray_AType), Teller Drawer Compartment Array (TellerDrwComptArray_AType), and Cash Machine Array (CashMachArray_AType).

The Teller Transaction Detail Array complex (TellerTrnDetailArray_AType) includes Teller Transaction Item Identification (TellerTrnItemId), Amount (Amt), Account Id (AcctId), Account Type (AcctType), Check Number (ChkNum), Check Type (ChkType), and Remark Array (RmkArray).

The Teller Drawer Compartment Array (TellerDrwComptRecArray_AType) includes Compartment Identification (ComptId), Cash Count Type (CashCntType), and Cash Count Detail complex (CashCntDet_CType).

The Cash Count Detail complex (CashCntDet_CType) includes Currency Denomination Code (CurrDenomCode), Currency Denomination Description (CurrDenomDesc), Cash Item Count (CashItemCnt), and Cash Amount (CashAmt).

The Cash Machine Array (CashMachArray_AType) includes Teller Drawer Identification (TellerDrwId), Cash In (CashIn), and Cash Out (CashOut).

The Teller Transaction Addition root response message (TellerTrnAdd_MType) returns the Transaction Receipt Identification (TrnRcptId) and Response Status (RsStat) simple elements. The Transaction Receipt Identification (TrnRcptId) is a required simple element that can be made up of any keys required (DrwNum, TrnNum, ProcDt, etc.). The consumer must have the Transaction Receipt Identification (TrnRcptId) to send a Teller Transaction Modification request or Teller Transaction Inquiry request.

The standard Addition message tenets are applicable.

Adhere to the tenets related to the JHANull attribute.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the correlation identifications.

TellerTrnAddRq_MType

TellerTrnAddRq_MType is a message MType element.

Contains:

  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType
  • TellerTrn_CType

Simple Elements

The following simple elements are contained within this message.

TellerBusDt
The teller business date.
TellerDrwId
This is the teller drawer identification.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ErrOvrRdInfoArray_AType

ErrOvrRdInfoArray_AType is an array AType element. This is an array of overrides for faults.

Contains:

  • ErrOvrRd_CType
ErrOvrRd_CType

ErrOvrRd_CType is a complex CType element. This element is used to override errors created in a previous request. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

BusSvcType
The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
ErrCode
The error code.

MsgRqHdr_CType

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

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType
Simple Elements

The following simple elements are contained within this complex.

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

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

Simple Elements

The following simple elements are contained within this complex.

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

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

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

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

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

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

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

TellerTrn_CType

TellerTrn_CType is a complex CType element.

Contains:

  • TellerTrnInfo_CType
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 complex.

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 complex.

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
TellerTrnDt_CType

TellerTrnDt_CType is a complex CType element.

Contains:

  • RmkArray references Rmk_AType
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.
Amt
The amount or quantity.
ChkNum
The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
ChkType
The type of check. Canonical values are:
  • Forn
  • OnUs
TellerTrnItemId
Identifies the teller transaction item that makes up the teller transaction.
RmkArray

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

RmkArray references Rmk_AType

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.

TellerTrnAddRs_MType

TellerTrnAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

RsStat
The status of the response. Canonical values are:
  • Fail
  • Success
TrnRcptId
The receipt provided for a successful transaction entry.

TellerTrnAddRs_MType

TellerTrnAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
Simple Elements

The following simple elements are contained within this message.

RsStat
The status of the response. Canonical values are:
  • Fail
  • Success
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
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

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

MsgRecInfoArray_AType

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

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.
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