FedWire Statement Received
FedWire Statement Received
FedWire Statement Received is a jXchange service that provides the consumer with the close of business date for the delivered subsidiary statement.
Message Flow
In jXchange, the FedWire Statement Received service uses a typical exchange of
MType messages. This
service is called by the FGA when BroadcastAndStatementsMessage (GIF100) messages with a
MSG-ID of FT1020 are received from the Federal Reserve.
Primary Request
The consumer forwards the FedWireStmtRcvRq_MType message to
the service provider. The message contains:
FedLineRptHdr_CType- FedWireStmtDt
- FedWireStmtPkg
- FinInstRtId
- LTermId
MsgRqHdr_CType
Primary Response
The service provider returns the FedWireStmtRcvRs_MType message to
the consumer. The message contains:
MsgRsHdr_CType- RsStat
FedWire Statements Behavior
Consumer Application
The consumer application needs to be prepared to receive an incoming FedWire
Statement throughout day. The JHA FedLine® Global Services
constructs the FedWire Statement Delivery request (FedWireStmtRcv) message
and sends the contents received from the FRB to the requestor. The application needs to
understand the Fed PDF detailed report layout provided in Fedwire® Application Interface Manual within the
Fedwire® Funds Service section
4.1 and section 4.11. The application responds to the
request in accordance with the XSD contract for FedWire Transaction Receive
(FedWireStmtRcvResponse). The application needs to be prepared to handle
any error conditions provided by either the JHA FedLine®
Global Services or Fedwire® Funds Service.
JHA FedLine® Global Services Application
The application must be prepared to capture sufficient information for the incoming FedWire statements received from the FRB, and follow the error failure scenario referenced in the section Items to Ensure Globally when Implementing the JHA FedLine® Global Service Application (FGA). When an error condition has occurred, as defined in the section Items to Ensure Globally when Implementing the JHA FedLine® Global Service Application (FGA), the FGA must be prepared to cache the statement package (FedWireStmtPkg) so that it can be delivered to a final destination of the package. The implementation of this cached data is under the discretion of the development team. The Captured Data table, provided in the section Items to Ensure Globally when Implementing the JHA FedLine® Global Service Application (FGA) provides the guidance for the cached data. The Fedwire® Funds Subsidiary Statement is queued in the FRB MQ channel in blocks of 4,000 characters with each block being a separate message. The FGA needs to collect all the blocks for a specific Logical Terminal. The collected blocks could require additional parsing based on the ABA provided by the FRB following the ACCT NO: label in the statement data.
The parsed ABA from the statement determines the message destination for the
FedWire Statement Received message FedWireStmtRcv. The FedWire Funds
Subsidiary Statement with an unknown subscriber ABA provided by FRB will be delivered to the
Lead ABA related to the Logical Terminal. This is not meant to be a long-term solution. A
permanent solution will be forthcoming with future enhancements to the DirectLine Wires
application. The FGA should not combine statement business dates into one FedWire Statement
package. It is recommended that each business day be delivered in its proprietary FedWire
Statement Received message (FedWireStmtRcv). The FGA needs to provide the
close of business date of the respective FedWire Statement package. A Format Id of GIF100 is
provided in the header to represent a FedWire Statement along with a message identification
of FT1020. The message fields from the FedLine® Wire
Services Print-Ln-Size and Max-No-Lns to the corresponding contract element. Refer to Fedwire® Application Interface Manual – Fedwire® Funds Service section 4.11 for field
description. The first 24 positions are the report header data and do not need delivered to
the consumer's application. The fields following the first 24 positions of the message from
the FedLine® Wire Services is wrapped and delivered in the
FedWire Statement Package (FedWireStmtPkg) element. The operation
activity is stored in the JHA FedLine® Global Wire
Application for tracking to be utilized for billing procedures.
FedWireStmtRcvRq_MType
FedWireStmtRcvRq_MType is a message MType element.
Contains:
FedLineHdr_CTypeFedLineRptHdr_CTypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- FedWireStmtDt
- The business date of the FedWire Subsidiary statement.
- FedWireStmtPkg
- The package that contains the FedLine® report data.
- FinInstRtId
- The financial institution's routing and transit identification.
- LTermId
- An identification provided to a logical terminal that is unique within a financial institution.
FedLineHdr_CType
FedLineHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- FedEnv
An identification provided by the consumer that defines the environment in which the Fed is operating. This element identifies the environment in which the Fed is operating. Canonical values are:
- PROD
Note: For example, the absence of this element equates to the system handling the routing. If the destination is known to be DIT2, it is the responsibility of the sender to include this element with a value of DIT2. It is the responsibility of the sender to send the appropriate data to identify the environment, if necessary.- 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.
FedLineRptHdr_CType
FedLineRptHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- CharPerLine
- The number of characters for printing/display per line.
- LinePerPg
- The maximum number of lines per page.
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.
FedWireStmtRcvRs_MType
FedWireStmtRcvRs_MType is a message
MType element.
Contains:
FedLineHdr_CTypeMsgRsHdr_CType
Simple Elements
The following simple element is contained within this message.
- RsStat
The status of the response. Canonical values are:
- fail
- success
FedLineHdr_CType
FedLineHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- FedEnv
An identification provided by the consumer that defines the environment in which the Fed is operating. This element identifies the environment in which the Fed is operating. Canonical values are:
- PROD
Note: For example, the absence of this element equates to the system handling the routing. If the destination is known to be DIT2, it is the responsibility of the sender to include this element with a value of DIT2. It is the responsibility of the sender to send the appropriate data to identify the environment, if necessary.- 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_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.