Enterprise Solutions

Credit Card Account Inquiry

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

Credit Card Account Inquiry

Credit Card Account Inquiry is a jXchange service designed to provide consumers the ability to inquire on the details as related to a credit card.

Message Flow

In jXchange, the Credit Card Account Inquiry service uses a typical exchange of MType messages to provide consumers the ability to inquire on the details as related to a credit card.

Primary Request

The consumer forwards the CrCardAcctInqRq_MType message to the service provider. The message contains the following simple element:

  • CrCardAcctId

Primary Response

The service provider returns the CrCardAcctInqRs_MType message to the consumer. The message contains the following simple element:

  • CrCardAcctId

Credit Card Account Inquiry Behavior

The Credit Card Account Inquiry root request message (CrCardAcctInqRq_MType) requires a valid Credit Card Account Identification (CrCardAcctId). The root request optionally includes the Include Extended Element Array (IncXtendElemArray_AType). However, failure to submit a named complex results in an empty response.

The Credit Card Account Inquiry root response message (CrCardAcctInqRs_MType) echoes back the request element. The response returns the following:

  • Extended Credit Card Account Information Record (x_CrCardAcctInfoRec_CType)
  • Extended Credit Card Account Summary Record (x_CrCardAcctSumRec_CType)
  • Extended Credit Card Fraud Information Record (x_CrCardFraudInfoRec_CType)
  • Extended Identification Verification complex (x_IdVerify_CType)

The Extended Credit Card Account Summary Record complex (x_CrCardAcctSumRec_CType) delivers a scaled-down version of a complete inquiry to allow the consumer to provide a quick view of common elements. The Extended Credit Card Account Summary Record (x_CrCardAcctSumRec_CType) encapsulates the following:

  • Account Status (AcctStat)
  • Account Status Description (AcctStatDesc)
  • Available Credit (AvailCr)
  • Credit Card Product Description (CrCardProdDesc)
  • Current Balance (CurBal)
  • Last Payment Amount (LastPmtAmt)
  • Last Payment Date (LastPmtDt)
  • Last Statement Balance (LastStmtBal)
  • Last Statement Date (LastStmtDt)
  • Line of Credit Limit (LOCLmt)
  • Minimum Payment Amount (MinPmtAmt)
  • Next Pay Date (NxtPayDt)
  • Redeemable Reward Points Balance (RedeemRewPtBal)

The Extended Credit Card Account Information Record complex (x_CrCardAcctInfoRec_CType) encapsulates all the same elements included in the Extended Credit Card Account Summary record complex (x_CrCardAcctSumRec_CType) plus the following:

  • Credit Card Account Information Record complex (CrCardAcctInfoRec_CType)
  • Credit Card Activity Description (CrCardActDesc)
  • Credit Card Limit Update Description (CrCardLmtUpdDesc)
  • Credit Life Company Description (CrLifeCompDesc)
  • Last Limit Update Date (LastLmtUpdDt)
  • Line of Credit Status Description (LOCStatDesc)
  • Opening Date (OpenDt)
  • Past Due Days (PastDueDays)

The Credit Card Account Information Record complex (CrCardAcctInfoRec_CType) encapsulates all the same elements included in the Extended Credit Card Account Summary record complex (x_CrCardAcctSumRec_CType) plus the following:

  • Email Array (EmailArray_AType)
  • Phone Array (PhoneArray_AType)
  • User Definition Information Array (UserDefInfoArray_AType)
  • Annual Percentage Rate (AnnPctRate)
  • Cash Advance Annual Percentage Rate (CashAdvAnnPctRate)
  • Credit Card Activity Code (CrCardActCode)
  • Credit Card Expiration Date (CrCardExpDt)
  • Credit Card Issued Number (CrCardIssuedNum)
  • Credit Card Limit Update Code (CrCardLmtUpdCode)
  • Credit Life Company Code (CrLifeCompCode)
  • Embossed Name (EmbosName)
  • Interest Paid Year-to-Date (IntPaidYTD)
  • Last Credit Card Order Date (LastCrCardOrderDt)
  • Line of Credit Limit Maintenance Date (LOCLmtMainDt)
  • Line of Credit Status (LOCStat)
  • Past Due Amount (PastDueAmt)
  • Previous Line of Credit Limit (PrevLOCLmt)
  • Secondary Embossed Name (SecdEmbosName)
  • Statement Cycle (StmtCycle)

The Extended Credit Card Fraud Information Record complex (x_CrCardFraudInfoRec_CType) encapsulates the Fraud Plan Description (FraudPlanDesc) and Credit Card Fraud Information Record complex (CrCardFraudInfoRec_CType).

The Credit Card Fraud Information Record complex (CrCardFraudInfoRec_CType) encapsulates the following elements:

  • Fraud Plan Code (FraudPlanCode)
  • Fraud Score (FraudScore)
  • Fraud Score Date (FraudScoreDt)
  • Fraud Suspect Date (FraudSusDt)
  • Fraud Suspended Plan Code (FraudSuspPlanCode)
  • Fraud Suspended Plan Suspended End Date (FraudSuspPlanSuspEndDt)
  • Fraud Suspended Plan Suspended Start Date (FraudSuspPlanSuspStartDt)

CrCardAcctInqRq_MType

CrCardAcctInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • IncXtendElemArray_AType
  • 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.

IncXtendElemArray_AType

IncXtendElemArray_AType is an array AType element. This is an array that lists x_ elements by name, which are to be included in the response.

Contains:

  • IncXtendElemInfo_CType

IncXtendElemInfo_CType

IncXtendElemInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

XtendElem
Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.

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.

CrCardAcctInqRs_MType

CrCardAcctInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • x_CrCardAcctInfoRec_CType
  • x_CrCardAcctSumRec_CType
  • x_CrCardFraudInfoRec_CType
  • x_IdVerify_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.

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.

x_CrCardAcctInfoRec_CType

x_CrCardAcctInfoRec_CType is a complex CType element.

Contains:

  • AuthUsrCrCardArray_AType
  • CrCardAcctInfoRec_CType
  • CrCardRwrdInqArray_AType
  • Custom_CType

Simple Elements

The following simple elements are contained within this complex.

AcctStatDesc
The account status description.
AvailCr
The available credit.
CrCardActDesc
The description of the code that defines the state of the activation of a credit card.
CrCardLmtUpdDesc
The description of the code that defines the reason the credit card limit was updated.
CrCardPgmName
The program name as related to a credit card.
CrLifeCompDesc
The description of the code that references the credit life insurance company.
CurBal
The current balance.
LastLmtUpdDt
The date the last time a credit limit was updated.
LOCStatDesc
The description of the status of the line of credit.
OpenDt
The date opened.
OrgIssueCrCardAcctId
The number or character that identifies an account record.
PastDueDays
The number of days a loan is past due.
ReIssueCrCardAcctId
The number or character that identifies an account record.

AuthUsrCrCardArray_AType

AuthUsrCrCardArray_AType is an array AType element. This is an array of credit card aliases and authorized users.

Contains:

  • AuthUsrCrCardRec_CType
AuthUsrCrCardRec_CType

x_CrCardAcctInfoRec_CType is a complex CType element.

Contains:

  • AuthUsrName references PersonName_CType
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

AliasCrCardId
The number or character that identifies an account record.
AuthUsrCrCardType
The type of alias/authorized user's credit card. Canonical values are:
  • Prim
  • Secd
  • Auth
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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

CrCardAcctInfoRec_CType

CrCardAcctInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • EmailArray_AType
  • PhoneArray_AType
  • UserDefInfoArray_AType
Simple Elements

The following simple elements are contained within this complex.

AcctStat
The account status.
AnnPctRate
The annual percentage rate (APR).
CashAdvAnnPctRate
The annual percentage rate (APR).
CrCardActCode
The code that defines the state of the activation of a credit card.
CrCardExpDt
The expiration date.
CrCardIssuedNum
The number of credit cards issued.
CrCardLmtUpdCode
The code that defines the reason the credit limit was updated.
CrCardProdDesc
The description of the credit card product.
CrLifeCompCode
The code that references the credit life insurance company.
EmbosName
The name that is embossed on the EFT card.
IntPaidYTD
The interest paid year-to-date.
LastCrCardOrderDt
The last date that a credit card was ordered.
LastPmtAmt
The last payment amount.
LastPmtDt
The last payment date.
LastStmtBal
The last statement balance.
LastStmtDt
The last statement date.
LOCLmtMainDt
The last maintenance date.
LOCLmt
The line of credit limit.
LOCStat
The status of the line of credit.
MinPmtAmt
The minimum payment amount.
NxtPayDt
The next payment date.
PastDueAmt
The past due amount.
PrevLOCLmt
The previous line of credit limit.
RemMinPmtAmt
The remaining minimum payment amount.
SecdEmbosName
The secondary name that could be embossed on the EFT card.
StmtCycle
The statement cycle.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

EmailArray_AType

EmailArray_AType is an array AType element. This is an array used to define email contact information.

Contains:

  • EmailInfo_CType
EmailInfo_CType

EmailInfo_Ctype is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

EmailAddr
Email address.
EmailType
Email type. Examples: Home, Work, Statement, Notice. Canonical values are:
  • Prim
  • Secd
  • OLB

EmailType is a hybrid open enumeration.

PhoneArray_AType

PhoneArray_AType is an array AType element. This array contains one or more PhoneInfo_CType complexes to define phone contact information. This array is optional.

Contains:

  • PhoneInfo_CType
PhoneInfo_CType

PhoneInfo_CType is a complex CType element. It contains basic phone contact information. This complex is optional.

Contains:
  • MobPhoneInfo_CType
Simple Elements

The following simple elements are contained within this complex.

ConEndTime
The Greenwich Mean time when contact availability ends.
ConStartTime
The Greenwich Mean time when contact availability starts.
PhoneExt
The phone extension.
PhoneNumDsp
Phone Number Display, based on format codes which may include special formatting. Examples include:
  • (XXX)XXX-XXXX
  • XXX-XXX-XXXX
  • XXX/XXX/XXXX
  • XXX.XXX.XXXX
  • XXX-XXX-XXXXXX
  • XXXXX-XXX-XXX-XXXX
PhoneNum
The phone number.
PhoneTime
Best phone usage time, day, or evening.
PhoneType

Phone type examples are: home, work, fax, cell. Canonical values are:

  • Home
  • SecdHome
  • Bus
  • SecdBus
  • HomeCell
  • BusCell
  • PersonalCell
  • HomeFax
  • BusFax
  • SecdBusCell

PhoneType is a hybrid open enumeration.

UserDefInfoArray_AType

UserDefInfoArray_AType is an array AType element. This is an array of UserDefInfo simple elements used to describe user-defined information.

Contains:

  • UserDefInfo_CType
UserDefInfo_CType

UserDefInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

OvrrdInstRtId
Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
UserDefCode
The code that represents the answer to the UserDefTxt.
UserDefDesc
The description of what the UserDefCode represents.
UserDefDt
A date field that has a relationship with the UserDefTxt or UserDefCode.
UserDefInfo1
Additional information that may accompany any of the user supplied codes.
UserDefInfo2
Additional information that may accompany any of the user supplied codes.
UserDefInfo3
Additional information that may accompany any of the user supplied codes.
UserDefTxt
User Defined Text is part of a matched pair array that describes the proceeding elements.

CrCardRwrdInqArray_AType

CrCardRwrdInqArray_AType is an array AType element. This is an array of reward values for inquiry.

Contains:

  • CrCardRwrdInqRec_CType
CrCardRwrdInqRec_CType

CrCardRwrdInqRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • RwrdPtCatArray_AType
  • RwrdPtExpArray_AType
Simple Elements

The following simple elements are contained within this complex.

RedeemRwrdPtAmt
The number of reward points that have been redeemed.
RwrdProdDesc
The description or name given to a rewards product.
RwrdPtAccrAmt
The number of reward points that have accrued but are not yet available.
RwrdPtEarnLTD
The number of reward points that have been earned life-to-date.
RwrdPtExpAmt
The number of reward points that are scheduled for expiration.
RwrdPtExpDt
The date the reward points are due to expire.
RwrdPtRedeemLTD
The number of reward points that have been redeemed life-to-date.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

RwrdPtCatArray_AType

RwrdPtCatArray_AType is an array AType element. This is an array of reward point categories.

Contains:

  • RwrdPtCatRec_CType
RwrdPtCatRec_CType

RwrdPtCatRec_MType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this message.

RwrdPtCatType

The category as related to reward points. Canonical values are:

  • Adj
  • Earn
  • Forfeit
  • TradeIn
  • TradeOut
  • Redeem
RwrdPtCycleAmt
The amount of reward points.
RwrdPtDailyAmt
The amount of reward points.
RwrdPtLTDAmt
The amount of reward points.
RwrdPtMTDAmt
The amount of reward points.
RwrdPtPrevCycleAmt
The amount of reward points.
RwrdPtQTDAmt
The amount of reward points.
RwrdPtYTDAmt
The amount of reward points.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

RwrdPtExpArray_AType

RwrdPtExpArray_AType is an array AType element. This is an array of reward expiration dates and amounts.

Contains:

  • RwrdPtExpRec_CType
RwrdPtExpRec_CType

RwrdPtExpRec_MType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this message.

RwrdPtExpAmt
The number of reward points that are scheduled for expiration.
RwrdPtExpDt
The date the reward points are due to expire.
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.

x_CrCardAcctSumRec_CType

x_CrCardAcctSumRec_CType is a complex CType element.

Contains:

  • AuthUsrCrCardArray_AType
  • CrCardRwrdInqArray_AType
  • Custom_CType

Simple Elements

The following simple elements are contained within this complex.

AcctStatDesc
The account status description.
AcctStat
The account status.
AvailCr
The available credit.
CrCardProdDesc
The description of the credit card product.
CurBal
The current balance.
LastPmtAmt
The last payment amount.
LastPmtDt
The last payment date.
LastStmtBal
The last statement balance.
LastStmtDt
The last statement date.
LOCLmt
The line of credit limit.
MinPmtAmt
The minimum payment amount.
NxtPayDt
The next payment date.
RemMinPmtAmt
The remaining minimum payment amount.

AuthUsrCrCardArray_AType

AuthUsrCrCardArray_AType is an array AType element. This is an array of credit card aliases and authorized users.

Contains:

  • AuthUsrCrCardRec_CType
AuthUsrCrCardRec_CType

x_CrCardAcctInfoRec_CType is a complex CType element.

Contains:

  • AuthUsrName references PersonName_CType
  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

AliasCrCardId
The number or character that identifies an account record.
AuthUsrCrCardType
The type of alias/authorized user's credit card. Canonical values are:
  • Prim
  • Secd
  • Auth
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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

CrCardRwrdInqArray_AType

CrCardRwrdInqArray_AType is an array AType element. This is an array of reward values for inquiry.

Contains:

  • CrCardRwrdInqRec_CType
CrCardRwrdInqRec_CType

CrCardRwrdInqRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • RwrdPtCatArray_AType
  • RwrdPtExpArray_AType
Simple Elements

The following simple elements are contained within this complex.

RedeemRwrdPtAmt
The number of reward points that have been redeemed.
RwrdProdDesc
The description or name given to a rewards product.
RwrdPtAccrAmt
The number of reward points that have accrued but are not yet available.
RwrdPtEarnLTD
The number of reward points that have been earned life-to-date.
RwrdPtExpAmt
The number of reward points that are scheduled for expiration.
RwrdPtExpDt
The date the reward points are due to expire.
RwrdPtRedeemLTD
The number of reward points that have been redeemed life-to-date.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

RwrdPtCatArray_AType

RwrdPtCatArray_AType is an array AType element. This is an array of reward point categories.

Contains:

  • RwrdPtCatRec_CType
RwrdPtCatRec_CType

RwrdPtCatRec_MType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this message.

RwrdPtCatType

The category as related to reward points. Canonical values are:

  • Adj
  • Earn
  • Forfeit
  • TradeIn
  • TradeOut
  • Redeem
RwrdPtCycleAmt
The amount of reward points.
RwrdPtDailyAmt
The amount of reward points.
RwrdPtLTDAmt
The amount of reward points.
RwrdPtMTDAmt
The amount of reward points.
RwrdPtPrevCycleAmt
The amount of reward points.
RwrdPtQTDAmt
The amount of reward points.
RwrdPtYTDAmt
The amount of reward points.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

RwrdPtExpArray_AType

RwrdPtExpArray_AType is an array AType element. This is an array of reward expiration dates and amounts.

Contains:

  • RwrdPtExpRec_CType
RwrdPtExpRec_CType

RwrdPtExpRec_MType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this message.

RwrdPtExpAmt
The number of reward points that are scheduled for expiration.
RwrdPtExpDt
The date the reward points are due to expire.
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.

x_CrCardFraudInfoRec_CType

x_CrCardFraudInfoRec_CType is a complex CType element.

Contains:

  • CrCardFraudInfoRec_CType
  • Custom_CType

Simple Elements

The following simple elements are contained within this complex.

FraudPlanDesc
The description of the code that defines the plan to use for a fraud suspect.

CrCardFraudInfoRec_CType

CrCardFraudInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

FraudPlanCode
The code that defines the plan to use for a fraud suspect.
FraudScoreDt
The date a score was given for a possible fraud.
FraudScore
The score given for a possible fraud.
FraudSusDt
The date that fraud activity could have occurred.
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.
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.

x_IdVerify_CType

x_IdVerify_CType is a complex CType element.

Contains:

  • IdVerifyArray_AType

IdVerifyArray_AType

IdVerifyArray_AType is an array AType element. This is an array of simple elements used to define identification of verification values.

Contains:

  • IdVerify_CType
IdVerify_CType

IdVerify_CType is a complex CType element. This element contains basic identification verification information and is optional.

Contains:

  • IdVerifyQueryArray_AType
Simple Elements

The following simple elements are contained within this complex.

IdIssueBy
The individual that issued the identification value IdVerifyId.
IdVerifyBy
The individual that verified the authenticity of the identification value IdVerifyId.
IdVerifyCode
The identification code that is used to authenticate the customer.
IdVerifyDesc
The description of the identification code that is used to authenticate the customer.
IdVerifyVal
The identification value that is used to authenticate the customer.
IdVerifyQueryArray_AType

IdVerifyQueryArray_AType is an array AType element. This array includes identification query/questions and their respective values for customer/account verification.

Contains:

  • IdVerifyQueryInfo_CType
IdVerifyQueryInfo_CType

IdVerifyQueryInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

IdVerifyQuery
A description of the query/question that could be used for customer/account identification purposes. Canonical values are:
  • ConDt
  • DocType
  • ExpDt
  • IssDt
  • IssLoc
  • IssState
  • VerifId
IdVerifyQueryVal
A value that corresponds with the description of the query/question IdVerifyId that could be used for customer/account identification purposes.
IdVerifyQueryDataType
Identifies what type of attributes corresponds with the IdVerifyQueryVal. Canonical values are:
  • Decimal
  • Dt
  • Integer
  • String

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 Thu Feb 8 2024