Enterprise Solutions

Letter of Credit Inquiry

Enterprise SOAP API > API by Reference > Core Services > Letter of Credit Inquiry
Letter of Credit Inquiry

Letter of Credit Inquiry

Letter of Credit Inquiry is a jXchange service designed to inquire on the letters of credit stored within the provider application.

Message Flow

In jXchange, the Letter of Credit Inquiry service uses a typical exchange of MType messages to allow inquiry of the letters of credit stored within the provider application.

Primary Request

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

The message contains the following simple elements:

  • CustId
  • LOCAcctId

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the LtrOfCrInqRq_MType message to the third-party consumer. The message contains only those lines of credit that are classified as a letter of credit.

The message contains the following simple elements:

  • CustId
  • LOCAcctId

The message contains the following complex elements:

  • Custom_CType
  • LtrOfCrInqRec_CType
  • MsgRsHdr_CType

LtrOfCrInqRq_MType

LtrOfCrInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
LOCAcctId
The account identification that is charged for fees from line of credit services.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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.

LtrOfCrInqRs_MType

LtrOfCrInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • LtrOfCrInqRec_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
LOCAcctId
The account identification that is charged for fees from line of credit services.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

LtrOfCrInqRec_CType

LtrOfCrInqRec_CType is a complex CType element.

Contains:

  • Custom_CType

Simple Elements

The following simple elements are contained within this complex.

LOCAmt
The amount of the credit line.
LOCAvlBal
The outstanding available balance of the line of credit.
LOCAvlCalcType
Defines the availability calculation method for credit lines. The canonical values are:
  • LOCAmt - Credit Line Amount
  • LOCCurBal - Loan Balance
LOCBrCode
The branch code.
LOCBrDesc
A description of the branch name. It includes the Rstr attribute.
LOCCallRptCode
The call report code.
LOCCallRptDesc
The call report code description.
LOCCode
The code that defines the type of line of credit.
LOCCollatCode
The collateral code. This code is bank-defined and is used to define the type of collateral used to secure the loan.
LOCCollatDesc
The collateral code description.
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.
LOCFrzAmt
The amount of the credit line that should be frozen, disallowing advances.
LOCGdnceAvlBal
The guidance line of credit available balance amount.
LOCGdnceBal
The guidance line of credit balance amount.
LOCGdnceBorwAck

Answers the question: Has the line of credit borrower acknowledge the guidance? Canonical values are:

  • false
  • true

The default value is false.

LOCGdnceRedType

Answers the question: What balance is used for the reduction to the line of credit level balance? Canonical values are:

  • AvlBal
  • LOCAmt

The default value is LOCAmt.

LOCGdnceType

Answers the question: Does the line of credit subject to guidance? Canonical values are:

  • false
  • true

The default value is false.

LOCLastMainDt
The last maintenance date.
LOCLastStmtDt
The last statement date.
LOCMasterAcctId
The master credit line account ID for a multi-level credit line.
LOCOffCode
The code that designates the financial institution officer.
LOCOffDesc
The officer short name.
LOCOrigAmt
The original amount of the credit line.
LOCOrigTerm
The original integer value of the term of the credit line.
LOCOrigTermUnit
The original credit line term. Canonical values are:
  • Days
  • Months
  • SemiMonthly
  • Years
LOCPrincRedAmt
The amount of a Line of Credits Principal Reduction/Paydown available.
LOCPrtCnsldtStmt
Should a consolidated statement be printed?
LOCSemiDay1
The day of month for first semi-monthly payment.
LOCSemiDay2
The day of month for second semi-monthly payment.
LOCStatDesc
The description of the status of the line of credit.
LOCStat
The status of the line of credit.
LOCStmtDay
The statement day.
LOCStmtFreqCode
The statement frequency code.
LOCStmtFreqDesc
The description of the statement frequency code.
LOCStmtFreq
The statement frequency.
LOCTaxRefId
The credit line tax reference number. Tax reference number for credit line. For informational purposes.
LOCTotAdvaAmt
The credit line total advances.
LtrOfCrAvl
The outstanding available balance of the line of credit.
LtrOfCrLmt
The line of credit limit.
MaxTrancheCrtCnt
The total count of records.
MLLIncCombStmt

Include on combined statement? Indicates if this account is to be included in combined statement information. Canonical values are:

  • false
  • true

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