Enterprise Solutions

Credit Card Report Lost Add

Enterprise SOAP API > API by Reference > Card Services > Credit Card Report Lost Add
Credit Card Report Lost Addition

Credit Card Report Lost Addition

Credit Card Report Lost Addition is a jXchange service designed to allow a consumer to report that a credit card was lost or stolen.

Message Flow

In jXchange, the Credit Card Report Lost Addition service uses a typical exchange of MType messages to allow a consumer to report that a credit card was lost or stolen.

Primary Request

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

  • CrCardAcctId

Primary Response

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

  • RsStat

Credit Card Report Lost Addition Behavior

The Credit Card Report Lost Addition service behavior is as follows:

The Credit Card Report Lost Addition root request message (CrCardRptLostAddRq_MType) requires a valid Credit Card Account Identifier (CrCardAcctId) and Credit Card Report Lost Record complex (CrCardRptLostRec_CType).

The Credit Card Report Lost Record complex (CrCardRptLostRec_CType) contains required elements Credit Card Issued Number (CrCardIssuedNum), Credit Card Lost Number (CrCardLostNum), Loss State Code (LossStateCode) (ISO 3166-2 Enumerations), and Credit Card Lost Date (CrCardLostDt).

The Credit Card Report Lost Record complex (CrCardRptLostRec_CType) contains the following optional elements:

  • Contact Phone Number (ConPhoneNum)
  • Credit Card Expiration Date (CrCardExpDt)
  • Credit Card Lost Location Type (CrCardLostLocType)
  • Remark Array (RmkArray_AType)
  • EFT Card PIN Lost Type (EFTCardPINLostType)
  • Fraud Activity Reporting Type (FraudActRptType)
  • Address Verification Type (AddrVerifType)
  • Expedited Credit Card Delivery Type (ExpdCrCardDlvryType)

The Credit Card Report Lost Addition root response message (CrCardRptLostAddRs_MType) returns the Response Status (RsStat).

The Lost State Code (LostStateCode) can default to the cardholder’s state residence when reported outside of the U.S.

The Credit Card Account Inquiry (CrCardAcctInqRq_MType) should be called to pre-fill the elements Credit Card Issued Number (CrCardIssuedNum), Credit Card Expiration Date (CrCardExpDt), and Contact Phone Number (ConPhoneNum).

The standard addition message tenets are applicable.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the correlation identifications.

CrCardRptLostAddRq_MType

CrCardRptLostAddRq_MType is a message MType element.

Contains:

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

CrCardRptLostRec_CType

CrCardRptLostRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • RmkArray references Rmk_AType

Simple Elements

The following simple elements are contained within this message.

AddrVerifType
Was the address verified? Canonical values are:
  • True
  • False
ConPhoneNum
The phone number.
CrCardExpDt
The expiration date.
CrCardIssuedNum
The number of credit cards issued.
CrCardLostDt
The date the card was lost.
CrCardLostLocType
The lost location for a credit card. Canonical values are:
  • Auto
  • Bar
  • Home
  • Hotel
  • Off
  • Rural
  • Store
  • Unknown
CrCardLostNum
The number of credit cards issued.
EFTCardPINLostType
Answers the question: has the EFT card PIN ID reported lost? Canonical values are:
  • True
  • False
ExpdCrCardDlvryType
Should the credit card delivery be expedited? Canonical values are:
  • True
  • False
FraudActRptType
Has fraud activity been reported? Canonical values are:
  • True
  • False
LossStateCode
The 2 alpha long code which represents a state. For example, MO.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

RmkArray

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

RmkArray references Rmk_AType

Contains:

  • RmkInfo_CType
RmkInfo_CType

RmkInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Rmk
Application or user remarks free-form text.

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.

CrCardRptLostAddRs_MType

CrCardRptLostAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

RsStat
The status of the response. Canonical values are:
  • Fail
  • Success

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