Enterprise Solutions

EFTCardBlkTrnInq

Enterprise SOAP API > API by Reference > Card Services > EFTCardBlkTrnInq
<?xml version="1.0" encoding="UTF-8"?>EFT Card Blocking Transaction Inquiry

EFT Card Blocking Transaction Inquiry

EFT Card Blocking Transaction Inquiry is a jXchange service designed to provide the consumer with the ability to inquiry on an EFT card's transaction blocking settings.

Message Flow

In jXchange, the EFT Card Blocking Transaction Inquiry service uses a typical exchange of MType messages to inquiry on EFT card transaction blocking settings.

Primary Request

The Third Party Consumer forwards the EFTCardBlkTrnInqRq_MType message to the Service Provider. The message contains the following elements:

  • EFTBlkTrnCode
  • EFTCardNum
  • EFTCardSufxNum

Primary Response

The Service Provider returns the EFTCardBlkTrnInqRs_MType message to the Third Party Consumer. The message contains an echo of the requested elements.

EFT Card Blocking Transaction Inquiry Behavior

The EFT Card Blocking Transaction Inquiry behavior is as follows.

The EFT Card Blocking Transaction Inquiry root request (EFTCardBlkTrnInqRq_MType) requires the EFT Card Number (EFTCardNum) and EFT Blocking Transaction Code (EFTBlkTrnCode). Optionally, the root request includes the EFT Card Suffix Number (EFTCardSufxNum).

The EFT Card Blocking Transaction Inquiry root response (EFTCardBlkTrnInqRs_MType) echoes back the following elements:

  • EFT Card Number (EFTCardNum)
  • EFT Card Suffix Number (EFTCardSufxNum)
  • EFT Blocking Transaction Code (EFTBlkTrnCode)

The EFT Card Blocking Transaction Inquiry root response (EFTCardBlkTrnInqRs_MType) returns EFT Card Blocking Transaction Inquiry Record complex (EFTCardBlkTrnInqRec_CType) which contains the following elements:

  • 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 (BldTrnOvrrdEndDt)
  • Blocking Transaction Override Exist Type (BlkTrnOvrrdExistType)
  • Blocking New Account Type (BlkNewAcctType)
  • Blocking Rule Array (BlkRuleArray_AType)

The Blocking Rule Array (BlkRuleArray_AType) encapsulates the EFT Card Blocking Rule Record complex (EFTCardBlkRuleRec_CType). This complex element contains the following elements:

  • Blocking Rule Type (BlkRuleType)
  • Algebraic Symbol (AlgSymb)
  • Blocking Rule Value Array (BlkRuleValArray_AType)

The Blocking Rule Value Array (BlkRuleValArray_AType) encapsulates the EFT Card Blocking Rule Value Record complex (EFTCardBlkRuleValRec_CType) which encapsulates the Blocking Rule Value (BlkRuleVal).

EFTCardBlkTrnInqRq_MType

EFTCardBlkTrnInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Dictionary

EFTBlkTrnCode
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.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request 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.

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.

EFTCardBlkTrnInqRs_MType

EFTCardBlkTrnInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • EFTCardBlkTrnInqRec_CType
  • MsgRsHdr_CType

Simple Dictionary

EFTBlkTrnCode
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.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EFTCardBlkTrnInqRec_CType

EFTCardBlkTrnInqRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • EFTCardBlkRuleArray_AType

Simple Dictionary

BlkEndDt
The date that designates the ending point for date selections.
BlkNewAcctType

Should new accounts be blocked? Canonical values are:

  • True
  • False
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
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.

EFTCardBlkRuleArray_AType

EFTCardBlkRuleArray_AType is an array AType element. This element is an array of transaction blocking rules as related to an EFT card.

Contains:

  • EFTCardBlkRuleRec_CType
EFTCardBlkRuleRec_CType

EFTCardBlkRuleRec_CType is a complex CType element.

Contains:

  • CardBlkRuleValArray_AType
  • Custom_CType
Simple Dictionary
AlgSymb

The algebraic symbol for the EFT card services.

  • EQ - Accepted for all BlkRuleType values.
  • GE - Accepted for AcptPostalCode, AcptName, AcptId, FraudRiskScore, MerType, PseudoTrmlId, TrnAmt, and TrmlId values for BlkRuleType.
  • GT - Accepted for AcptPostalCode, AcptName, AcptId, FraudRiskScore, MerType, PseudoTrmlId, TrnAmt, and TrmlId values for BlkRuleType.
  • LE - Accepted for AcptPostalCode, AcptName, AcptId, FraudRiskScore, MerType, PseudoTrmlId, TrnAmt, and TrmlId values for BlkRuleType.
  • LT - Accepted for AcptPostalCode, AcptName, AcptId, FraudRiskScore, MerType, PseudoTrmlId, TrnAmt, and TrmlId values for BlkRuleType.
  • NE - Accepted for all BlkRuleType values.
  • Range - Accepted for AcptPostalCode, AcptName, AcptId, FraudRiskScore, MerType, PseudoTrmlId, TrnAmt, and TrmlId values for BlkRuleType.
BlkRuleType

The type of card blocking rule. Canonical values are:

  • AcptId - Accepts all algebraic symbols for AlgSymb.
  • AcptName - Accepts all algebraic symbols for AlgSymb.
  • AcptPostalCode - Accepts all algebraic symbols for AlgSymb.
  • AcptState - Only accepts EQ and NE for AlgSymb.
  • AcqCntry - Only accepts EQ and NE for AlgSymb.
  • EntryMode - Only accepts EQ and NE for AlgSymb.
  • FraudRiskScore - Accepts all algebraic symbols for AlgSymb.
  • MerType - Accepts all algebraic symbols for AlgSymb.
  • PANEntryMode - Only accepts EQ and NE for AlgSymb.
  • POSCond - Only accepts EQ and NE for AlgSymb.
  • PseudoTrmlId - Accepts all algebraic symbols for AlgSymb.
  • SecTrn - Only accepts EQ and NE for AlgSymb.
  • TrmlId - Accepts all algebraic symbols for AlgSymb.
  • Trn - Only accepts EQ and NE for AlgSymb.
  • TrnAmt - Accepts all algebraic symbols for AlgSymb.
  • VisaECI - Only accepts EQ and NE for AlgSymb.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

CardBlkRuleValArray_AType

EFTCardBlkRuleValArray_AType is an array AType element. This is an array of variables as related to a specific EFT card blocking rule for an EFT card.

Contains:

  • EFTCardBlkRuleValRec_CType
EFTCardBlkRuleValRec_CType

EFTCardBlkRuleValRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Dictionary
BlkRuleVal
The value of a name value pair.
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_CType
  • MsgRecInfoArray_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_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.

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.
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 Tue Aug 8 2023