Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Credit Card Holder Inquiry

Enterprise SOAP API > API by Reference > Card Services > Credit Card Holder Inquiry

Credit Card Holder Inquiry

Credit Card Holder Inquiry is a jXchange service designed to provide a service that conveys the status and details related to each credit card account holder.

Message Flow

In jXchange, the Credit Card Holder Inquiry service uses a typical exchange of MType messages to provide a service that conveys the status and details related to each credit card account holder.

Primary Request

The consumer forwards the CrCardHolderInqRq_MType message to the service provider.

The message contains the following simple element:

  • CrCardAcctId

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType

Primary Response

The service provider returns the CrCardHolderInqRs_MType message to the consumer.

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

The message contains the following array:

  • CrCardHolderArray_AType

Credit Card Holder Inquiry Behavior

The Credit Card Holder Inquiry behavior is as follows.

The Credit Card Holder Inquiry root request (CrCardHolderInqRq_MType) requires a valid credit card account identifier.

The Credit Card Holder Inquiry root response (CrCardHolderInqRs_MType) returns the Credit Card Holder Array (CrCardHolderArray_AType), which encapsulates the following simple elements:

  • Authorized User Name (AuthUsrName)
  • Authorized User Credit Card Code (AuthUsrCrCardCode)
  • Authorized User Credit Card Description (AuthUsrCrCardDesc)
  • Embossed Name (EmbosName)
  • Credit Card Activation Code (CrCardActCode)
  • Credit Card Activation Description (CrCardActDesc)
  • Credit Card Activation Date (CrCardActDt)
  • Alias Credit Card Identifier (AliasCrCardId)
  • Alias Credit Card Status (AliasCrCardStat)
  • Alias Credit Card Status Description (AliasCrCardStatDesc)
  • Credit Card Type (CrCardType with canonical values: Plastic, ContactlessChip, EMV, Mobile, EMVContactlessChip)
  • Credit Card Issued Number (CrCardIssuedNum)
  • Credit Card Image Code (CrCardImgCode)
  • Credit Card Expiration Date (CrCardExpDt)
  • Reissuance Credit Card Code (ReIssueCrCardCode)
  • Fraud Suspended Plan Suspended Start Date (FraudSuspPlanSuspStartDt)
  • Fraud Suspended Plan Suspended End Date (FraudSuspPlanSuspEndDt)
  • Fraud Suspended Plan Code (FraudSuspPlanCode)

The Credit Card Holder Array (CrCardHolderArray_AType) encapsulates the Credit Card Holder History Array (CrCardHolderHistArray_AType), which encapsulates the following simple elements:

  • Credit Card Issue Reason Description (CrCardIssueRsnDesc)
  • Credit Card Issue Reason Code (CrCardIssueRsnCode)
  • Credit Card Product Description (CrCardProdDesc)
  • Card Shipping Date (CardShipDt)
  • Card Production Type (CardProdType with canonical values: Std - Standard, Ovrngt - Overnight, and 3rdDay - Third Day)

The Card Activation Date (CrCardActDt) value is 0001-01-01 until activated.

The Credit Card Product Description (CrCardProdDesc) and Card Shipping Date (CardShipDt) only have a value when the Alias Credit Card Status (AliasCrCardStat) value is null/blank.

CrCardHolderInqRq_MType

CrCardHolderInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CrCardAcctId
The number or character that identifies an account record.

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.

CrCardHolderInqRs_MType

CrCardHolderInqRs_MType is a message MType element.

Contains:

  • CrCardHolderArray_AType
  • Custom_CType
  • MsgRsHdr_CType

CrCardHolderArray_AType

CrCardHolderArray_AType is an array AType element. This is an array of cardholders for a specific credit card account ID.

Contains:

  • CrCardHolderRec_CType

CrCardHolderRec_CType

CrCardHolderRec_CType is a complex CType element.

Contains:

  • AuthUsrName references PersonName_CType
  • CrCardHolderHistArray_AType
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

AliasCrCardId
The number or character that identifies an account record.
AliasCrCardStatDesc
The description of the status of the PIID.
AliasCrCardStat
The status of the PIID.
AuthUsrCrCardCode
The code that references the cardholder's member sequence ID.
AuthUsrCrCardDesc
The description of the code that references the cardholders member sequence ID.
CrCardActCode
The code that defines the state of the activation of a credit card.
CrCardActDesc
The description of the code that defines the state of the activation of a credit card.
CrCardActDt
The date the card was activated.
CrCardExpDt
The expiration date.
CrCardImgCode
The code defines the type of card image that appears on the credit card.
CrCardIssuedNum
The number of credit cards issued.
CrCardPrevExpDt
The previous credit card expiration date.
CrCardType
Describes the type of issued card. Canonical values are:
  • ContactlessChip
  • EMV
  • EMVContactlessChip
  • Mobile
  • Plastic
EmbosName
The name that is embossed on the EFT card.
FraudSuspPlanCode
The code that defines the plan to use for a fraud suspect.
FraudSuspPlanSuspEndDt
The end date that a score was given for possible fraud.
FraudSuspPlanSuspStartDt
The start date that a score was given for possible fraud.
ReIssueCrCardCode
This code defines the credit card reissuance method.
AuthUsrName

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

AuthUsrName references PersonName_CType.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.
CrCardHolderHistArray_AType

CrCardHolderHistArray_AType is an array AType element. This is an array of a cardholder's card order history.

Contains:

  • CrCardHolderHistRec_CType
CrCardHolderHistRec_CType

CrCardHolderHistRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

CardProdType

The details of how the card reorder is processed by the card producer. Canonical values are:

  • 3rdDay
  • Ovrngt
  • Std
CardShipDt
The date the card was shipped to the cardholder.
CrCardIssueRsnCode
This code defines the credit card issue reason code.
CrCardIssueRsnDesc
The description of the code that defines the credit card issue reason code.
CrCardProdDesc
The description of the credit card product.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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 Jan 24 2023