Transfer Exp Search
Transfer Expiration Search
Transfer Expiration Search is a jXchange service designed to provide consumers the ability to search automated transfers in core that may expire.
Message Flow
In jXchange, the Transfer Expiration Search service uses a typical exchange of
MType messages to provide consumers the ability to search automated
transfers in core that may expire.
Primary Request
The consumer forwards the XferExpSrchRq_MType message to the
service provider.
The message contains the following simple elements:
- ExpEndDt
- ExpStartDt
- XferType
The message contains the following complex elements:
Custom_CTypeSrchMsgRqHdr_CType
Primary Response
The service provider returns the XferExpSrchRs_MType message
to the consumer.
The message contains the following simple elements:
- ExpEndDt
- ExpStartDt
- XferType
The message contains the following complex elements:
Custom_CTypeSrchMsgRsHdr_CType
The message contains the following array:
XferExpSrchArray_AType
Transfer Expiration Search Behavior
The Transfer Expiration Search service behavior is as follows.
The Transfer Expiration Search root request (XferExpSrchRq_MType) optionally
includes the Transfer Type (XferType), Expiration Start Date
(ExpStartDt), and Expiration End Date
(ExpEndDt).
The Transfer Expiration Search root response contains the Echo Back of Transfer Type (XferType), Expiration Start Date (ExpStartDt), and Expiration End Date (ExpEndDt).
The Transfer Expiration Search Information complex (XferExpSrchInfo_CType)
contains the Account Identifier From complex (AcctIdFrom_CType), Account
Identifier To complex (AcctIdTo_CType), Transfer Key
(XferKey), Transfer Type (XferType), Transfer
Amount (XferAmt), Transfer Next Date
(XferNxtDt), and Transfer Expiration Date
(XferExpDt).
The Transfer Type (XferType) default is to include all transfer types.
The Expiration Start Date (ExpStartDt) and Expiration End Date (ExpEndDate) are compared to element Transfer Expiration Date (XferExpDt). The Transfer Expiration Date (XferExpDt) could represent ACH Transfer Expiration Date (ACHXferExpireDt) and Future Transfer Expiration Date (FutXferExpDt).
A consumer request with an Expiration Start Date (ExpStartDt) but without an Expiration End Date (ExpEndDate), returns all of the qualified Transfer records with a date equal to or greater than the Transfer Expiration Date (XferExpDt).
A consumer request with an Expiration End Date (ExpEndDt), but without an Expiration Start Date (ExpStartDt), returns all of the qualified Transfer records with a date equal to and less than the Transfer Expiration Date (XferExpDt).
A consumer request with an Expiration Start Date (ExpStartDt) and an Expiration End Date (ExpEndDt) returns all of the qualified Transfer records with a date equal to or greater than the Transfer Expiration Date (XferExpDt) and a date equal to or less than the Transfer Expiration Date (XferExpDt).
The standard Search message header tenets apply.
The standard Search message tenets apply.
XferExpSrchRq_MType
XferExpSrchRq_MType is a message MType element.
Contains:
Custom_CTypeSrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ExpEndDt
- The date that designates the ending point for date selections.
- ExpStartDt
- The date that designates the starting point for date selections.
- XferType
- Identifies the type of transfer operation. Canonical values are:
- ACH
- Fut
- Xfer
Designates whether the transfer is between accounts within a given financial institution, or between separate institutions.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType is a complex
CType element. This is a
standard request message 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.
- 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_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 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_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.
XferExpSrchRs_MType
XferExpSrchRs_MType is a message MType element.
Contains:
Custom_CTypeSrchMsgRsHdr_CTypeXferExpSrchArray_AType
Simple Elements
The following simple elements are contained within this message.
- ExpEndDt
- The date that designates the ending point for date selections.
- ExpStartDt
- The date that designates the starting point for date selections.
- XferType
- Identifies the type of transfer operation. Canonical values are:
- ACH
- Fut
- Xfer
Designates whether the transfer is between accounts within a given financial institution, or between separate institutions.
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_CTypeMsgRecInfoArray_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
- 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 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_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.
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.
XferExpSrchArray_AType
XferExpSrchArray_AType is an array
AType element. This is an
array of expired transfers.
Contains:
XferExpSrchInfo_CType
XferExpSrchInfo_CType
XferExpSrchInfo_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- LnUnitId
- The identification assigned to a unit of a loan.
- XferAmt
- The amount or quantity.
- XferExpDt
- The expiration date.
- XferKey
- The transfer key returned in search/inquiry requests and is needed to modify or delete a transfer.
- XferNxtDt
- The next scheduled transfer date.
- XferType
- Identifies the type of transfer operation. Canonical values are:
- ACH
- Fut
- Xfer
Designates whether the transfer is between accounts within a given financial institution, or between separate institutions.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
AcctIdFrom_CType
AcctIdFrom_CType is a complex CType element. This element is the
source description (AcctId and
AcctType) for a
source/destination transfer.
Simple Elements
The following simple elements are contained within this complex.
- FromAcctId
- The source account ID.
- FromAcctType
- The source account type.
AcctIdTo_CType
AcctIdTo_CType is a complex CType
element. This is the destination description (AcctId and AcctType) for a
source/destination transfer.
Simple Elements
The following simple elements are contained within this complex.
- ToAcctId
- The destination account ID.
- ToAcctType
- The destination account type.