Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Account Balance Inquiry

Enterprise SOAP API > API by Reference > Core Services > Account Balance Inquiry

Account Balance Inquiry

Account Balance Inquiry is a jXchange service designed to provide the consumer with the ability to inquire on the components of an account or draft balance values.

Message Flow

In jXchange, the Account Balance Inquiry service uses a typical exchange of MType messages to inquire on the components of an account/draft balance values.

Primary Request

The third-party consumer forwards the AcctBalInqRq_MType message to the service provider. The message contains:

  • AvlBalCalcCode
  • BalType
  • Custom_CType
  • InAcctId references AccountId_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the AcctBalInqRs_MType message to the third-party consumer. The message contains:

  • AcctBalInqRec_CType
  • AvlBal
  • AvlBalCalcCode
  • BalType
  • ColBal
  • CurBal
  • Custom_CType
  • InAcctId references AccountId_CType
  • MsgRsHdr_CType

Account Balance Inquiry Behavior

The AccountId_CType complex is required in the AcctBalInqRq_MType request message.

The BalType element is provided as an optional request filter that designates the type of balance. The element has the following canonical values: Avl, Ldgr, and Col. The ~Ldgr~ canonical value is the default.

The elements in the AcctBalInqRq_MType request message are echoed back in the AcctBalInqRs_MType response message.

The AcctBalInqRs_MType response message includes each type of balance explicitly defined by a named element. However, the provider only includes the balance value for the type requested.

The detail components of the balance type element are wrapped in the AcctBalInqRec_CType complex. The YestBal element represents the starting balance or the balance of the account identification at the start of the new business day. The consumer should be able to cross foot the elements wrapped in the AcctBalInqRec_CType complex to the balance value in the AcctBalInqRs_MType response message.

AcctBalInqRq_MType

AcctBalInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • InAcctId references AccountId_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

AvlBalCalcCode
A code that conveys to the service provider the method to use for the calculation of the available balance.
BalType

Balance type. See IFX 1.5 for allowed values. Unsupported IFX values include:

  • Avl
  • AvailCredit
  • BAI:xxx
  • ClosingLedger
  • ClosingOutstanding
  • Col
  • CreditLimit
  • Escrow
  • Ldgr
  • MinLedger
  • OpeningLedger
  • OpeningOutstanding
  • Outstanding
  • PayoffAmt
  • Principal
  • TMA:xxx

Added allowed values include:

  • Collected
  • LastStatement
  • Original
  • Yesterday

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

InAcctId

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

InAcctId references AccountId_CType.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart

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.

AcctBalInqRs_MType

AcctBalInqRs_MType is a message MType element.

Contains:

  • AcctBalInqRec_CType
  • Custom_CType
  • InAcctId references AccountId_CType
  • MsgRsHdr_CType
  • x_AcctBalFltAmtArray_AType

Simple Elements

The following simple elements are contained within this message.

AvlBal
The available balance. The optional attribute Calculate describes how the available balance was calculated starting with CurBal.
AvlBalCalcCode
A code that conveys to the service provider the method to use for the calculation of the available balance.
BalType

Balance type. See IFX 1.5 for allowed values. Unsupported IFX values include:

  • Avl
  • AvailCredit
  • BAI:xxx
  • ClosingLedger
  • ClosingOutstanding
  • Col
  • CreditLimit
  • Escrow
  • Ldgr
  • MinLedger
  • OpeningLedger
  • OpeningOutstanding
  • Outstanding
  • PayoffAmt
  • Principal
  • TMA:xxx

Added allowed values include:

  • Collected
  • LastStatement
  • Original
  • Yesterday
ColBal
The collected balance.
CurBal
The current balance.

AcctBalInqRec_CType

AcctBalInqRec_CType is a complex CType element.

Contains:

  • CustomAcctBalInqRec references Custom_CType

Simple Elements

The following simple elements are contained within this complex.

AccrInt
The accrued interest.
ACHCrPostAmt
The total credit ACH amount of transactions on a given business day.
ACHDrPostAmt
The total debit ACH amount of transactions on a given business day.
ATMCrPostAmt
The total credit ATM posted amount of transactions on a given business day.
ATMDrPostAmt
The total debit ATM posted amount of transactions on a given business day.
BnceProtAmt
The amount of funds set aside to protect an account from creating NSF items.
FltAmt
The amount of float outstanding against this account.
HldAmt
The hold amount.
InvestAcctCrAmt
The total credit out of FI investment transfer system available amount on a given business day.
InvestAcctDrAmt
The total debit out of FI investment transfer system available amount on a given business day.
MemoCrPostAmt
The total credit memo-posted amount of transactions on a given business day.
MemoDrPostAmt
The total debit memo-posted amount of transactions on a given business day.
ODLmt
The overdraft limit.
ODProtAmt
The amount of overdraft protection (credit line) this account has.
PODCrPostAmt
The total credit proof of deposit posted amount of transactions on a given business day.
PODDrPostAmt
The total debit proof of deposit posted amount of transactions on a given business day.
RealTimeTrnCrPostAmt
The real time transaction credit post amount.
RealTimeTrnDrPostAmt
The real time transaction debit post amount.
SweepAvlCrAmt
The total credit sweep transfer system available amount on a given business day.
SweepAvlDrAmt
The total debit sweep transfer system available amount on a given business day.
TellerCrPostAmt
The total credit teller system posted amount of transactions on a given business day.
TellerDrPostAmt
The total debit teller system posted amount of transactions on a given business day.
TrnCrPostAmt
The total credit amount of transactions on a given business day.
TrnDrPostAmt
The total debit amount of transactions on a given business day.
YestBal
Yesterday's balance.

CustomAcctBalInqRec

Custom_CType is a complex CType element.

CustomAcctBalInqRec references Custom_CType.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

InAcctId

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

InAcctId references AccountId_CType.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart

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.

x_AcctBalFltAmtArray_AType

x_AcctBalFltAmtArray_AType is an array AType element. This element is an array of float amounts by expiration date related to a specific account.

Contains:

  • AcctBalFltAmtRec_CType

AcctBalFltAmtRec_CType

AcctBalFltAmtRec_CType is a complex CType element.

Simple Dictionary
FltAmt
The amount of float outstanding against this account.
FltExpDt
The expiration date.
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 Tue Apr 30 2024