Enterprise Solutions

Teller Currency Transaction Addition

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

Teller Currency Transaction Addition

Teller Currency Transaction Addition is a jXchange service designed to allow consumers to add teller currency transactions.

Message Flow

In jXchange, the Teller Currency Transaction Addition service uses a typical exchange of MType messages to add teller currency transactions.

Primary Request

The consumer forwards the TellerCurrTrnAddRq_MType message to the service provider.

The message contains the following simple elements:

  • CTRRptDt
  • TrnRcptId

The message contains the following complex elements:

  • CurrTrnInfo_CType
  • Custom_CType
  • MsgRqHdr_CType

The message contains the following array:

  • ErrOvrRdInfoArray_AType

Primary Response

The service provider returns the TellerCurrTrnAddRs_MType message to the consumer.

The message contains the following simple elements:

  • CurrTrnId
  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

Teller Currency Transaction Addition Behavior

Teller Currency Transaction Addition (TellerCurrTrnAdd) service behavior is as follows.

The Teller Currency Transaction Addition root request message (TellerCurrTrnAddRq_MType) requires the Currency Transaction Information complex (CurTrnInfo_CType).

The Teller Currency Transaction Addition root request message (TellerCurrTrnAdd_MType) optionally includes the Transaction Receipt Identification (TrnRcptId) and Currency Transaction Report Date (CTRRptDt) simple elements. The Transaction Receipt Identification (TrnRcptId) returns in Teller Transaction Add Response (TellerTrnAddRs_MType), used to associate the currency transaction to a specific teller transaction.

The Currency Transaction Information complex (CurrTrnInfo_CType) contains the Currency Transaction Account Array (CurrTrnAcctArray_AType) and the Currency Transaction Customer Array (CurrTrnCustArray_AType).

The Currency Transaction Account Array (CurTrnAcctArray_AType) contains the Currency Transaction Account Detail complex (CurrTrnAcctDetail_CType).

The Currency Transaction Account Detail complex (CurrTrnAcctDetail_CType) contains the following simple elements:

  • Account Identification (AcctId)
  • Account Type (AcctType)
  • Cash In (CashIn)
  • Cash Out (CashOut)
  • CTR Category Type (CTRCatType)

The Currency Transaction Customer Array (CurrTrnCustArray_AType) contains the Currency Transaction Customer Detail Record complex (CurrTrnCustDetail_CType), which includes the following elements:

  • CTREntityType (CTREntityType)
  • Customer Identification (CustId)
  • Non Customer Identification (NonCustId)
  • Customer Name (CustName)
  • Tax Identification (TaxId)
  • TIN Code (TINCode)
  • Identification Verify Array (IdVerifyArray_AType)
  • Transaction Owner Exempt Reason Type (TrnOwnerExmpRsnType)
Note: Either the Customer Identification (CustId) or the Non Customer Identification (NonCustId) appears throughout the suite of services, not both.

The Teller Currency Transaction Addition root response message (TellerCurrTrnAdd_MType) returns the Currency Transaction Identification (CurrTrnId) and Response Status (RsStat) simple elements. The consumer requires the Currency Transaction Identification (CurrTrnId) to send a Teller Currency Transaction Modification or 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.

TellerCurrTrnAddRq_MType

TellerCurrTrnAddRq_MType is a message MType element.

Contains:

  • CurrTrnInfo_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CTRRptDt
The date of the currency transaction report.
TrnRcptId
The receipt provided for a successful transaction entry.

CurrTrnInfo_CType

CurrTrnInfo_CType is a complex CType element.

Contains:

  • CurrTrnActArray_AType
  • CurrTrnCustArray_AType
  • Custom_CType
CurrTrnActArray_AType

CurrTrnActArray_AType is an array AType element. This is an array of currency transaction account information.

Contains:

  • CurrTrnAcctDetail_CType
CurrTrnAcctDetail_CType

CurrTrnAcctDetail_CType is a complex CType element.

Contains:

  • Custom_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.
CashIn
Cash-in amount.
CashOut
Cash-out amount.
CTRCatType
The category related to the currency transaction report. Canonical values are:
  • FornCurr
  • WireXfer
  • NegInstPur
  • NetInstCash
  • CurrExch
  • DepWthdwl
  • Oth
  • AcctAffWthdwl
  • Pmt
  • Adv
  • PrepaidAccess
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

CurrTrnCustArray_AType

CurrTrnCustArray_AType is an array AType element. This is an array of individuals affected by the transaction.

Contains:

  • CurrTrnCustDetail_CType
CurrTrnCustDetail_CType

CurrTrnCustDetail_CType is a complex CType element.

Contains:

  • CustName references PersonName_CType
  • Custom_CType
  • IdVerifyArray_AType
Simple Elements

The following simple elements are contained within this message.

CTREntityType
Identifies the party of the currency transaction report. Canonical values are:
  • Benf
  • Cour
  • TrnOwner
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
NonCustId
The identifier attached to a customer.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
TINCode
The code that designates the type of tax identification number. Canonical values are:
  • SSN
  • EIN
  • Forn

TINCode is a hybrid open enumeration.

TrnOwnerExmpRsnType
Reason why the individual conducting the transaction is exempt from reporting. Canonical values are:
  • ArmoredCar
  • ATM
  • ConductBenf
  • MailDep
  • MultiTrn
  • NightDep
CustName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

CustName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

IdVerifyArray_AType

IdVerifyArray_AType is an array AType element. This is an array of simple elements used to define identification of verification values.

Contains:

  • IdVerify_CType
IdVerify_CType

IdVerify_CType is a complex CType element. This element contains basic identification verification information and is optional.

Simple Elements

The following simple elements are contained within this complex.

IdIssueBy
The individual that issued the identification value IdVerifyId.
IdVerifyBy
The individual that verified the authenticity of the identification value IdVerifyId.
IdVerifyCode
The identification code that is used to authenticate the customer.
IdVerifyDesc
The description of the identification code that is used to authenticate the customer.
IdVerifyVal
The identification value that is used to authenticate the customer.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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.

TellerCurrTrnAddRs MType

TellerCurrTrnAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

CurrTrnId
An identifier provided for each submitted currency transaction report.
RsStat
The status of the response. Canonical values are:
  • Fail
  • Success

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