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

Transaction Modification

Enterprise SOAP API > API by Reference > Core Services > Transaction Modification

Transaction Modification

Transaction Modification is a jXchange service designed to provide a consumer the means to modify newly created transactions that have not posted to the application account.

Message Flow

In jXchange, the Transaction Modification service uses a typical exchange of MType messages to modify newly created transactions that have not posted to the application account.

Primary Request

The third-party consumer forwards the TrnModRq_MType message to the service provider.

The message contains the following simple elements:

  • AcctViewAvlBalCode
  • BatchNum
  • Dlt
  • SeqNum

The message contains the following complex elements:

  • AccountId_CType
  • Custom_CType
  • MsgRqHdr_CType
  • TrnModInfo_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 element:

  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

Transaction Modification Behavior

The AccountId is a required field. However, some Service Providers might not require the AccountId as part of the transaction key. The AccountId then behaves as verification that the submitted keys (sequence number and/or batch number) match the same account number.

The AccountId may not be able to be modified depending upon the Service Provider's business service behavior. This could require deletion of the transaction and submission of the transaction addition with the correct account identification.

A Service Provider should return a warning when an AvlBalBalcCode element is submitted in the TrnModRq_MType request, and it changes the transactional acceptance of the transaction.

Transaction Modification Business Case

The consumer is modifying a transaction in this example.

The Third Party Consumer sends the TrnModRq_MType message to the Service Provider with the following values:

Complex ElementSimple ElementEntry Value
AccountIdAcctId5551234555123456
 AcctTypeD
 BatchNum5
 SeqNum555101
Complex ElementSimple ElementEntry Value
TrnModInfoAmt150.00
 TrnCodeCode134
 EftTypeATM
 EffDt2009–03–03
 SrcCodeStore2
 ChkNum2015
 DrCrD
 TrnDescUpdate
 RefDescCode995511
 OffCodeGW
 BrCode560
 GlCostCtr175
 GlProdCode297
 GlInterfaceCode375
 RunNum222
 RtNum101000019
 FltSchedCode235
 FltDays030
 ImgNum55515
 ColBalAmt150.00
 AvlBalAmt150.00
 LdgrBalAmt150.00
 ChkDlvryMthdMail

The Service Provider returns the TrnModRs_MType containing RsStat with a value of Success.

TrnModRq_MType

TrnModRq_MType is a message MType element.

Contains:
  • AccountId_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType
  • TrnModInfo_CType

Simple Elements

The following simple elements are contained within this message.

AcctViewAvlBalCode
A code that would convey to the service provider the method to use for the calculation of the available balance for account balance displays.
BatchNum
The integer that groups transactions together. The batch number is often used to trace the origins of transactions.
Dlt

The delete element. Canonical values are:

  • false
  • true
SeqNum
The integer assigned to a specific transaction.

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

TrnModInfo_CType

TrnModInfo_CType is a complex CType element. This element is optional.

Contains:

  • TrnDesc references Rmk_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.
BrCode
The branch code.
ChkDlvryMthd
The method to deliver a check disbursement. Canonical values are:
  • Interoffice
  • Mail
  • 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.
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
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.
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.

TrnModRs_MType

TrnModRs_MType is a message MType element.

Simple Elements

Contains:
  • Custom_CType
  • MsgRsHdr_CType

The following simple elements are contained within this message.

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 Thu Feb 8 2024