Developer Programs

Learn

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

Financial Institution Account Balance ISO Report Reply

Enterprise SOAP API > API by Reference > Core Services > Financial Institution Account Balance ISO Report Reply

Financial Institution Account Balance ISO Report Reply

The Financial Institution Account Balance ISO Report Reply service (FinInstAcctBalISORptReply) provides a Fedwire® Funds participant with information about debit and credit balances.

Message Flow

In jXchange, the Financial Institution Account Balance ISO Report Reply service uses a typical exchange of MType messages to provides a Fedwire® Funds participant with information about debit and credit balances.

Primary Request

The consumer forwards the FinInstAcctBalISORptReplyRq_MType message to the service provider.

The message contains the following simple elements:

  • AcctBalRptType
  • FedRptType
  • LastPgType
  • PgNum
  • RptCrtTimeDate
  • RptRmk

The message contains the following complex elements:

  • Custom_CType
  • FedLineHdr_CType
  • MsgRqHdr_CType

The message contains the following arrays:

  • RptBalTypeArray_AType
  • TrnSumArray_AType

Primary Response

The service provider returns the FinInstAcctBalISORptReplyRs_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

FinInstAcctBalISORptReplyRq_MType

FinInstAcctBalISORptReplyRq_MType is a message MType element.

Contains:

  • Custom_CType
  • FedLineHdr_CType
  • MsgRqHdr_CType
  • RptBalTypeArray_AType
  • RptRmk references Rmk_AType
  • TrnSumArray_AType

Simple Elements

The following simple elements are contained within this message.

AcctBalType
Identifies the type of account balances being requested. Canonical values are:
  • Master
  • Monitor
  • Self
AcctBalRptType
Identifies the type of balance report. Canonical values are:
  • Final
  • Interim
  • MasterAcctBal
  • Open
  • Periodic
  • Provisional
  • SelfAcctBal
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.
RptRmk
Application or user remarks free-form text.

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.

RptBalTypeArray_AType

RptBalTypeArray_AType is an array AType element. This element is an array of different account balance reports.

Contains

  • RptBalTypeRec_CType

RptBalTypeRec_CType

RptBalTypeRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • FedLOCArray_AType
Simple Elements

The following simple elements are contained within this complex.

CashBal
The cash balance.
CashBalTimeDt
The time/date stamp of the reported cash balance.
DrCr
Either debit or credit. Canonical values are:
  • Dr
  • Cr

This element is a hybrid enumeration.

RptBalTypeDesc
The description that identifies the type of balance report.
RptBalType
Identifies the type of balance report. Canonical values are:
  • AcctBal
  • AvlBal
  • DayODAvlBal
  • DayODBal
  • FinalOpenBal
  • OpenBal
  • PriorDayOpenBal
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

FedLOCArray_AType

FedLOCArray_AType is an array AType element. This element is an array of FedLine® credits.

Contains:

  • FedLocRec_CType
FedLOCRec_CType

FedLOCRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements
The following simple elements are contained within this complex.
BalCycleTimeDt
The time/date stamp of a balance cycle.
LOCBal
The line of credit balance.
LOCInclType
Answers the question: Is the line of credit included in the calculations? Canonical values are:
  • true
  • false
LOCType
Identifies the type of balance report. Canonical values are:
  • CollatAvl
  • CollatCap
  • CollatDayOD
  • NetDrCap
  • UnCollatDayOD
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

RptRmk_AType

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

RptRmk_AType 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.

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.

FinInstAcctBalISORptReplyRs_MType

FinInstAcctBalISORptReplyRs_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