Service Fee Search
Service Fee Search
Service Fee Search is a jXchange service designed to provide a means for a consumer to search for service fees as related to an account identification.
Message Flow
In jXchange, the Service Fee Search service uses a typical exchange of
MType messages to search for service fees as related to an account
identification.
Primary Request
The third-party consumer forwards the SvcFeeSrchRq_MType message to the
service provider.
The message contains the following simple elements:
- SvcFeeStat
- SvcFeeType
The message contains the following complex elements:
Custom_CTypeInAcctIdreferencesAccountId_CTypeSrchMsgRqHdr_CType
Primary Response
The service provider returns the SvcFeeSrchRs_MType message to the
consumer.
The message contains the following complex elements:
Custom_CTypeInAcctIdreferencesAccountId_CTypeSrchMsgRsHdr_CType
The message contains the following array:
SvcFeeSrchRecArray_AType
Service Fee Search Behavior
The SvcFeeSrchRq_MType request
message requires a valid account identification to be submitted.
The request allows for two filters: SrcFeeStat and SvcFeeType. These elements do not have a default. Therefore, any requests without these elements are to return an unfiltered response for the specific account identification.
The SvcFeeSrchRs_MType response message returns all of the service fees that
can be accessed to the submitted account identification in the request.
The SvcFeeSrchRs_MType response message contains a complex that could
eventually be re-used for future operations to add and modify service fee records.
SvcFeeSrchRq_MType
SvcFeeSrchRq_MType is a message
MType element.
Contains:
Custom_CTypeInAcctIdreferencesAccountId_CTypeSrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- SvcFeeType
- The type of service fee event. Canonical values are:
- OnDemand
- Stmt
- SvcFeeStat
- The status of the service fee event. Canonical values are:
- Active
- InActive
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
InAcctId references
AccountId_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.
- 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
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType is a complex
CType element. This is a
standard request message 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.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MaxRec
- The maximum number of records when multiple records are returned.
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.
SvcFeeSrchRs_MType
SvcFeeSrchRs_MType is a message
MType element.
Contains:
Custom_CTypeInAcctIdreferencesAccountId_CTypeSrchMsgRsHdr_CTypeSvcFeeSrchRecArray_AType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InAcctId
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
InAcctId references
AccountId_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.
- 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
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType is a complex
CType element. It searches
specific message response headers.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MoreRec
- Indicates if there are more records that could be returned.
Canonical values are:
- false
- true
- SentRec
- The number of records sent in the response.
- TotRec
- Indicates the total records the request selected, which could be
larger than
MaxRec.
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.
SvcFeeSrchRecArray_AType
SvcFeeSrchRecArray_AType is an array
AType element. This is an array of responses for service fee
search.
Contains:
SvcFeeSrchRec_CType
SvcFeeSrchRec_CType
SvcFeeSrchRec_CType is a complex
CType element.
Contains:
SvcFeeDescArrayreferencesRmk_ATypeSvcFeeInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- SvcFeeAmt
- The fee amount of the loan for some categories.
- SvcFeeCode
- The code that identifies the type of service fee applied to an account identification.
- SvcFeeDesc
- The description of the code that identifies the type of service fee applied.
- SvcFeeOrigTrnCode
- The code that identifies the behavior of a monetary transaction.
SvcFeeInfo_CType
SvcFeeInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- SvcFeeChgDt
- The scheduled service fee charge date.
- SvcFeeCycAmt
- The amount of fees for a service fee event for a statement cycle.
- SvcFeeCycCnt
- The count of number of occurrences for a service fee event for a statement cycle.
- SvcFeeDayOfMonth
- The day of the month of charge date for the service fee event.
- SvcFeeExpDt
- The expiration date.
- SvcFeeFreq
- The frequency of the service fee event.
- SvcFeeFreqUnits
- The units of frequency of the service fee event. Canonical
values are:
- Day
- Month
- SvcFeeLTDAmt
- The amount of fees for a service fee event for life of the event.
- SvcFeeLTDCnt
- The count of number of occurrences for a service fee event for the life of the event.
- SvcFeeMTDAmt
- The amount of fees for a service fee event for a calendar month.
- SvcFeeMTDCnt
- The count of number of occurrences for a service fee event for a calendar month.
- SvcFeeQTDAmt
- The amount of fees for a service fee event for a calendar quarter.
- SvcFeeQTDCnt
- The count of number of occurrences for a service fee event for a calendar quarter.
- SvcFeeStat
- The status of the service fee event. Canonical values are:
- Active
- InActive
- SvcFeeType
- The type of service fee event. Canonical values are:
- OnDemand
- Stmt
- SvcFeeWavCnt
- The count of number of free occurrences for a service fee event.
- SvcFeeYTDAmt
- The amount of fees for a service fee event for a calendar year.
- SvcFeeYTDCnt
- The count of number of occurrences for a service fee event for a calendar year.
SvcFeeDescArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
SvcFeeDescArray 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.