EFT Card Order Add
EFT Card Order Add
EFT Card Order Add is a jXchange service designed to allow a consumer to request a newly issued card or activate a card.
Message Flow
In jXchange, the EFT Card Order Add service uses a typical exchange of
MType messages to request a newly issued card or activate a card.
Primary Request
The Third Party Consumer forwards the EFTCardOrderAddRq_MType message to
the Service Provider. The message contains:
- EFTCardNum
- EFTCardOrderType
- EFTCardSufxNum
Primary Response
The Service Provider returns the EFTCardOrderAddRs_MType message to the
Third Party Consumer. The message contains RsStat, which states the
status of the request.
EFT Card Order Add Behavior
The EFTCardOrderAddRq_MType
request message requires the EFTCardNum element and
EFTCardOrderInfoRec_CType complex. The
EFTCardSufxNum and EFTCardOrderType elements
can be optionally submitted.
The EFTCardOrderType element's enumerated values are ~IssOnly~ and ~IssAct~. The default is ~IssOnly~.
The EFTCardExpDt and EFTCardTrak1Val elements
are required elements encapsulated by the EFTCardOrderInfoRec_CType
complex.
The EFTCardOrderInfoRec_CType complex encapsulates the
EFTCardActArray_AType array, which is a named value pair to provide the
service provider with the type and values to activate an EFT card. The
EFTCardActType and EFTCardActVal elements are
both required.
EFTCardOrderAddRq_MType
EFTCardOrderAddRq_MType is a message
MType element.
Contains:
Custom_CTypeEFTCardOrderInfoRec_CTypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- EFTCardNum
- The number that is assigned to an EFT card. The card number includes the ISO number.
- EFTCardOrderType
The type of EFT card action. Canonical values are:
- IssAct
- IssOnly
The default is IssOnly.
- 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.
EFTCardOrderInfoRec_CType
EFTCardOrderInfoRec_CType is a complex
CType element.
Contains:
Custom_CTypeEFTCardActArray_ATypeEFTCardMailAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- AcctType
- The number or character that categorizes the AcctId.
- AvlBal
- The available balance. The optional attribute Calculate describes how the available balance was calculated starting with CurBal.
- CardRushMthdCode
- The code that identifies the type of rush method for card delivery.
- CardRushOpt
Option for rushing a payment to a payee. Canonical values are:
- 2ndDay - Second Day
- 2ndDayEc - Second Day Economy
- 3rdDay - Third Day
- Ovrngt - Overnight
- Std - Standard
- EFTCardExpDt
- The expiration date given to an EFT card.
- EFTCardPINOffSetId
- The EFT card PIN offset identification.
- EFTCardTrak1Val
- The value encoded on an EFT card's track 1 of the magnetic stripe.
- EFTCardTrak2Val
- The value encoded on an EFT card's track 2 of the magnetic stripe.
- EmbosName
- The name that is embossed on the EFT card.
- SecdEmbosName
- The secondary name that could be embossed on the EFT card.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EFTCardActArray_AType
EFTCardActArray_AType is an array
AType element. This is an array of EFT card activation data.
Contains:
EFTCardActInfoRec_CType
EFTCardActInfoRec_CType
EFTCardActInfoRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- EFTCardActType
- The type of data used for an EFT card activation. Canonical values
are:
- BirthDt
- CellPhone
- CustId
- HomePhone
- MotherMaidName
- TaxId
- UsrPswd
- WorkPhone
- EFTCardActVal
- The data value that corresponds with the type used for an EFT card activation.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
EFTCardMailAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
EFTCardMailAddr references Addr_CType.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the ZIP code.
- FornAddr
- Is this address a foreign address? Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The two-character alpha code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
FreeFormAddr_AType
FreeFormAddr_AType is an array AType element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free-form element of address lines 1–11 in a printable/usable form, generally not separated.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
EFTCardOrderAddRs_MType
EFTCardOrderAddRs_MType is a message
MType element.
Contains:
MsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- RsStat
The status of the response. Canonical values are:
- fail
- success
MsgRsHdr_CType
MsgRsHdr_CType is a complex
CType element. This is the default message response
header.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.