Stop Check Cancel
Stop Check Cancel is a jXchange service designed to halt or cancel a specific stop check action on a specified account on a Service Provider.
Message Flow
In jXchange, the Stop Check Cancel
service uses a typical exchange of MType messages to cancel a
specific action on a specified account to a Service Provider.
Primary Request
The Third Party Consumer forwards the
StopChkCanRq_MType
message to the Service Provider. The messages contains the account ID,
type, and the stop sequence number created by the Service Provider to
identify the specific stop/hold action to be canceled.
Primary Response
The Service Provider returns the
StopChkCanRs_MType
message to the Third Party Consumer. The message contains the RsStat element, which states
whether the requested stop/hold cancel was successfully
completed.
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. |
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. |
StopChkCanRq_MType
StopChkCanRq_MType is a message
MType element.
Contains:
Custom_CTypeInAcctIdreferencesAccountId_CTypeMsgRqHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- StopSeq
- Sequence number of the stop against an account. You may have multiple stops.
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
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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to the Search Message Request Header,
SrchMsgRqHdr_CType,and the Message Request Header,MsgRqHdr_CType.AuthenUsrIdis 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 byWS-Security.
StopChkCanRs_MType
StopChkCanRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- RsStat
- The status of the response. Canonical values are:
- Fail
- Success
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to the Search Message Request Header,
SrchMsgRqHdr_CType,and the Message Request Header,MsgRqHdr_CType.AuthenUsrIdis 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 byWS-Security.