Wire Template Addition
Wire Template Addition
Wire Template Addition is a jXchange service designed to add wire templates.
Message Flow
In jXchange, the Wire Template Addition service uses a typical exchange of
MType messages to allow a
consumer to add wire templates.
Primary Request
The consumer forwards the WireTmpltAddRq_MType message to
the service provider.
The message contains the following simple elements:
- WireAcctId
- WireAcctType
- WireUsrId
- WireVerifId
The message contains the following complex elements:
Custom_CTypeMsgRqHdr_CTypeWireTrnInfoRec_CType
The message contains the following array:
ErrOvrRdInfoArray_AType
Primary Response
The service provider returns the WireTmpltAddRs_MType message to
the consumer.
The message contains the following simple elements:
- RsStat
- WireTmpltId
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
Wire Template Addition Behavior
The request requires a valid wire account identification
(WireAcctId) simple element and the Wire Transaction Information
Record complex (WireTrnInfoRec_CType) to be submitted.
The Wire User Identification (WireUsrId) and Wire Verification Identification (WireVerifId) simple elements can optionally be submitted when the service provider governs a level of permission for wire activity.
The elements encapsulated by the Wire Transaction Information
Record complex (WireTrnInfoRec_CType) are all optional due to the complex
reuse in other operations. The service provider governs the elements required for a successful
addition.
The Wire Transaction Information Record complex
(WireTrnInfoRec_CType) encapsulates several arrays based on requirements by
the service provider as well as Federal Reserve Financial Services FedWire Application
interface.
The Wire Originator to Beneficiary Remark Array
(WireOrignToBenfRmkArray_AType) is used to identify information conveyed by
the originator of the message to the beneficiary, which represents the FedWire {6000} tag
statement.
The Wire Receiving Financial Institution Remark Array
(WireRecvFinInstRmkArray_AType) is used to convey information to the
receiving financial institution, which represents the FedWire {6100} tag statement.
The Wire Draw Down Debit Remark Array
(WireDrwDwnDrRmkArray_AType) is used to convey advice information as
related to a draw down, which represents the FedWire {6110} tag statement.
The Wire Intermediate Financial Institution Remark Array
(WireIntmdFinInstRmkArray_AType) is used to convey information to the
intermediary financial institution, which represents the FedWire {6200} tag statement.
The Wire Intermediate Financial Institution Advice Remark Array
(WireIntmdFinInstAdviceRmkArray_AType) is used to convey advice information
to the intermediary financial institution, which represents the FedWire {6210} tag
statement.
The Wire Beneficiary Financial Institution Remark Array
(WireBenfFinInstRmkArray_AType) is used to convey advice information to the
beneficiary's financial institution, which represents the FedWire {6300} tag statement.
The Wire Beneficiary Financial Institution Advice Remark Array
(WireBenFinInstAdviceRmkArray_AType) is used to convey advice intended
specifically for the beneficiary's financial institution FedWire {6310} tag statement. The
Wire Beneficiary Remark Array (WireBenRmkArray_AType) is used to convey
information to the beneficiary, which represents the FedWire {6400} tag statement.
The Wire Beneficiary Remark Advice Remark Array
(WireBenAdviceRmkArray_AType) is used to convey advice intended
specifically for the beneficiary advice FedWire {6410} tag statement.
The Wire Beneficiary Payment Method Remark Array
(WireBenfPmtMthdRmkArray_AType) is used to convey information as to the
method of payment to the beneficiary, which represents the FedWire {6420} tag statement.
The Wire Financial Institution to Financial Institution Remark
Array (WireFinInstToFinInstRmkArray_AType) is used to convey information to
the financial institutions in the transaction string which represents the FedWire {6500} tag
statement. The Wire Remark Array (WireRmkArray_AType) is used by the service
provider to provide information about the specific wire and may not be forwarded to the
financial institution's transaction stream.
The Wire Information Remark Array
(WireInfoRmkArray_AType) is used to convey free format information about
the wire transaction, which represents the FedWire {9000} tag statement. The response returns
the Wire Template Identification (WireTmpltId) simple element.
The standard addition message tenets are applicable. Adhere to the tenets related to the JHANull attribute. Adhere to the tenets for Fault and Warnings. Adhere to the tenets related to Backwards Compatibility.
WireTmpltAddRq_MType
WireTmpltAddRq_MType is a message
MType element.
Contains:
Custom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CTypeWireTrnInfoRec_CType
Simple Elements
The following simple elements are contained within this message.
- WireAcctId
- The account identification related to wires.
- WireAcctType
- The number or character that categorizes the AcctId.
- WireUsrId
- The applications' user identification for the transactional activity.
- WireVerifId
- The verification identification associated with a wire user identification for wire business activity permission.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
ErrOvrRdInfoArray_AType
ErrOvrRdInfoArray_AType is an array
AType element. This is an array of overrides for
faults.
Contains:
ErrOvrRd_CType
ErrOvrRd_CType
ErrOvrRd_CType is a complex CType element. This
element is used to override errors created in a previous request. This element is
optional.
Simple Elements
The following simple elements are contained within this complex.
- BusSvcType
- The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
- ErrCode
- The error code.
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.
WireTrnInfoRec_CType
WireTrnInfoRec_CType is a complex
CType element.
Contains:
Custom_CTypeWireBenfInfoRec_CTypeWireFinInstToFinInstInfoRec_CTypeWireInfoRmkArrayreferencesRmk_ATypeWireOrignAddrreferencesAddr_CTypeWireOrignInfoRec_CTypeWireOrignNamereferencesPersonName_CTypeWireOrignToBenfInfoRec_CTypeWireOthXferInfoRec_CTypeWireRecvFinInstAddrreferencesAddr_CTypeWireRmkArrayreferencesRmk_ATypeWireSchedRecArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BrCode
- The branch code.
- EntityTmpltCorrelId
- The correlation identification as related to business functions and activities.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- GLProdCode
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- IntnetFinInstId
- The identification assigned to a consumer for the financial institution internet product.
- OffCode
- The code that designates the financial institution officer.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - WireAmt
- The transactional amount of the wire transfer.
- WireAnlysCode
- The code that identifies the behavior for Account Analysis activity for the transaction.
- WireFeeAmt
- The fee amount associated with a transaction.
- WireFuncType
- Identifies the business purpose of the FedWire Funds Transfer
message as related to FRB operating procedures. Canonical values are:
- BTR
- CKS
- CTR
- DEP
- DRB
- DRC
- DRW
- FFR
- FFS
- IRS
- SVC
- WireNotType
- Identifies the behavior for wire notification for a transaction.
Canonical values are:
- Fax
- None
- Prt
- EmailFax
- EmailPrt
- WireRecvFinInstName
- The name of the wire receiving financial institution.
- WireRecvFinInstRtId
- The routing identifier of the wire receiving financial institution.
- WireRefId
- The wire reference identification provided to a transaction.
- WireSrc
- Identifies the source entry of the wire transaction. Canonical
values are:
- DirectLine
- FIClerk
- Intnet
- WireStat
- Identifies the status of the wire transaction.
- WireSubType
- Identifies the subtype of the FedWire Funds Transfer message as
related to FRB operating procedures. Canonical values are:
- 00
- 01
- 02
- 07
- 08
- 20
- 31
- 32
- 33
- 90
- WireTmpltDesc
- The readable description assigned to a wire template.
- WireTrfTypeCode
- The code that designates the type of wire transfer category.
- WireTrnType
- Identifies the wire transactional activity. Canonical values
are:
- Both
- Incoming
- Outgoing
- WireType
- Identifies the type of the FedWire Funds Transfer message as
related to FRB operating procedures. Canonical values are:
- 10
- 15
- 16
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireBenfInfoRec_CType
WireBenfInfoRec_CType is a
complex CType element.
Contains:
Custom_CTypeWireBenfAddrreferencesAddr_CTypeWireBenfFinInstAddrreferencesAddr_CTypeWireDrFinInstAddrreferencesAddr_CTypeWireIntmdFinInstAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- WireBenfFinInstId
- The identification of the beneficiary-named financial institution for a wire transfer.
- WireBenfFinInstIdType
- Identifies the type of wire created as defined by the FRB.
- WireBenfFinInstName
- The name of the beneficiary-named financial institution for a wire transfer.
- WireBenfId
- The identifier associated with the Wire Beneficiary ID element.
- WireBenfIdType
- Identifies the type of beneficiary identification. Canonical values
are:
- Bank
- CHIPSId
- CHIPSPart
- CorpId
- DepAcct
- DriverLic
- Fed
- Oth
- PassPort
- ResidenceCard
- SwiftId
- TaxId
- WireBenfName
- The named beneficiary for a wire transaction.
- WireBenfRef
- Provides reference information for use by the beneficiary to identify the transfer.
- WireDrFinInstId
- The identification of the debit named financial institution for a wire transfer.
- WireDrFinInstIdType
- Identifies the type of wire created as defined by the FRB.
Canonical values are:
- Bank
- CHIPSId
- CHIPSPart
- DepAcct
- Fed
- WireDrFinInstName
- The name of the debit named financial institution for a wire transfer.
- WireIntmdFinInstId
- The identification of the intermediary named financial institution for a wire transfer.
- WireIntmdFinInstIdType
- Identifies the type of wire created as defined by the FRB. Canonical
values are:
- Bank
- CHIPSId
- CHIPSPart
- DepAcct
- Fed
- WireIntmdFinInstName
- The name of the intermediary named financial institution for a wire transfer.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireBenfAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
WireBenfAddr 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.
WireBenfFinInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
WireBenfFinInstAddr 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.
WireDrFinInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
WireDrFinInstAddr 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.
WireIntmdFinInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
WireIntmdFinInstAddr 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.
WireFinInstToFinInstInfoRec_CType
WireFinInstToFinInstInfoRec_CType
is a complex CType element.
Contains:
Custom_CTypeWireBenfAdviceRmkArrayreferencesRmk_ATypeWireBenfFinInstAdviceRmkArrayreferencesRmk_ATypeWireBenfFinInstRmkArrayreferencesRmk_ATypeWireBenfIPmtMthdRmkArrayreferencesRmk_ATypeWireBenfRmkArrayreferencesRmk_ATypeWireDrwDwnDrRmkArrayreferencesRmk_ATypeWireFinInstToFinInstRmkArrayreferencesRmk_ATypeWireIntmdFinInstAdviceRmkArrayreferencesRmk_ATypeWireIntmdFinInstRmkArrayreferencesRmk_ATypeWireRecvFinInstRmkArrayreferencesRmk_AType
Simple Elements
The following simple elements are contained within this complex.
- WirePmtMthd
- The method used for the payment to the beneficiary.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireBenfAdviceRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireBenfAdviceRmkArray 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.
WireBenfFinInstAdviceRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireBenfFinInstAdviceRmkArray 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.
WireBenfFinInstRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireBenfFinInstRmkArray 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.
WireBenfIPmtMthdRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireBenfIPmtMthdRmkArray 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.
WireBenfRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireBenfRmkArray 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.
WireDrwDwnDrRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireDrwDwnDrRmkArray 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.
WireFinInstToFinInstRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireFinInstToFinInstRmkArray 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.
WireIntmdFinInstAdviceRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireIntmdFinInstAdviceRmkArray 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.
WireIntmdFinInstRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireIntmdFinInstRmkArray 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.
WireRecvFinInstRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireRecvFinInstRmkArray 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.
WireInfoRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireInfoRmkArray 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.
WireOrignAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
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.
WireOrignInfoRec_CType
WireOrignInfoRec_CType is a
complex CType element.
Contains:
Customy_CTypeWireInstrFinInstAddrreferencesAddr_CTypeWireOrignFinInstAddrreferencesAddr_CType
Simple Elements
The following simple elements are contained within this complex.
- WireDrwDwnCrFinInstAcctId
- The draw down credit financial institution account identification.
- WireInstrFinInstId
- The identification of the instructing financial institution for a wire transfer.
- WireInstrFinInstIdType
- Identifies the type of wire created as defined by the FRB. Canonical
values are:
- Bank
- CHIPSId
- CHIPSPart
- DepAcct
- Fed
- WireInstrFinInstName
- The name of the instructing financial institution for a wire transfer.
- WireOrignFinInstId
- The identification of the originator named financial institution for a wire transfer.
- WireOrignFinInstIdType
- Identifies the type of wire created as defined by the FRB. Canonical
values are:
- Bank
- CHIPSId
- CHIPSPart
- DepAcct
- Fed
- WireOrignFinInstName
- The name of the originator-named financial institution for a wire transfer.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireInstrFinInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
WireInstrFinInstAddr 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.
WireOrignFinInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
WireOrignFinInstAddr 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.
WireOrignName
PersonName_CType is a complex CType
element. It contains name information. This complex is optional.
WireOrignName 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.
WireOrignToBenfInfoRec_CType
WireOrignToBenfInfoRec_CType is a
complex CType element.
Contains:
Custom_CTypeWireOrignToBenfRmkArrayreferencesRmk_AType
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireOrignToBenfRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireOrignToBenfRmkArray 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.
WireOthXferInfoRec_CType
WireOthXferInfoRec_CType is a
complex CType element.
Contains:
WireSndChgArray_AType
Simple Elements
The following simple elements are contained within this complex.
- WireCurrencyCode
- The code that references the type of currency used for the loan.
- WireDetOfChg
- Used by the SENDER DI to instruct the Receiver DI to deduct charges
and expenses from the payment amount. Canonical values are:
- Benf
- Shared
- WireExchRate
- The exchange rate for a specific currency.
- WireInstrAmt
- The transactional amount of the wire transfer.
WireSndChgArray_AType
WireSndChgArray_AType is an array
AType element. This is an array of sender charges for wire tag.
Contains:
WireSndChgRec_CType
WireSndChgRec_CType
WireSndChgRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- WireSndrChgOrder
- The sequential order of the wire sender charge.
- WireSndrChg
- Sender charges.
WireRecvFinInstAddr
Addr_CType is a complex
CType element containing address information. This element
is optional.
Contains:
FreeFormAddr_AType
WireRecvFinInstAddr references Addr_CType.
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.
WireRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
WireRmkArray 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.
WireSchedRecArray_AType
WireSchedRecArray_AType is an array AType element.
This is an array of responses for wire schedules.
Contains:
WireSchedRec_CType
WireSchedRec_CType
WireSchedRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- Amt
- The amount or quantity.
- IntnetFinInstId
- The identification assigned to a consumer for the financial institution internet product.
- SemiDay1
- The day of month for first semi-monthly payment.
- SemiDay2
- The day of month for second semi-monthly payment.
- WireInitDt
- The date a wire entry was initiated.
- WireInitTime
- The time a wire entry was initiated.
- WireSchedDayOfMonth
- The day of the month for transfer transaction. This day is only required if the transfer date is the 29th of the month.
- WireSchedDayOfWeekOccur
- The day of week occurrence. Canonical values are:
- First
- Secd
- Third
- Fourth
- Last
- WireSchedDayOfWeek
- The day of the week. Canonical values are:
- Mon
- Tues
- Wed
- Thur
- Fri
- Sat
- Sun
- WireSchedExpDt
- The expiration date of the transfer request.
- WireSchedFirstDt
- The first date to start a future transfer request.
- WireSchedFreq
- The frequency of the transfer.
- WireSchedFreqUnits
- The units of frequency for the transfer request. Canonical values
are:
- BiWeekSkipFirst
- BiWeekSkipLast
- Days
- Indefinite
- Months
- NA
- SemiMonthly
- WeekSkipFirst
- WeekSkipLast
- Years
- WireSchedNextDt
- The next scheduled transfer date.
- WireSchedStat
- Identifies the status of the future transfer schedule. Canonical
values are:
- Active
- Expired
- Suspended
WireTmpltAddRs_MType
WireTmpltAddRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- RsStat
The status of the response. Canonical values are:
- fail
- success
- WireTmpltId
- The identification key assigned to a wire template.
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_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.