Account Exception Transaction Modification
Account Exception Transaction Modification
Account Exception Transaction Modification is a jXchange service designed to allow consumers to modify and work account transaction exceptions.
Message Flow
In jXchange, the Account Exception Transaction Modification service uses a typical exchange
of MType messages to allow consumers to modify and work account transaction
exceptions.
Primary Request
The consumer forwards the AcctExcTrnModRq_MType message to
the service provider. The message contains the following elements:
AccountId_CType- ActIntentKey
Custom_CType- Dlt
- ExcItemId
- ExcTrnRec
ExcTrnRec_CTypeModRmkArrayMsgRqHdr_CType
Primary Response
The service provider returns the AcctExcTrnModRs_MType message to
the consumer. The message contains the following elements:
Custom_CType- RsStat
Account Exception Transaction Modification Behavior
The Account Exception Transaction Modification (AcctExcTrnMod) service behavior is
as follows.
The Account Exception Transaction Modification root request message
(AcctExcTrnModRq_MType) requires a valid Account Identifier
(AccountId_CType) and the Exception Item Identifier
(ExcItemId) and Activity Intention key
(ActIntentKey) simple elements. The element values are obtained from
the Account Exception Transaction Search response
(AcctExcTrnSrchRs_MType).
The Delete simple element value true conveys to the service provider to delete the Account Exception Transaction record as related to the keys included in the request if permissible by the service provider.
The Modification Remark Array (ModRmkArray_AType) is any comments related to
the action related to the modification.
The Exception Transaction Record complex (ExcTrnRec_CType) contains the
elements that can be modified for a transaction exception.
The Account Exception Transaction Inquiry response (AcctExcTrnInqRs_CType)
contains the element for a side-by-side comparison of the transaction exception.
The Exception Transaction Record complex (ExcTrnRec_CType) contains the
following elements:
- Updated Check Number (UpdChkNum)
- Effective Date (EffDt)
- Exception Return Source Code (ExcRetSrcCode)
- Updated Account Identifier (UpdAcctId)
- Updated Account Type (UpdAcctType)
- Updated Transaction Code (UpdTrnCodeCode)
- Exception Disposition Code (ExcDispCode)
- Exception Return Reason Code (ExcRetRsnCode)
- Exception Action Code (ExcActnCode)
The standard tenets for modification services are applicable.
Adhere to the tenets for fault reporting.
Adhere to the tenets related to the concurrency model.
Adhere to the tenets related to the correlation identifications.
Adhere to the tenets related to the JHANull attribute.
AcctExcTrnModRq_MType
AcctExcTrnModRq_MType is a message MType
element.
Contains:
AccountId_CTypeCustom_CTypeExcTrnRec_CTypeModRmkArrayreferencesRmk_ATypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ActIntentKey
- The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
- Dlt
- The delete element. Canonical values are:
- false
- true
- ExcItemId
- The identifier assigned to a specific account exception item.
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.
ExcTrnRec_CType
ExcTrnRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- EffDt
- The date assigned to transactions when it is different from the posting date.
- ExcActnCode
- The code for an account exception item that conveys the action that was taken to the item.
- ExcDispCode
- The code for an account exception item that conveys the disposition of the item.
- ExcRetRsnCode
- The code for an account exception item that conveys the reason the item was returned.
- ExcRetSrcCode
- The code that describes the recipient source of the return item.
- UpdAcctId
- The number or character that identifies an account record.
- UpdAcctType
- The number or character that categorizes the AcctId.
- UpdChkNum
- The numbers or characters assigned to monetary drafts, often times referred to as the serial number.
- UpdTrnCodeCode
- The code that identifies the behavior of a monetary transaction.
ModRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
ModRmkArray 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.
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.
AcctExcTrnModRs_MType
AcctExcTrnModRs_MType is a message MType
element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
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_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.