Developer Resources

Enterprise SOAP API > API by Reference > Check Imaging > Check Image Statement Search > Developer Resources

Details

SoapAction	http://jackhenry.com/ws/ChkImgStmtSrch
Input Name	ChkImgStmtSrch
Output Name	ChkImgStmtSrchResponse
Input Namespace	http://jackhenry.com/jxchange/TPG/2008
Group Name	Image
Container	TPG_ImageMaster.xsd

Operation Summary

OperationSummary-ChkImgStmt

The Check Image Statement operations (ChkImgStmtSrch, ChkImgStmtGen and ChkImgStmtGenInq) work as a suite to allow consumers to retrieve a list of available account statements. At a minimum it requires passing in the account id and type of the account to perform the statement search on.

In addition, it supports the following filters:

Element Name	Description
StartDt	This is the date that designates the starting point for date selections
EndDt	This is the date that designates the ending point for date selections

A request with a StartDt, without an end date EndDt, returns all of the qualified statements with a date equal to and greater than the start date.

A request with an EndDt, without a StartDt, returns all of the qualified statements with a date equal to and less than the end date.

A request without a StartDt or an EndDt returns all of the qualified statements for the account id/type being requested.

The ChkImgStmtSrch API response will contain an array of statement records, ChkImgStmtSrchArray, matching the search criteria passed in. Each of these statement records will contain a statement ID (StmtId), which is an identification for a specific statement of an account on a specific date. StmtId is what needs to be passed into a subsequent ChkImgStmtGen request to identify the actual statement to retrieve.

The Check Image Statement Generation (ChkImgStmtGen) operation allows a consumer to make a request for a check image statement to be generated. It requires the statement ID of the statement to retrieve, which can be obtained through a call to ChkImgStmtSrch, and supports the following parameters:

Element Name	Description
StmtContentType	Identifies content to be included when a statement or other document is returned. Canonical Values: Text Only Full (Default)
StmtDlvryType	Identifies how a statement or other document is returned. Canonical Values: InLine FileLoc (Default)
Cursor*	When returning multiple records and allowing a subsequent call to retrieve more records this is the state information that allows the next call to understand where it left off.
MaxBytes*	This is the maximum number of bytes to be returned in each response.

* Only applicable when StmtDlvryType is ~InLine~.

There are two methods of statement delivery, File Location and In-Line. File Location provides a URI to where the statement will be located once the generation is complete, while In-Line delivers the statement in blocks of data in the response message itself. The default is File Location.

If FileLoc statement delivery is chosen, the ChkImgStmtGenInq API may be used to check the status of the generation request. The consumer can call ChkImgStmtGenInq in a loop and inspect the element StmtRqStat to see if Cmplt (Complete) is returned before going to the location to retrieve the statement.

If InLine statement delivery is chosen, the statement will be passed back as blocks of binary data in the ChkImgStmtGen response itself:

Element Name	Description
DocImg	The document image in base64Binary format
DocImgBytes	The size of the document image in bytes
SentBytes	Number of bytes sent in the response
Cursor	When returning multiple records and allowing a subsequent call to retrieve more records this is the state information that allows the next call to understand where it left off.
MoreBytes	Indicates if there are more bytes that could be returned. Canonical values: true false

The consumer would be responsible for calling ChkImgStmtGen multiple times while paging through the responses using the Cursor element to retrieve the statement in chunks of data and assembling them all together at the end once MoreBytes is equal to false.

Example of using Cursor element to retrieve that data in chunks:

Special Considerations

The use of these ChkImgStmt operations requires the Financial Institution to have the JH product 4|Sight installed.

Consumers may consider using the page and enclosure counts returned in the ChkImgStmtSrch response to help estimate the size of a statement (StmtPgCnt and StmtEnclCnt) when delivery is done In-Line.

If 4|Sight is hosted, access to the File Location where the statements have been generated may prove to be difficult due to network and comms restrictions between the consumer and JHA hosting. It is recommended in these scenarios to deliver the statements In-Line.

XML Examples

ChkImgStmtSrch-XML

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SOAP-ENV:Header>
    <wsse:Security
      xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
      xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
      <wsse:UsernameToken
        xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:Username>INSERT</wsse:Username>
        <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">INSERT</wsse:Password>
        <wsu:Created
          xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2018-01-10T21:39:01Z
        </wsu:Created>
      </wsse:UsernameToken>
    </wsse:Security>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <ChkImgStmtSrch
      xmlns="http://jackhenry.com/jxchange/TPG/2008">
      <SrchMsgRqHdr>
        <jXchangeHdr>
          <JxVer/>
          <AuditUsrId>INSERT</AuditUsrId>
          <AuditWsId>INSERT</AuditWsId>
          <AuthenUsrId/>
          <ConsumerName/>
          <ConsumerProd/>
          <Ver_1/>
          <jXLogTrackingId>INSERT</jXLogTrackingId>
          <Ver_2/>
          <InstRtId JHANull="" Rstr="">INSERT</InstRtId>
          <InstEnv>INSERT</InstEnv>
          <Ver_3/>
          <BusCorrelId/>
          <Ver_4/>
          <WorkflowCorrelId/>
          <Ver_5/>
          <ValidConsmName>INSERT</ValidConsmName>
          <ValidConsmProd>INSERT</ValidConsmProd>
          <Ver_6/>
        </jXchangeHdr>
        <MaxRec>INSERT</MaxRec>
        <Cursor/>
        <Ver_1/>
        <Ver_2/>
        <Ver_3/>
      </SrchMsgRqHdr>
      <CustId JHANull="" Rstr="">INSERT</CustId>
      <AccountId Rstr="">
        <AcctId JHANull="" Rstr="" SrchType="">INSERT</AcctId>
        <AcctType JHANull="" Rstr="">INSERT</AcctType>
        <Ver_1/>
      </AccountId>
      <StartDt JHANull="" Rstr="">INSERT</StartDt>
      <EndDt JHANull="" Rstr="">INSERT</EndDt>
      <Custom/>
      <Ver_1/>
    </ChkImgStmtSrch>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

FAQ

ChkImgStmtSrchFAQ

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 Apr 3 2024