Transaction Add
Transaction Addition
Transaction Addition is a jXchange service designed to allow a consumer to create monetary transactions.
Message Flow
In jXchange, the Transaction Addition service uses a typical exchange of MType messages to add monetary
transactions to a service provider.
Primary Request
The third-party consumer forwards the TrnAddRq_MType message to the
service provider.
The message contains the following simple element:
- AvlBalCalcCode
The message contains the following complex elements:
AccountId_CTypeCustom_CTypeMsgRqHdr_CTypeTrnInfo_CType
The message contains the following array:
ErrOvrRdInfoArray_AType
Primary Response
The service provider returns the TrnAddRs_MType message to the
third-party consumer.
The message contains the following simple elements:
- BatchNum
- SeqNum
- RsStat
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
Transaction Add Behavior
The MemoPostHldOvr element's default value is false.
The MemoPostHldOvr element only works with the MemoPostOnly element. A service provider should ignore the element when delivered by the third-party consumer without the MemoPostOnly element, or the data value of the MemoPostOnly element alerts the service provider that it is not for memo posting.
The EffDt element is used for transactions added that are not memo post only but are for future dated transactions. The service provider's application would continue to memo post based on their application's built-in behavior for future dated transactions.
The service provider uses the calculated available balance based on the submitted AvlBalCalcCode for transaction approval. The service provider uses their application's default available balance for transaction approval when the AvlBalCalcCode is absent and returns a fault when an invalid AvlBalCalcCode is submitted.
Transaction Add Business Case
The consumer is adding a transaction in this example.
The Third Party Consumer sends the TrnAddRq_MType message to the
Service Provider with the following values:
| Complex Element | Simple Element | Entry Value |
|---|---|---|
AccountId | AcctId | 5551234555123456 |
AcctType | D | |
TrnInfo | Amt | 157.50 |
TrnCodeCode | 123 | |
EffDt | 2008-01-09 | |
SrcCode | Store1 | |
BatchNum | 5 | |
DrCr | D | |
BrCode | 539 | |
GlCostCtr | 177 | |
GlProdCode | 284 | |
RtNum | 000510015 | |
ImgNum | 55515 | |
MemoPostOnly | N | |
ColBalAmt | 157.50 | |
AvlBalAmt | 157.50 | |
LdgrBalAmt | 157.50 | |
SrcFundsCode | A7 |
The Service Provider returns the TrnAddRs_MType with the following
values:
| Complex Element | Simple Element | Entry Value |
|---|---|---|
BatchNum | 5 | |
SeqNum | 555101 | |
RsStat | Success |
TrnAddRq_MType
TrnAddRq_MType is a message MType element.
Contains:
AccountId_CTypeCustom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CTypeTrnInfo_CType
Simple Elements
The following simple elements are contained within this message.
- AvlBalCalcCode
- A code that conveys to the service provider the method to use for the calculation of the available balance.
AccountId_CType
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
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
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_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.
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.
TrnInfo_CType
TrnInfo_CType is a complex CType element.
Contains:
TrnDescArrayreferencesRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- Amt
- The amount or quantity.
- AvlBalAmt
- The amount that should be applied to the available balance of the account.
- BatchNum
- The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
- BrCode
- The branch code.
- ChkDlvryMthd
- The method to deliver a check disbursement. Canonical values
are:
- Interoffice
- NA
- Pickup
- ChkNum
- The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
- ColBalAmt
- Amount that should be applied to the collected balance of the account.
- DrCr
- Either debit or credit. Canonical values are:
- Dr
- Cr
This element is a hybrid enumeration.
- EffDt
- The date assigned to transactions when it is different from the posting date.
- EFTTrnAuthAmt
- The amount for which an EFT transaction was authorized.
- EftType
- The type of electronic transaction.
- FltDays
- Represents the float schedule to be used by the service provider.
- FltSchedCode
- Represents the float schedule to be used by the service provider.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- GLInterfaceCode
- A code that describes the GL account number that this transaction's interface applies.
- GLProdCode
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- ImgNum
- The numbers or characters that identify the key of the transaction's stored image.
- LdgrBalAmt
- Amount that should be applied to the ledger balance of the account.
- LnSvcTrnCode
- The transaction code for serviced loans to designate the type of transaction.
- LnUnitId
- The identification assigned to a unit of a loan.
- 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
- MemoPostOnly
- If a Y is sent, then the transaction is only to be memo posted.
- OffCode
- The code that designates the financial institution officer.
- RefDescCode
- A code that references a longer description. Used mostly in GL applications where a standard description is used so often that a code replacement is preferable.
- RtNum
- Routing number.
- RunNum
- The run number. A way of grouping items together. Typical series is Run/Batch/Seq.
- SrcCode
- Source code. The source of a transaction, or where it was generated from.
- SrcFundsCode
- A code that represents the source of funds for credit transactions and the outgoing source for debit transactions.
- TrnAuthBalAmt
- The account balance that was used for authorization of a transaction.
- TrnCodeCode
- The code that identifies the behavior of a monetary transaction.
TrnDescArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
TrnDescArray 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.
TrnAddRs_MType
TrnAddRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- BatchNum
- The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
- SeqNum
- The integer assigned to a specific transaction.
- 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_CTypeMsgRecInfoArray_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_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.