FASB91 Modification
FASB91 Mod
FASB 91 Mod is a service of jXchange provided to modify or delete existing listings of FASB 91 information on a Service Provider.
Message Flow
FASB 91 Mod is typically accomplished
through the exchange of MType complexes between the
Service Provider and the Third Party Consumer.
Primary Request
The Third Party Consumer forwards the
FASB91ModRq_MType complex
to the Service Provider. It contains an error override complex, account ID
number, FASB 91 category, Delete element and/or the FASB91InfoRec_CType to define the
information to be modified or deleted in connection with the account. If a
deletion is required, the default value of False
for the Dlt element must
be reset to True before the message is submitted.
In a modification, only the simple elements with values to be changed are
required.
Primary Response
Once the FASB91 Mod information has
been received and the listing is either modified or deleted by the Service
Provider, the FASB91ModRs_MType complex is
returned to the Third Party Consumer. That message contains the RsStat element, stating if the
requested modification or deletion was completed
successfully.
FASB91ModRq_MType
FASB91ModRq_MType is a message
MType element.
Contains:
Custom_CTypeErrOvrRdInfoArray_ATypeFASB91InfoRec_CTypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- Dlt
- The delete element. Canonical values are:
- false
- true
- FASB91AcctId
- The number or character that identifies an account record.
- FASB91AcctType
- The number or character that categorizes the AcctId.
- FASB91Cat
- The category of the type of FASB account. Canonical values are:
- Cost
- Fee
- FASB91Key
- This element is returned in search/inquiry requests and is needed to modify or delete an FASB record.
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.
FASB91InfoRec_CType
FASB91InfoRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- FASB91AmrtzCode
- The code that identifies the type of amortization method to be used.
- FASB91AmrtzSoldCode
- The code that identifies if the FASB record should continue to be amortized after the sale of the loan on the secondary market.
- FASB91AmrtzTerm
- The amount of time the FASB record should be amortized.
- FASB91AmrtzTermUnit
- The time unit to amortize the FASB record. Canonical values are:
- Days
- Months
- NA
- SemiMonthly
- Years
- FASB91AutoChg
- The FASB record should automatically be aligned with the corresponding loan account record.
- FASB91BrCode
- The branch code.
- FASB91CustId
- The identifier attached to a customer.
- FASB91Fee
- The gross amount of fees collected.
- FASB91FirstPmtDt
- The first payment date.
- FASB91GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- FASB91GLProdCode
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- FASB91GroupCode
- Used to group loans of different types for general ledger reporting purposes. It may also be used to group customer accounts together.
- FASB91IntRate
- The interest rate.
- FASB91LastMainDt
- The last maintenance date.
- FASB91LOC
- The FASB91 record for a line of credit.
- FASB91MatDt
- The amortization maturity date which can differ from the loan maturity date.
- FASB91NxtProcDt
- The date that references when the FASB record should be processed.
- FASB91OddDayCode
- The code that defines the behavior of the first payment odd days accrual.
- FASB91OrigDt
- The original loan date for FASB calculations.
- FASB91PmtDayOfMonth
- The day of month for payment. This code is only required if the payment due date is the 29th of the month.
- FASB91Proceed
- The original amount of the FASB record.
- FASB91RptFee
- The amount of fees reported for the FASB record.
- FASB91SemiDay1
- The day of month for first semi-monthly payment.
- FASB91SemiDay2
- The day of month for second semi-monthly payment.
- FASB91TypeCode
- The code that identifies the type of FASB record.
- FASB91Yield
- The FASB yield for interest yield calculations.
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.
FASB91ModRs_MType
FASB91ModRs_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.