Developer Programs

Learn

Docs
Important notification about upcoming changes to the DMZ environment. Please read.

Logical Terminal ISO Report Details Reply

Enterprise SOAP API > API by Reference > Core Services > Logical Terminal ISO Report Details Reply

Logical Terminal ISO Report Details Reply

The Logical Terminal ISO Report Details Reply service (LTermISORptDetailsReply) provides details of a range of message sequence numbers associated with a given endpoint for the current Fedwire® funds-transfer business day.

Message Flow

In jXchange, the Logical Terminal ISO Report Details Reply service uses a typical exchange of MType messages to provide details of a range of message sequence numbers associated with a given endpoint for the current Fedwire® funds-transfer business day.

Primary Request

The consumer forwards the FedWireRetRsISOReplyRq_MType message to the service provider.

The message contains the following simple elements:

  • ActRptType
  • EndRptSeq
  • LastPgType
  • PgNum
  • RptCrtTimeDate
  • StartRptSeq

The message contains the following complex elements:

  • Custom_CType
  • FedLineHdr_CType
  • MsgRqHdr_CType

The message contains the following arrays:

  • RptEntryArray_AType
  • TrnSumArray_AType

Primary Response

The service provider returns the FedWireRetRsISOReplyRs_MType message to the consumer.

The message contains the following simple element:

  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • FedLineHdr_CType
  • MsgRsHdr_CType

LTermISORptDetailsReplyRq_MType

LTermISORptDetailsReplyRq_MType is a message MType element.

Contains:

  • Custom_CType
  • FedLineHdr_CType
  • MsgRqHdr_CType
  • RptEntryArray_AType
  • TrnSumArray_AType

Simple Elements

The following simple elements are contained within this message.

ActRptType
Identifies the type of activity report. Canonical values are:
  • EndDay
  • IntraDay
EndRptSeq
A sequence identifier used as a filter for reports.
LastPgType
Answers the question: Is this the last page? Canonical values are:
  • true
  • false
PgNum
The page number.
RptCrtTimeDt
The time/date stamp that a report was created.
StartRptSeq
A sequence identifier used as a filter for reports.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

FedLineHdr_CType

FedLineHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

FinInstRtId
The financial institution's routing and transit identification.
LTermId
An identification provided to a logical terminal that is unique within a financial institution.
UsrCorrelId
An identification provided by a consumer's application to correlate messages with the FRB.

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.

RptEntryArray_AType

RptEntryArray_AType is an array AType element. This element is an array of entries for reporting.

Contains:

  • RptEntryRec_CType

RptEntryRec_CType

RptEntryRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

BusDt
The system date.
BusTimeDt
The time/date stamp of the transaction.
DrCr
Either debit or credit. Canonical values are:
  • Dr
  • Cr

This element is a hybrid enumeration.

IMAD
The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire message during processing and transmission.
LocalTrfType
Specifies a local instrument, local clearing option, or further qualifies the service or service level. Canonical values are:
  • AcctCoverPmt
  • AcctCustTrf
  • AcctFinInstTrf
  • CustCoverPmt
  • CustDrawdwn
  • CustDrawdwnRq
  • CustTrf
  • FinInstDrawdwn
  • FinInstDrawdwnRq
  • FinInstTrf
OMAD
The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire message during processing and transmission.
OrignChanCode
The Fed Channel code for transaction delivery.
OrignFinInstRtId
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.
RecvChanCode
The Fed Channel code for transaction delivery.
RecvFinInstRtId
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.
TranStatType
Identifies the type of status. Canonical values are:
  • Failed
  • Pend
  • TrnBook
  • TrnInfo
TrnAmt
The amount of transactions.
TrnCodeCode
The code that identifies the behavior of a monetary transaction.
TrnCodeDesc
The description of the code that identifies the behavior of a monetary transaction.
TrnRmk
Application or user remarks free-form text.
WireInstrId
The instruction identification is a point-to-point reference that can be used between the instructing party and the instructed party to refer to the individual instruction.
WireUETR
A universally unique identifier to provide an end-to-end reference.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

TrnSumArray_AType

TrnSumArray_AType is an array AType element. This element is an array of transaction summaries.

Contains:

  • TrnSumRec_CType

TrnSumRec_CType

TrnSumRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements
The following simple elements are contained within this complex.
CrTrnAmt
The amount of transactions.
CrTrnCnt
The count/number of transactions.
DrCr
Either debit or credit. Canonical values are:
  • Dr
  • Cr

This element is a hybrid enumeration.

DrTrnAmt
The amount of transactions.
DrTrnCnt
The count/number of transactions.
TrnCnt
The count/number of transactions.
TrnCodeCode
The code that identifies the behavior of a monetary transaction.
TrnCodeDesc
The description of the code that identifies the behavior of a monetary transaction.
TrnNetAmt
The amount of transactions.
TrnNetCnt
The count/number of transactions.
TrnTimeDt
The time/date stamp of the transaction.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

LTermISORptDetailsReplyRs_MType

LTermISORptDetailsReplyRs_MType is a message MType element.

Contains:

  • Custom_CType
  • FedLineHdr_CType
  • MsgRsHdr_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.

FedLineHdr_CType

FedLineHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

FinInstRtId
The financial institution's routing and transit identification.
LTermId
An identification provided to a logical terminal that is unique within a financial institution.
UsrCorrelId
An identification provided by a consumer's application to correlate messages with the FRB.

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 Wed Oct 2 2024