LOC Search
The LOC Search is primarily used to search for specific line(s) of credit held by a bank consumer. It uses a complex request message, LOCSrchRq_MType, which contains PersonName, LOCAcctId, and LOCAcctType to identify the search lines of credit. The response message, LOCSrchRs_MType, contains the LOCSrchRec to return details of the line of credit to the consumer.
Message Flow
The LOC search message flow is defined
as a simple request/response pattern using LOCSrchRq
and LOCSrchRs
.
Primary Request
The LOCSrchRq_MType
complex is
submitted to the Service Provider by the Third Party Consumer, containing
the consumer’s name and ID number, the LOC account number and LOC account
type.
Primary Response
The LOCSrchRs_MType
is returned by
the Service Provider, containing the submitted information to confirm the
request, and the LOCSrchRec
complex with simple
elements listed above to define the LOC results.
Line of Credit Search and Modification Business Case
In this business case, a consumer goes to a bank for a line of credit for his business. The bank needs to verify that an existing credit line does not exist.
Requesting LOC Search Information
The bank issues a
request to a Service Provider for information about a line of credit for
one of its customers using the LOCSrchRq_MTpe
message containing
the following values:
Complex Element | Simple Element | Entry Value |
---|---|---|
LOCSrchRq_MType | ||
PersonName_CType | ComName | John Doe |
LOC Search Response
The Service Provider issues a response confirming the existence of a line of credit. The response includes the following information:
Complex Element | Simple Element | Entry Value |
---|---|---|
LOCSrchRs_MType | ||
LOCSrchRec_CType | LOCAmt | 100000 |
LOCTotAdvaAmt | 75000 | |
LOCAvlBal | 25000 | |
LOCCurBal | 75000 | |
LOCStatus | Active | |
PersonName_CType | ComName | John Doe |
LOCSrchRec_CType
that are not
listed in this example. The elements listed are used to exemplify the
described business case.LOC Mod Request
Seeing that funds have been depleted, the bank issues a request to the Service Provider to increase the existing line of credit. The bank uses the following elements for the request:
Complex Element | Simple Element | Entry Value |
---|---|---|
LOCModRq_MType | LOCAcctId | 33231 |
LOCAcctType | 1 | |
LOCCustId | 151324 | |
Dlt | False | |
LOCRec_CType | LOCAmt | 250000 |
LOCStatus | Active |
LOCRec_CType
complex of the LOC
Modification service, only the elements having values to be changed are
required to be included in the request message. Other elements can be
included at the discretion of the Third Party Consumer, but only the
changed elements will be read by the Service Provider.LOC Mod Response
The Service Provider returns an
LOCModRs_MType
complex
containing the following element:
Complex Element | Simple Element | Entry Value |
---|---|---|
LOCModRs_MType | RsStat | Success |
LOCSrchRq_MType
LOCSrchRq_MType
is a message
MType
element. This is a major request complex and is
optional.
Contains:
Custom_CType
IncXtendElemArray_AType
PersonName_CType
SrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CustId
- The identifier attached to a customer.
- LOCAcctId
- The account identification that is charged for fees from line of credit services.
- LOCAcctType
- The account type that is charged for fees from line of credit services.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
IncXtendElemArray_AType
IncXtendElemArray_AType
is an array
AType
element.
Contains:
IncXtendElemInfo_CType
IncXtendElemInfo_CType
IncXtendElemInfo_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- XtendElem
- Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.
PersonName_CType
PersonName_CType
is a complex CType
element. It contains name information. This complex is optional.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType
is a complex CType
element.
Simple Elements
The following simple elements are contained within this complex.
- LegalName
- Used by entities like trusts, or businesses in the case where an
individual is doing business as a company, or when the legal name is different than the
ComName
. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType
is a complex
CType
element. This is a
standard request message 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.
- 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_CType
and the Message Request HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.
LOCSrchRs_MType
LOCSrchRs_MType
is a message
MType
element.
Contains:
Custom_CType
LOCSrchRecArray_AType
SrchMsgRsHdr_CType
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
LOCSrchRecArray_AType
LOCSrchRecArray_AType
is an array
AType
element. This is an array of responses for a line of
credit search.
Contains:
LOCSrchRec_CType
LOCSrchRec_CType
LOCSrchRec_CType
is a complex
CType
element.
Contains:
CustomLOCSrchRec_CType
PersonName_CType
Simple Elements
The simple elements contained within this complex are listed below.
- CustId
- The identifier attached to a customer.
- LOCAcctId
- The account identification that is charged for fees from line of credit services.
- LOCAcctType
- The account type that is charged for fees from line of credit services.
- LOCAdjAmt
- The number of adjustments made to a line of credit.
- LOCAmt
- The amount of the credit line.
- LOCAvlBal
- The outstanding available balance of the line of credit.
- LOCCode
- The code that defines the type of line of credit.
- LOCCommBal
- The outstanding committed funds of the line of credit.
- LOCCurBal
- The outstanding balance of the line of credit.
- LOCDesc
- The description of the code that defines the type of line of credit.
- LOCExpDt
- The line of credit expiration date.
- LOCGdnceAvlBal
- The guidance Line of Credit available balance amount.
- LOCGdnceBal
- The guidance Line of Credit balance amount.
- LOCGdnceOrder
- The guidance Line of Credit assigned order.
- LOCMasterAcctId
- The master credit line account ID for a multi-level credit line.
- LOCMasterAcctType
- The master credit line account type for a multi-level credit line.
- LOCParentAcctId
- The parent credit line account ID for a multi-level credit line.
- LOCParentAcctType
- The parent credit line account type for a multi-level credit line.
- LOCPrincRedAmt
- The amount of a Line of Credits Principal Reduction/Paydown available.
- LOCPrtcpCode
- The code that defines the line of credits participation activity.
- LOCPrtcpDesc
- The description of the code that defines the line of credits participation activity.
- LOCStat
- The status of the line of credit.
- LOCStatDesc
- The description of the status of the line of credit.
- LOCTotAdvaAmt
- The credit line total advances.
- LtrOfCrType
- Answers the question: Is the line of credit a letter of credit?
Canonical values are:
- false
- true
The default value is false.
CustomLOCSrchRec
Custom_CType
is a complex CType
element.
This element is optional.
PersonName_CType
PersonName_CType
is a complex CType
element. It contains name information. This complex is optional.
Contains:
X_PersonName
Simple Elements
The following simple elements are contained within this complex.
- ComName
- The common name. This is the full text line name like John Doe.
- FirstName
- The first name.
- LastName
- The last name.
- MiddleName
- The middle name.
X_PersonName_CType
x_PersonName_CType
is a complex CType
element.
Simple Elements
The following simple elements are contained within this complex.
- LegalName
- Used by entities like trusts, or businesses in the case where an
individual is doing business as a company, or when the legal name is different than the
ComName
. - NameSuffix
- The name suffix. For examples, Jr. or MD.
- SalName
- A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType
is a complex
CType
element. It searches specific message response
headers.
Contains:
jXchangeHdr_CType
MsgRecInfoArray_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_CType
and the Message Request HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-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 Soap Header Fault 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.