EFT Card Search

Enterprise SOAP API > API by Reference > Core Services > EFT Card Search

EFT Card Search

EFT Card Search is a jXchange service designed to provide the consumer with the ability to search for EFT cards.

Message Flow

In jXchange, the EFT Card Search service uses a typical exchange of MType messages to provide the consumer with the ability to search for EFT cards.

Primary Request

The Third Party Consumer forwards the EFTCardSrchRq_MType message to the Service Provider. The message contains ComName, CustId, EFTCardNum, TaxId, and AccountId_CType, which are all allowable filters. CustId and AccountId_CType are key type search elements.

The Service Provider returns the EFTCardSrchRs_MType message to the Third Party Consumer. The message contains an echo of the filters submitted in the request and the EFTCardSrchArray_AType. The elements contained within the EFTCardSrchArray_AType should provide data values to assist the consumer with identifying each EFT card.

EFT Card Search Behavior

The EFTCardNum, TaxId, and ComName elements each contain a SrchType attribute. The service provider should support the canonical values (Exact, StartsWith, EndsWith, Contains) for the referenced elements.

The service provider should make the search comparison of the ComName element to the EmbosName and SecdEmbosName elements.

EFT Card Service Business Case

This is an example document.

In this business case, a bank working with a Service Provider wants to establish a new debit card for one of their consumers.

Establish a New Debit Card

This is an example document.

The bank uses the CustSrch service to obtain the consumer identification. They send the following message:

Message	Complex Element, Simple Element, or Array	Input
`CustSrchRq`	`TaxId`	`111223333`

The Service Provider sends the bank the following response:

Message	Complex Element, Simple Element, or Array	Input
`CustSrchRs`	`CustId`	`123456`

The bank captures the consumer identification and submits the EFTCardAdd service to obtain a EFT card number. The bank makes the following request:

Message	Complex Element, Simple Element, or Array	Input
`EFTCardAddRq`	`CustId`	`123456`
	`EFTCardType`	`Debit`
	`EmbosName`	`Example Consumer Name`
	`EFTCardAcctId`	`889`
	`EFTCardAcctType`	`DDA`
	`EFTCardPrimAcct`	`true`

The Service Provider sends the bank the following response:

Message	Complex Element, Simple Element, or Array	Input
`EFTCardAddRs`	`EFTCardNum`	`1234123412341234`
	`EFTCardSufxNum`	`1`
	`RsStat`	`Success`

EFT Card Services Business Case 2

In this example, a consumer is deactivating an existing EFT Card.

The consumer sends the EFTCardModRq message to the Service Provider with the following values:

The MsgRqHdr follows the standard header requirements.

Complex Name	Simple Element	Entry Value
	`EFTCardNum`	`44404567852123541`
	`EFTCardSufxNum`	`Hot Card`
	`Dlt`	`True`

Complex Element	Simple Element	Entry Value
`EFTCardModRec`	`EFTCardStat`	`Active`
	`EmbosName`	`John Doe`
	`SecdEmbosName`	`Ann Doe`

The Service Provider returns the RsStat with a status of Success.

EFTCardSrchRq_MType

EFTCardSrchRq_MType is a message MType element.

Contains:

AccountId_CType
Custom_CType
SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ComName: The common name. This is the full text line name like John Doe.
CustId: The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EFTCardNum: The number that is assigned to an EFT card. The card number includes the ISO number.
TaxId: The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

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

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

EFTCardSrchRs_MType

EFTCardSrchRs_MType is a message MType element.

Contains:

AccountId_CType
Custom_CType
EFTCardSrchArray_AType
SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

ComName: The common name. This is the full text line name like John Doe.
CustId: The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EFTCardNum: The number that is assigned to an EFT card. The card number includes the ISO number.
TaxId: The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

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

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EFTCardSrchArray_AType

EFTCardSrchArray_AType is an array AType element. It is an array of responses for EFT card search.

Contains:

EFTCardSrchRec_CType

EFTCardSrchRec_CType

EFTCardSrchRec_CType is a complex CType element.

Contains:

EFTCardSrchCustom references Custom_CType

Simple Elements

The following simple elements are contained within this complex.

CustId

The identifier attached to a customer. It includes the OvrrdInstRtId attribute.

EFTCardBINCode

The code that identifies the type of BIN.

EFTCardBINDesc

The description of the code that identifies the type of BIN.

EFTCardNum

The number that is assigned to an EFT card. The card number includes the ISO number.

EFTCardStatDesc

The description of the status of an issued EFT card.

Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01.

EFTCardStat

The status of an issued EFT card. Canonical values are:

Act
Cls
CardLmtExist
Del
DepOnly
Exp
HotCard
Iss
ManActReq
OrderCard
OrderInProc
PINMail
PINXsTries
ReOrderCard
ReOrderDeny
WarmCard

Note: This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new element for EFT statuses is EFTCardStatType, in which the status values are represented by closed canonical values.

EFTCardStatType

The status of an issued EFT card. Canonical values are:

Act
CardLmtExist
Cls
Del
DepOnly
Exp
HotCard
InstantIss
InstantIssMail
Iss
ManActReq
OrderCard
OrderInProc
PINMail
PINXsTries
ReOrderCard
ReOrderDeny
WarmCard

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.

EmbosName

The name that is embossed on the EFT card.

LastActDt

The date of the last activity.

SecdEmbosName

The secondary name that could be embossed on the EFT card.

TaxId

The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

EFTCardSrchCustom

Custom_CType is a complex CType element.

EFTCardSrchCustom references Custom_CType.

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