EFTCardBlkTrnSrch
EFT Card Blocking Transaction Search
EFT Card Blocking Transaction Search is a jXchange service designed to provide the consumer with the ability to search for an EFT card's transaction blocking settings.
Message Flow
In jXchange, the EFT Card Blocking Transaction Search service uses a typical exchange of
MType
messages to retrieve a listing of EFT card transaction blocking
settings.
Primary Request
The Third Party Consumer forwards the EFTCardBlkTrnSrchRq_MType
message
to the Service Provider. The message contains the following elements:
- EFTCardNum
- EFTCardSufxNum
- EFTBlkTrnCode
- EFTISOBlkId
- EFTBlkTrnDesc
Primary Response
The Service Provider returns the EFTCardBlkTrnSrchRs_MType
message
to the Third Party Consumer. The message contains an echo of the requested elements.
EFT Card Blocking Transaction Search Behavior
The EFT Card Blocking Transaction Search behavior is as follows.
The EFT Card Blocking Transaction Search root request
(EFTCardBlkTrnSrchRq_MType
) requires element EFT Card Number
(EFTCardNum). Optionally, this root request includes:
- EFT Card Suffix Number (EFTCardSufxNum)
- EFT Blocking Transaction Code (EFTBlkTrnCode)
- EFT ISO Blocking Identifier (EFTISOBlkId)
- EFT Blocking Transaction Description (EFTBlkTrnDesc)
The EFT Card Blocking Transaction Search root request
(EFTCardBlkTrnSrchRq_MType
) filters the EFT Blocking Transaction Code
(EFTBlkTrnCode) and the EFT ISO Blocking Identifier
(EFTISOBlkId).
The EFT Blocking Transaction Description (EFTBlkTrnDesc) supports the @SrchType attribute values Exact, StartsWith, EndsWith, Contains, and ContainsAll.
The EFT Card Blocking Transaction Search root response
(EFTCardBlkTrnSrchRs_MType
) echoes back the following:
- EFT Card Number (EFTCardNum)
- EFT Card Suffix Number (EFTCardSufxNum)
- EFT Blocking Transaction Code (EFTBlkTrnCode)
- EFT ISO Blocking Identifier (EFTISOBlkId)
- EFT Blocking Transaction Description (EFTBlkTrnDesc)
The root response includes the EFT Card Blocking Transaction Search Array
(EFTCardBlkTrnSrchArray_AType
) which encapsulates the EFT Card Blocking
Transaction Search Record (EFTCardBlkTrnSrchRec_CType
) complex. This complex
includes the following:
- Blocking Transaction Code (BlkTrnCode)
- Blocking Transaction Description (BlkTrnDesc)
- ISO Blocking Identifier (ISOBlkId)
- Blocking Start Date (BlkStartDt)
- Blocking End Date (BlkEndDt)
- Blocking Transaction Status Type (BlkTrnStatType)
- Blocking Transaction Override Start Date (BlkTrnOvrrdStartDt)
- Blocking Transaction Override End Date (BlkTrnOvrrdEndDt)
- Blocking Transaction Overrides Exist (BlkTrnOvrrdExistType)
This service conforms to API search tenets, the Search Header model, and the Wildcard Search model.
EFTCardBlkTrnSrchRq_MType
EFTCardBlkTrnSrchRq_MType
is a message
MType
element.
Contains:
Custom_CType
SrchMsgRqHdr_CType
Simple Dictionary
- EFTBlkTrnCode
- The transaction code that defines the behavior for block EFT transactions.
- EFTBlkTrnDesc
- The description of the transaction code that defines the behavior for block EFT transactions.
- EFTCardNum
- The number that is assigned to an EFT card. The card number includes the ISO number.
- EFTCardSufxNum
- The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.
- EFTISOBlkId
- The ISO identifier given to a transaction blocking rule.
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_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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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.
EFTCardBlkTrnSrchRs_MType
EFTCardBlkTrnSrchRs_MType
is a message
MType
element.
Contains:
Custom_CType
EFTCardBlkTrnSrchArray_AType
SrchMsgRsHdr_CType
Simple Dictionary
- EFTBlkTrnCode
- The transaction code that defines the behavior for block EFT transactions.
- EFTBlkTrnDesc
- The description of the transaction code that defines the behavior for block EFT transactions.
- EFTCardNum
- The number that is assigned to an EFT card. The card number includes the ISO number.
- EFTCardSufxNum
- The number that is the suffix to the card number. Can represent the card holder when multiple cards are issued with the same card number.
- EFTISOBlkId
- The ISO identifier given to a transaction blocking rule.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
EFTCardBlkTrnSrchArray_AType
EFTCardBlkTrnSrchArray_AType
is an
array AType
element. This element is an array of EFT card blocked transaction
settings.
Contains:
EFTCardBlkTrnSrchRec_CType
EFTCardBlkTrnSrchRec_CType
EFTCardBlkTrnSrchRec_CType
is a complex
CType
element.
Contains:
Custom_CType
Simple Dictionary
- BlkEndDt
- The date that designates the ending point for date selections.
- BlkStartDt
- The date that designates the starting point for date selections.
- BlkTrnCode
- The transaction code that defines the behavior for block EFT transactions.
- BlkTrnDesc
- The description of the transaction code that defines the behavior for block EFT transactions.
- BlkTrnOvrrdExistType
Does the EFT card have active overrides? Canonical values are:
- True
- False
- BlkTrnOvrrdStartDt
- The date that designates the starting point for date selections.
- BlkTrnPvrrdEndDt
- The date that designates the ending point for date selections.
- BlkTrnStatType
The status of an EFT card as related to transaction blocking. The default value is Active. Canonical values are:
- Active
- Exp
- ISOBlkId
- The ISO identifier given to a transaction blocking rule.
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
- 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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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.