Stop Check Search

Enterprise SOAP API > API by Reference > Core Services > Stop Check Search

Stop Check Search

Stop Check Search is a jXchange service designed to search for all stop payment items on a specified account.

Message Flow

In jXchange, the Stop Check Search service uses a typical exchange of MType messages to search for all stop payment items on a specified account to a Service Provider.

Primary Request

The Third Party Consumer forwards the StopChkSrchRq_MType message to the Service Provider. The message contains the account ID, stop hold type, low amount, high amount, and/or the beginning and/or ending check number to define the search. The StopHldType is used to refine the search to a specific type of stop check action. If that element and value are not defined in the search, then the search is completed for all types of stop check actions. The types of stop hold actions are determined by the Service Provider.

Primary Response

The Service Provider returns the StopChkSrchRs_MType message to the Third Party Consumer. The message contains the StopChkRec_CType to define the stop check action found for the listed account. The StopChkRec_CType contains the StopChkInfoRec_CType to further define the stop check action.

StopChkSrch Behavior

The available balance effective date should default to the EffDt element when not delivered in the message.

Stop Check Search, Add, and Cancel Business Case

This is an example document.

In this business case, a consumer of an Internet bank mails the bank a deposit check from his account at the bank. The consumer checks after five days and the check has not been received by the Internet bank. The consumer requests that the Internet bank issue a stop/hold order on the check. The check arrives the next day, and the Internet bank requests a stop/hold cancel on the check.

Initial Add Request

An Internet bank sends a stop/hold order on a check issued by one of its consumers. The Internet bank forwards the following information to the Service Provider holding the account.

Complex	Simple Element or Array	Entry Value	Explanation
`StopChkAddRq_MType`	`InAcctId`/`AcctId`	`1747664`	Account to which the stop/hold order is to be added.
	`StopHldType`	`Ck`	Stop/hold on payment of a check.
	`StopChkInfo_CType`	Defining complex	-
`StopChkInfo_CType`	`ChkDt`	`011207`	Date on the check.
	`ChkNumStart`	`332`	Check number
	`ChkNumEnd`	`332`	Check number
	`StopChg`	`30.00`	Fee charged for stop/hold order.
	`PayeeName`	`Internet Bank of Monett`	To whom the check was written.
	`RmkArray`	Array for inserting text.	-
`RmkArray`	`Rmk`	`Check sent for deposit was not received as of 011707.`	Remarks entered by the Internet bank explaining the reasons for the request.

Note: There are other optional and required elements necessary for jXchange messaging that are not listed here. In addition, specific Service Providers may require specific elements not listed here. The elements listed above are for example purposes only and do not represent a complete and entire requirement for successful stop check action.

Initial Add Response

Once the Service Provider receives and executes the stop/hold order, it responds to the Internet bank by returning a response with the following values:

Complex	Simple Element or Array	Entry Value	Explanation
`StopChkAddRs_MType`	`StopSeq`	`26552`	Sequence number issued by the Service Provider identifying the requested stop/hold order.
	`RsStat`	`Successful`	The requested stop/hold order was successfully executed.

Initial Cancel Request

Once the check arrives safely at the Internet bank, the Internet bank forwards a request to cancel the stop/hold order to the Service Provider with the following values:

Complex	Simple Element or Array	Entry Value	Explanation
`StopChkCanRq_MType`	`StopSeq`	`26552`	Sequence number issued by the Service Provider identifying the requested stop/hold order when it was created.
	`InAcctId`/`AcctId`	`1747664`	Account to which the stop/hold order was added.

Initial Cancel Response

Once the stop check cancel message is received and executed, the Service Provider returns a response message to the Internet bank with the following values:

Complex	Simple Element or Array	Entry Value	Explanation
`StopChkCanRs_MType`	`RsStat`	`Successful`	The requested stop/hold cancel order was successfully executed.

StopChkSrchRq_MType

StopChkSrchRq_MType is a message MType element.

Contains:

Custom_CType
IdAcctId references AccountId_CType
SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ChkNumEnd: The numbers or characters that designate an ending point for check number selections.
ChkNumStart: The numbers or characters that designate a starting point for check number selections.
HighAmt: The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
LowAmt: The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
StopHldType: The stop/hold type: SP.

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.

This element 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

SrchMsgRqHdr_CType

SrchMsgRqHdr_CType is a complex CType element. This is a standard request message 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.
Cursor: The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MaxRec: The maximum number of records when multiple records are returned.

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.

StopChkSrchRs_MType

StopChkSrchRs_MType is a message MType element.

Contains:

Custom_CType
SrchMsgRsHdr_CType
StopChkRecArray_AType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

SrchMsgRsHdr_CType

SrchMsgRsHdr_CType is a complex CType element. It searches specific message response headers.

Contains:

jXchangeHdr_CType
MsgRecInfoArray_AType

Simple Elements

The following simple elements are contained within this complex.

Cursor

The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.

MoreRec

Indicates if there are more records that could be returned. Canonical values are:

false
true

SentRec

The number of records sent in the response.

TotRec

Indicates the total records the request selected, which could be larger than MaxRec.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId

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.

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 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 Soap Header Fault 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.

StopChkRecArray_AType

StopChkRecArray_AType is an array AType element. This is an array of responses for a stop check search.

Contains:

StopChkRec_CType

StopChkRec_CType

StopChkRec_CType is a complex CType element.

Contains:

CustomStopChkRec references Custom_CType
StopChkInfo_CType

Simple Elements

The following simple elements are contained within this complex.

ChngTime: Indicates that time changes were made.
OffDesc: The officer short name.
PostAdvDesc: The description of the code that identifies the behavior for posting account transactions to the stop hold system.
StopChkPlaceDt: The stop check placed date.
StopHldType: The stop/hold type: SP.
StopNotDesc: The description of the code that defines the behavior for mailing stop hold notices.
StopSeq: Sequence number of the stop against an account. You may have multiple stops.
StopUserId: User who entered the stop on the system.
StopWSId: Workstation ID where the stop was entered into the system.

CustomStopChkRec

Custom_CType is a complex CType element.

CustomStopChkRec references Custom_CType.

This element is optional.

StopChkInfo_CType

StopChkInfo_CType is a complex CType element.

Contains:

ApprvOffInfoArray_CType
Rmk_AType

Simple Elements

The following simple elements are contained within this complex.

ACHCompId: The ACH company ID.
ACHDrCRAll: ACH debit only, credit only, all.
ACHStdEntryClass: The ACH standard entry class.
AvlBalEffDt: The effective date when a stop hold should impact the available balance.
ChkDt: The check date.
ChkNumEnd: The numbers or characters that designate an ending point for check number selections.
ChkNumStart: The numbers or characters that designate a starting point for check number selections.
EffDt: The date assigned to transactions when it is different from the posting date.
ExpDt: The expiration date.
HighAmt: The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
HldEntireBal: Determines if the entire account balance should be held.
LowAmt: The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
OffCode: The code that designates the financial institution officer.
PayeeName: The name of the payee.
PostAdvCode: The code that identifies the behavior for posting account transactions to the stop hold system.
RelAcctId: The related account ID or number.
RelAcctType: The related account type.
StopChg: Stop Charge. The fee to be charged for the stop payment.
StopNotCode: The code that defines the behavior for mailing stop hold notices.

ApprvOffInfoArray_AType

ApprvOffInfoArray_AType is an array AType element. This is an array of approval officers.

Contains:

ApprvOffInfoRec_CType

ApprvOffInfoRec_CType

ApprvOffInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ApprvOffCode: The approving officer code.
ApprvOffDesc: The approving officer description.
ApprvType: The optional element contains the element name as defined in the enterprise dictionary and published as enterprise variables, which requires an officer approval. The service provider would convey the elements that could need approval by the Service Dictionary Search.

Rmk_AType

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

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.

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 Mon Jan 24 2022