Wire Transaction ISO Addition
Wire Transaction ISO Addition
Wire Transaction ISO Addition is a jXchange service designed to add.wire transactions.
Message Flow
In jXchange, the Wire Transaction ISO Addition service uses a typical exchange of
MType messages to add.wire
transactions.
Primary Request
The consumer forwards the WireTrnISOAddRq_MType message to the
service provider.
The message contains the following simple elements:
- DestFinInstRtId
- OrignFinInstRtId
- RecvFinInstRtId
- SndrFinInstRtId
- WireCrtTimeDt
- WirePurpCode
- WirePurpInfo
The message contains the following complex elements:
Custom_CTypeMsgRqHdr_CTypeWireChgInfo_CTypeWirePmtTypeInfo_CTypeWireRemitInfo_CTypeWireSvcPrvdInfo_CType
The message contains the following arrays:
ErrOvrRdInfoArray_ATypeWireAgentInfoArray_ATypeWireEntityInfoArray_AType
Primary Response
The service provider returns the WireTrnISOAddRs_MType message to
the consumer.
The message contains the following simple elements:
- RsStat
- TrnRcptId
- WireTmpltId
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
WireTrnISOAddRq_MType
WireTrnISOAddRq_MType is a message
MType element.
Contains:
Custom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CTypeWireAgentInfoArray_ATypeWireChgInfo_CTypeWireEntityInfoArray_ATypeWirePmtTypeInfo_CTypeWireRemitInfo_CTypeWireSvcPrvdInfo_CType
Simple Elements
The following simple elements are contained within this message.
- DestFinInstRtId
- 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.
- OrignFinInstRtId
- 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.
- RecvFinInstRtId
- 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.
- SndrFinInstRtId
- 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.
- WireCrtTimeDt
- The time and date the wire transaction was created.
- WirePurpCode
- The purpose code as related to a wire.
- WirePurpInfo
- A free-form information for the wire purpose.
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.
WireAgentInfoArray_AType
WireAgentInfoArray_AType is an array
AType element. This element is an array of agents as related to a wire
transaction.
Contains:
WireAgentRec_CType
WireAgentRec_CType
WireAgentRec_CType
is a complex CType element.
Contains:
Custom_CTypeWireFinInstAcctInfo_CTypeWireFinInstInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- WireAgentSeq
- The sequence number that further defines the agent as related to a wire.
- WireAgentType
- Identifies the different agents as related to a wire transaction. Canonical
values are:
- CrAgent
- DrAgent
- IntmdAgent
- PrevInstrAgent
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireFinInstAcctInfo_CType
WireFinInstAcctInfo_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- AcctIdCatDesc
- A free-form account identifier category.
- AcctIdCat
- The category as related to an account identifier. Canonical values are:
- BankNumId
- CHIPSId
- IssuerNumId
- UnvIdCode
- AcctIdIssuer
- A free-form description of the account ID issuer.
- AcctId
- The number or character that identifies an account record.
- AcctName
- The common name. The full text line name, for example, John Doe.
- AcctTypeDesc
- A description of the account type. It includes the
Rstrattribute. - AcctType
- The number or character that categorizes the AcctId.
- CurrType
- The alphanumeric ISO 4217 currency code.
- IBAN
- The number or character that identifies an account record.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireFinInstInfo_CType
WireFinInstInfo_CType is a complex
CType element.
Contains:
AddrISO_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- BrCode
- The branch code.
- FinInstName
- The depository financial institution name. The
SrchTypeattribute is optional. - InstBIC
- The code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - Banking - Banking Telecommunication Messages - Business Identifier Code (BIC).
- InstLegalEntityId
- Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
- InstRtId
- The identification of the entity of submitted message. A financial institution entity uses the routing transit or ABA nine-digit number assigned to financial institutions for the purpose of 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 uses a mutually agreed upon identification that must contain at least one non-integer character. When a record is directed to a specific financial institution within a holding company, the institution routing identification is the specific financial institution routing identification and not the holding company identification.
AddrISO_CType
AddrISO_CType is a complex CType element.
Contains:
Custom_CTypeFreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BldgFloor
- The floor or store within a building.
- BldgId
- The number or ID that identifies the position of a building on a street.
- BldgName
- The name of the building or house.
- BldgRmId
- The building room number or ID.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- Dept
- The department code is provided for bank use in assigning department responsibility for the loan.
- PostalCode
- The postal code or ZIP code.
- PostOffBoxId
- Number or ID of a box in a post office, assigned to a person or organization, where letters are kept until called for.
- StateProv
- The state or province or region.
- Street1
- The street address.
- SubDept
- The department code is provided for bank use in assigning department responsibility for the loan.
- SubDivName
- The name of the subdivision where the property is located.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireChgInfo_CType
WireChgInfo_CType is a complex CType element.
Contains:
Custom_CTypeWireChgArray_AType
Simple Elements
The following simple elements are contained within this complex.
- DetOfChgType
- Used by the SENDER DI to instruct the Receiver DI to deduct charges
and expenses from the payment amount. Canonical values are:
- Benf
- Shared
- Orign
- SvcLvl
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireChgArray_AType
WireChgArray_AType is an array AType element. This element is an
array of sender charges for wire tag {3700}.
Contains:
WireChgRec_CType
WireChgRec_CType
WireChgRec_CType is a complex CType element.
Contains:
Custom_CTypeWireFinInstInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- WireChgId
- An identifier provided for the wire charge array.
- ChgAmt
- Transaction charges to be paid by the charge bearer. Fedwire Funds Tag {3700}.
- ChgCurrType
- The alphanumeric ISO 4217 currency code.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireFinInstInfo_CType
WireFinInstInfo_CType is a complex
CType element.
Contains:
AddrISO_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- BrCode
- The branch code.
- FinInstName
- The depository financial institution name. The
SrchTypeattribute is optional. - InstBIC
- The code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - Banking - Banking Telecommunication Messages - Business Identifier Code (BIC).
- InstLegalEntityId
- Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
- InstRtId
- The identification of the entity of submitted message. A financial institution entity uses the routing transit or ABA nine-digit number assigned to financial institutions for the purpose of 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 uses a mutually agreed upon identification that must contain at least one non-integer character. When a record is directed to a specific financial institution within a holding company, the institution routing identification is the specific financial institution routing identification and not the holding company identification.
AddrISO_CType
AddrISO_CType is a complex CType element.
Contains:
Custom_CTypeFreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BldgFloor
- The floor or store within a building.
- BldgId
- The number or ID that identifies the position of a building on a street.
- BldgName
- The name of the building or house.
- BldgRmId
- The building room number or ID.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- Dept
- The department code is provided for bank use in assigning department responsibility for the loan.
- PostalCode
- The postal code or ZIP code.
- PostOffBoxId
- Number or ID of a box in a post office, assigned to a person or organization, where letters are kept until called for.
- StateProv
- The state or province or region.
- Street1
- The street address.
- SubDept
- The department code is provided for bank use in assigning department responsibility for the loan.
- SubDivName
- The name of the subdivision where the property is located.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireEntityInfoArray_AType
WireEntityInfoArray_AType is an array AType element. This element is an
array of entities as related to a wire transaction.
Contains:
WireEntityRec_CType
WireEntityRec_CType
WireEntityRec_CType is a complex CType element.
Contains:
AddrISO_CTypeCustom_CTypeInstEntityInfoArray_ATypePersonIdInfo_CTypeWireFinInstAcctInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- EntityName
- The common name. This is the full text line name like John Doe.
- InstBIC
- The code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - Banking - Banking Telecommunication Messages - Business Identifier Code (BIC).
- InstLegalEntityId
- Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
- ResCntryType
- Predefined by the IRS and setup in the banks parameter file when the Alien customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable.
- WireEntityType
- Identifies the different entities as related to a wire transaction.
Canonical values are:
- CrEntity
- CrInit
- DrEntity
- DrInit
- UltmtCrEntity
- UltmtDrEntity
AddrISO_CType
AddrISO_CType is a complex CType element.
Contains:
Custom_CTypeFreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BldgFloor
- The floor or store within a building.
- BldgId
- The number or ID that identifies the position of a building on a street.
- BldgName
- The name of the building or house.
- BldgRmId
- The building room number or ID.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- Dept
- The department code is provided for bank use in assigning department responsibility for the loan.
- PostalCode
- The postal code or ZIP code.
- PostOffBoxId
- Number or ID of a box in a post office, assigned to a person or organization, where letters are kept until called for.
- StateProv
- The state or province or region.
- Street1
- The street address.
- SubDept
- The department code is provided for bank use in assigning department responsibility for the loan.
- SubDivName
- The name of the subdivision where the property is located.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InstEntityInfoArray_AType
InstEntityInfoArray_AType is a complex AType element. This element is an
array of institution entity information as related to a wire transaction.
Contains:
InstEntityRec_CType
InstEntityRec_CType
InstEntityRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- InstEntityDesc
- A free-form description as the type of entity.
- InstEntityId
- The identification given to an entity.
- InstEntityIssr
- A free-form description of the issuer of the identification.
- InstEntitySeqId
- The identification given to an entity.
- InstEntityType
Identifies the different types of entities. A hybrid enumerated element with a preset list of values. Canonical values are:
- BankId
- BusDomId
- CentralBankId
- CertifCorpId
- ClearingId
- CntryId
- CustId
- DataUnivId
- EmplId
- GlobLocId
- OthBusId
- SREN
- SRET
- TaxId
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PersonIdInfo_CType
PersonIdInfo_CType is a complex CType element.
Contains:
Custom_CTypeIdArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BirthCity
- The city name.
- BirthCntryType
- The country abbreviation from ISO 3166.
- BirthDt
- The date of birth.
- BirthStateProv
- The state, province, or region.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
IdArray_AType
IdArray_AType is an
array AType element. This element is an array of identifications specific to a
person.
Contains:
IdRec_CType
IdRec_CType
IdRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- IdDesc
- Free-form identification description.
- IdIssuer
- The named issuer of identification.
- IdSeqId
- The sequence identifier given to an identifier used for identify a person.
- IdType
- Identifications as related to ISO formats. This element is
hybrid-enumerated with a preset list of values. Canonical values are:
- DriverLic
- Passport
- ResidentAlienId
- EmplId
- NatIdNum
- TaxId
- SSN
- CustId
- IdVal
- The identification value.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireFinInstAcctInfo_CType
WireFinInstAcctInfo_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- AcctIdCatDesc
- A free-form account identifier category.
- AcctIdCat
- The category as related to an account identifier. Canonical values are:
- BankNumId
- CHIPSId
- IssuerNumId
- UnvIdCode
- AcctIdIssuer
- A free-form description of the account ID issuer.
- AcctId
- The number or character that identifies an account record.
- AcctName
- The common name. The full text line name, for example, John Doe.
- AcctTypeDesc
- A description of the account type. It includes the
Rstrattribute. - AcctType
- The number or character that categorizes the AcctId.
- CurrType
- The alphanumeric ISO 4217 currency code.
- IBAN
- The number or character that identifies an account record.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WirePmtTypeInfo_CType
WirePmtTypeInfo_CType is a complex
CType element.
Contains:
CrAgentInstrInfoArrayreferencesInstrInfoArray_ATypeCustom_CTypeSvcLvlInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- CatPurpDesc
- Specifies the high-level purpose of the instruction in a free-form string.
- CatPurpType
- Specifies the high-level purpose of the instruction based on a set of predefined categories as published by ISO20022. It is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.
- CurrExchRate
- The exchange rate for a specific currency.
- CurrType
- The alphanumeric ISO 4217 currency code.
- HighPryType
- Indicator of the urgency or order of importance of the wire.
Canonical values are:
- true
- false
- InstrAmt
- The transactional amount of the wire transfer.
- InstrId
- The instruction identification is a point-to-point reference that can be used between the instructing party and the instructed party to refer to the individual instruction.
- InstrTrnId
- Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.
- LocalTrfType
- Specifies a local instrument, local clearing option, or further
qualifies the service or service level. Canonical values are:
- AcctCoverPmt
- AcctCustTrf
- AcctFinInstTrf
- CustCoverPmt
- CustDrawdwn
- CustDrawdwnRq
- CustTrf
- FinInstDrawdwn
- FinInstDrawdwnRq
- FinInstTrf
- WireAmt
- The transactional amount of the wire transfer.
- WireRefId
- The wire reference identification provided to a transaction.
- WireUETR
- A universally unique identifier to provide an end-to-end reference.
CrAgentInstrInfoArray
InstrInfoArray_AType is an array
AType element.
Contains:
InstrRec_CType
InstrRec_CType
InstrRec_CType is a
complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- WireInstrCode
- The code that relates to the processing of the payment. Canonical
values are:
- ChkPmt
- HoldPmt
- PhoneBenf
- Telecom
- WireInstrId
- The instruction identification is a point-to-point reference that can be used between the instructing party and the instructed party to refer to the individual instruction.
- WireInstrInfo
- A free-form description that conveys the payment instructions.
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.
SvcLvlInfoArray_AType
SvcLvlInfoArray_AType is an array
AType element. This element is an array of service levels.
Contains:
SvcLvlRec_CType
SvcLvlRec_CType
SvcLvlRec_CType is a
complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- SvcLvlDesc
- Specifies a pre-agreed service or level of service between the parties.
- SvcLvlId
- The identifier given to the service level as a key for the array.
- SvcLvlType
- Specifies the service level of the transaction as published by ISO20022.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireRemitInfo_CType
WireRemitInfo_CType is a complex CType element.
Contains:
Custom_CTypeRemitDlvryArray_ATypeRemitStructureArray_AType
Simple Elements
The following simple elements are contained within this complex.
- FreeFormRemitInfo
- Free-form information related to remittance information.
- RemitId
- The identification of a payment.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
RemitDlvryArray_AType
RemitDlvryArray_AType is a complex AType element. This element is an
array of remittance delivery methods.
Contains:
RemitDlvryRec_CType
RemitDlvryRec_CType
RemitDlvryRec_CType
is a complex CType element.
Contains:
AddrISO_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- RecipName
- The common name. This element is the full text line name like John Doe.
- RemitDlvryId
- The identifier given to the remit delivery as a key for the array.
- RemitDlvryMthd
- The method used for delivery of remittance information. Canonical values are:
- Addr
- EDIC
- Fax
- SMS
- URL
AddrISO_CType
AddrISO_CType is a complex CType element.
Contains:
Custom_CTypeFreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BldgFloor
- The floor or store within a building.
- BldgId
- The number or ID that identifies the position of a building on a street.
- BldgName
- The name of the building or house.
- BldgRmId
- The building room number or ID.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- Dept
- The department code is provided for bank use in assigning department responsibility for the loan.
- PostalCode
- The postal code or ZIP code.
- PostOffBoxId
- Number or ID of a box in a post office, assigned to a person or organization, where letters are kept until called for.
- StateProv
- The state or province or region.
- Street1
- The street address.
- SubDept
- The department code is provided for bank use in assigning department responsibility for the loan.
- SubDivName
- The name of the subdivision where the property is located.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
RemitStructureArray_AType
RemitStructureArray_AType is an array AType element.
Contains:
RemitStructureRec_CType
RemitStructureRec_CType
RemitStructureRec_CType is a complex CType element.
Contains:
CrRefRec_CTypeCustom_CTypeDocAmtRec_CTypeInvInfoArray_ATypeRemitDocArray_ATypeRmk_ATypeTaxRefRec_CType
Simple Elements
The following simple element is contained within this complex.
- RemitStructureId
- The identifier given to the remittance structure as a key for the array.
CrRefRec_CType
CrRefRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- CrRefDesc
- Credit reference type in free-form description.
- CrRefId
- An identifier given to a credit reference.
- CrRefIssr
- The issuer of the credit reference.
- CrRefType
- The type of credit reference.
- DispatchAdvice
- FornExchRef
- PurchOrder
- RelPmtInstr
- RemitAdviceMsg
- StructureCommRef
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.
DocAmtRec_CType
DocAmtRec_CType is a complex CType element.
Contains:
AdjAmtArray_ATypeCustom_CTypeDsctAmtArray_ATypeTaxAmtArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AdjCurrType
- The alphanumeric ISO 4217 currency code.
- CrNoteAmt
- Credit note amount.
- CrNoteCurrType
- The alphanumeric ISO 4217 currency code.
- DocAmtId
- The identifier as related to the remittance document details record.
- PayableDueAmt
- A general amount due.
- RemitAmt
- The amount remitted.
- RemitCurrType
- The alphanumeric ISO 4217 currency code.
AdjAmtArray_AType
AdjAmtArray_AType is an array AType element. This element is an
array of amounts related to adjustments.
Contains:
AdjAmtRec_CType
AdjAmtRec_CType
AdjAmtRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- AdjCurrType
- The alphanumeric ISO 4217 currency code.
- AdjAmtId
- An identifier provided for the adjusted amount array.
- AdjAmt
- The adjustment amount.
- AdjRsnDesc
- The reason for the adjustment amount.
- AdjRsnRmk
- Application or user remarks free-form text.
- DrCr
- Either debit or credit. Canonical values are:
- Dr
- Cr
This element is a hybrid enumeration.
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.
DsctAmtArray_AType
DsctAmtArray_AType
is an array AType element. This element is an array of discounted amounts for a
remittance.
Contains:
DsctAmtRec_CType
DsctAmtRec_CType
DsctAmtRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- DsctAmt
- The discount amount.
- DsctAmtDesc
- Discount amount type in free-form description.
- DsctAmtId
- An identifer provided for the discount wire array.
- DsctAmtType
- Discount amount type.
- Promotional
- Standing
- Terms
- DsctCurrType
- The alphanumeric ISO 4217 currency code.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TaxAmtArray_AType
TaxAmtArray_AType is an array AType element.
Contains:
TaxAmtRec_CType
TaxAmtRec_CType
TaxAmtRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained in this complex.
- TaxAmt
- The tax amount.
- TaxCurrType
- The alphanumeric ISO 4217 currency code.
- TaxAmtDesc
- Tax amount type in free-form description.
- TaxAmtId
- An identifer provided for the tax amount array.
- TaxAmtType
- Tax amount type.
- City
- Cnty
- Local
- Prov
- State
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
InvInfoArray_AType
InvInfoArray_AType
is an array AType element. This element is an array of invoice entities as
related to a wire transaction.
Contains:
InvRec_CType
InvRec_CType
InvRec_CType is a complex CType element.
Contains:
AddrISO_CTypeContactInfo_CTypeCustom_CTypeInstEntityInfoArray_ATypePersonIdInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- EntityName
- The common name. This is the full text line name like John Doe.
- InstBIC
- The code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362: 2014 - Banking - Banking Telecommunication Messages - Business Identifier Code (BIC).
- InstLegalEntityId
- Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
- InvEntityType
- The type of entity related to an invoice. Canonical values are:
- Invcee
- Invr
- ResCntryType
- Predefined by the IRS and setup in the banks parameter file when the Alien customer is flagged as Y and the TAX ID type code is set up in the bank parameters as Alien reportable.
AddrISO_CType
AddrISO_CType is a complex CType element.
Contains:
Custom_CTypeFreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BldgFloor
- The floor or store within a building.
- BldgId
- The number or ID that identifies the position of a building on a street.
- BldgName
- The name of the building or house.
- BldgRmId
- The building room number or ID.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- Dept
- The department code is provided for bank use in assigning department responsibility for the loan.
- PostalCode
- The postal code or ZIP code.
- PostOffBoxId
- Number or ID of a box in a post office, assigned to a person or organization, where letters are kept until called for.
- StateProv
- The state or province or region.
- Street1
- The street address.
- SubDept
- The department code is provided for bank use in assigning department responsibility for the loan.
- SubDivName
- The name of the subdivision where the property is located.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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.
ContactInfo_CType
ContactInfo_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- EmailAddr
- Email address.
- FaxNum
- The phone number. The format must be CXXXYYZZZZ where C is the country code, XXX is the area code, and YYYZZZZ is the seven-digit fax number.
- MobNum
- The phone number.
- Name
- The common name. This element is the full text line name like John Doe.
- PhoneNum
- The phone number.
- TitlePrefix
- The title prefix. Examples: Mr. or Mrs.
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.
InstEntityInfoArray_AType
InstEntityInfoArray_AType is a complex AType element. This element is an
array of institution entity information as related to a wire transaction.
Contains:
InstEntityRec_CType
InstEntityRec_CType
InstEntityRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- InstEntityDesc
- A free-form description as the type of entity.
- InstEntityId
- The identification given to an entity.
- InstEntityIssr
- A free-form description of the issuer of the identification.
- InstEntitySeqId
- The identification given to an entity.
- InstEntityType
Identifies the different types of entities. A hybrid enumerated element with a preset list of values. Canonical values are:
- BankId
- BusDomId
- CentralBankId
- CertifCorpId
- ClearingId
- CntryId
- CustId
- DataUnivId
- EmplId
- GlobLocId
- OthBusId
- SREN
- SRET
- TaxId
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
PersonIdInfo_CType
PersonIdInfo_CType is a complex CType element.
Contains:
Custom_CTypeIdArray_AType
Simple Elements
The following simple elements are contained within this complex.
- BirthCity
- The city name.
- BirthCntryType
- The country abbreviation from ISO 3166.
- BirthDt
- The date of birth.
- BirthStateProv
- The state, province, or region.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
IdArray_AType
IdArray_AType is an
array AType element. This element is an array of identifications specific to a
person.
Contains:
IdRec_CType
IdRec_CType
IdRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- IdDesc
- Free-form identification description.
- IdIssuer
- The named issuer of identification.
- IdSeqId
- The sequence identifier given to an identifier used for identify a person.
- IdType
- Identifications as related to ISO formats. This element is
hybrid-enumerated with a preset list of values. Canonical values are:
- DriverLic
- Passport
- ResidentAlienId
- EmplId
- NatIdNum
- TaxId
- SSN
- CustId
- IdVal
- The identification value.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
RemitDocArray_AType
RemitDocArray_AType
is an array AType element.
Contains:
RemitDocRec_CType
RemitDocRec_CType
RemitDocRec_CType is a complex CType element.
Contains:
Custom_CTypeRemitDocDetailsArray_AType
Simple Elements
The following simple elements are contained within this complex.
- RemitDocDesc
- The free-form description of the remittance document.
- RemitDocDt
- The document date.
- RemitDocId
- The ID of a payment.
- RemitDocIssr
- The Issuer of the remittance document.
- RemitDocRecId
- The identifier as related to the remittance document record.
- RemitDocType
- The type of remittance document as defined by ISO 20022 enumeration.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
RemitDocDetailsArray_AType
RemitDocDetailsArray_AType is an array
AType element. This element is an array of line details as related to a
remittance document.
Contains:
RemitDocDetailsRec_CType
RemitDocDetailsRec_CType
RemitDocDetailsRec_CType is a complex CType element.
Contains:
Custom_CTypeDocAmtRec_CType
Simple Elements
The following simple elements are contained within this complex.
- DocLineDesc
- The free-form description of a line of a remittance document.
- DocLineType
- The type of line of a remittance document as defined by ISO External document line type code.
- RemitDocDt
- The document date.
- RemitDocId
- The ID of a payment.
- RemitDocIssr
- The Issuer of the remittance document.
- RemitLineDesc
- A free-form description of the remittance line details.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
DocAmtRec_CType
DocAmtRec_CType is a complex CType element.
Contains:
AdjAmtArray_ATypeCustom_CTypeDsctAmtArray_ATypeTaxAmtArray_AType
Simple Elements
The following simple elements are contained within this complex.
- AdjCurrType
- The alphanumeric ISO 4217 currency code.
- CrNoteAmt
- Credit note amount.
- CrNoteCurrType
- The alphanumeric ISO 4217 currency code.
- DocAmtId
- The identifier as related to the remittance document details record.
- PayableDueAmt
- A general amount due.
- RemitAmt
- The amount remitted.
- RemitCurrType
- The alphanumeric ISO 4217 currency code.
AdjAmtArray_AType
AdjAmtArray_AType is an array AType element. This element is an
array of amounts related to adjustments.
Contains:
AdjAmtRec_CType
AdjAmtRec_CType
AdjAmtRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- AdjCurrType
- The alphanumeric ISO 4217 currency code.
- AdjAmtId
- An identifier provided for the adjusted amount array.
- AdjAmt
- The adjustment amount.
- AdjRsnDesc
- The reason for the adjustment amount.
- AdjRsnRmk
- Application or user remarks free-form text.
- DrCr
- Either debit or credit. Canonical values are:
- Dr
- Cr
This element is a hybrid enumeration.
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.
DsctAmtArray_AType
DsctAmtArray_AType
is an array AType element. This element is an array of discounted amounts for a
remittance.
Contains:
DsctAmtRec_CType
DsctAmtRec_CType
DsctAmtRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- DsctAmt
- The discount amount.
- DsctAmtDesc
- Discount amount type in free-form description.
- DsctAmtId
- An identifer provided for the discount wire array.
- DsctAmtType
- Discount amount type.
- Promotional
- Standing
- Terms
- DsctCurrType
- The alphanumeric ISO 4217 currency code.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TaxAmtArray_AType
TaxAmtArray_AType is an array AType element.
Contains:
TaxAmtRec_CType
TaxAmtRec_CType
TaxAmtRec_CType is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained in this complex.
- TaxAmt
- The tax amount.
- TaxCurrType
- The alphanumeric ISO 4217 currency code.
- TaxAmtDesc
- Tax amount type in free-form description.
- TaxAmtId
- An identifer provided for the tax amount array.
- TaxAmtType
- Tax amount type.
- City
- Cnty
- Local
- Prov
- State
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
RemitRmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
RemitRmkArray 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.
TaxRefRec_CType
TaxRefRec_CType is a complex CType element.
Contains:
Custom_CTypeTaxEntityArray_ATypeTaxRecArray_AType
Simple Elements
The following simple elements are contained within this complex.
- TaxAmt
- The tax amount.
- TaxAmtCurrType
- The alphanumeric ISO 4217 currency code.
- TaxBaseAmt
- The base amount being used for the tax amount.
- TaxBaseCurrType
- The alphanumeric ISO 4217 currency code.
- TaxPmtDueDt
- The date established for a scheduled payment
- TaxPmtMthd
- The method being used for the tax payment.
- TaxRecipZone
- The administration-authorized zone for the tax payment.
- TaxRefId
- An identifier given to a tax payment as issued by the taxing agency.
- TaxRptSeqId
- The sequence identifier given to the tax reporting.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TaxEntityArray_AType
TaxEntityArray_AType
is an array AType element. This element is an array of entities as related to
taxes.
Contains:
TaxEntityRec_CType
TaxEntityRec_CType
TaxEntityRec_CType
is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- RegstId
- A registration identifier given to an organization.
- TaxEntityId
- The identifier as related to the tax entity.
- TaxEntityType
- Identifies the different entities as related to a tax
information.
- CrEntity
- DrEntity
- UltmtDrEntity
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - TaxPayerAuthName
- The common name. This element is the full text line name like John Doe.
- TaxPayerAuthTitle
- A title given to an authorized tax payer.
- TaxPayerDesc
- A free-form description of the type of tax payer.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TaxRecArray_AType
TaxRecArray_AType is
an array AType element. This element is an array of tax recording
information.
Contains:
TaxRecInfo_CType
TaxRecInfo_CType
TaxRecInfo_CType is
a complex CType element.
Contains:
Custom_CTypeTaxPeriodArray_ATypeTaxPeriodRec_CType
Simple Elements
The following simple elements are contained within this complex.
- TaxAmt
- The tax amount.
- TaxAmtCurrType
- The alphanumeric ISO 4217 currency code.
- TaxBaseAmt
- The base amount being used for the tax amount.
- TaxBaseCurrType
- The alphanumeric ISO 4217 currency code.
- TaxDrStat
- The status of the tax debtor.
- TaxRate
- Elements dealing with rates (percentages).
- TaxRecCatDesc
- The description of the category of tax recording.
- TaxRecCat
- The category of tax recording.
- TaxRecCertifId
- The identification assigned to a deposit instrument.
- TaxRecId
- An idneitifer given for the type of tax recording.
- TaxRecRmk
- Application or user remarks free-form text.
- TaxRecType
- The type of tax recording.
- TaxTmpltId
- An identifier assigned to a template for a document.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TaxPeriodArray_AType
TaxPeriodArray_AType
is an array AType element. This element is an array of tax recording
periods.
Contains:
TaxPeriodRec_CType
TaxPeriodRec_CType
TaxPeriodRec_CType
is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- TaxAmt
- The tax amount.
- TaxAmtCurrType
- The alphanumeric ISO 4217 currency code.
- TaxEndDt
- The date that designates the ending point for date selections.
- TaxPeriodRecId
- An identifier given to the tax period.
- TaxPmtPeriod
- The specific period of time for the tax recording. Canonical values
are:
- Half01
- Half02
- Month01
- Month02
- Month03
- Month04
- Month05
- Month06
- Month07
- Month08
- Month09
- Month10
- Month11
- Month12
- Qtr01
- Qtr02
- Qtr03
- Qtr04
- TaxRecYr
- The year of the tax recording.
- TaxStartDt
- The date that designates the starting point for date selections.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
TaxPeriodRec_CType
TaxPeriodRec_CType
is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- TaxAmt
- The tax amount.
- TaxAmtCurrType
- The alphanumeric ISO 4217 currency code.
- TaxEndDt
- The date that designates the ending point for date selections.
- TaxPeriodRecId
- An identifier given to the tax period.
- TaxPmtPeriod
- The specific period of time for the tax recording. Canonical values
are:
- Half01
- Half02
- Month01
- Month02
- Month03
- Month04
- Month05
- Month06
- Month07
- Month08
- Month09
- Month10
- Month11
- Month12
- Qtr01
- Qtr02
- Qtr03
- Qtr04
- TaxRecYr
- The year of the tax recording.
- TaxStartDt
- The date that designates the starting point for date selections.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
WireSvcPrvdInfo_CType
WireSvcPrvdInfo_CType is a complex CType element.
Contains:
Custom_CTypeWireSchedRecArray_CType
Simple Elements
The following simple elements are contained within this complex.
- AvlBalCalcCode
- A code that conveys to the service provider the method to use for the calculation of the available balance.
- BrCode
- The branch code.
- FornWireType
- The element identifying if a wire is foreign or domestic. Canonical
values are:
- false
- true
- blank
- FraudRefId
- A unique identification provided by the fraud risk application when a request for review is submitted.
- 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.
- InPersonWireType
- The element identifying if wire was initiated in person. Canonical
values are:
- true
- false
- IntnetFinInstId
- The identification assigned to a consumer for the financial institution internet product.
- OffCode
- The code that designates the financial institution officer.
- RemitSubjRuleType
- Is the wire subject to the remittance rule? Canonical values are:
- true
- false
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes. - WireAcctId
- The account identification related to wires.
- WireAcctType
- The number or character that categorizes the AcctId.
- WireAnlysCode
- The code that identifies the behavior for Account Analysis activity for the transaction.
- WireCompEmplId
- The identification given to a company's employee.
- WireCompEmplName
- The employer name.
- WireCompId
- The company identification for wire created transactions.
- WireCompVerifId
- The verification identification associated with a wire user identification for wire business activity permission.
- WireCompVerifName
- The employer name.
- WireCorrelId
- The client assigned correlation identification for wire activities.
- WireFeeAmt
- The fee amount associated with a transaction.
- WireNotType
Identifies the behavior for wire notification for a transaction. Canonical values are:
- Fax
- None
- Prt
- EmailFax
- EmailPrt
- WireSrc
- Identifies the source entry of the wire transaction. Canonical
values are:
- DirectLine
- FIClerk
- Intnet
- WireStat
- Identifies the status of the wire transaction.
- WireTempltRef
- An application's transactional reference that provides guidance as to the source.
- WireTmpltCrt
Answers the question: Should a wire template be created for the wire transaction? Canonical values are:
- false
- true
The default value is False.
- WireTmpltDesc
- The readable description assigned to a wire template.
- WireTrnType
- Identifies the wire transactional activity. Canonical values
are:
- Both
- Incoming
- Outgoing
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
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 the 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
- WireSchedId
- An identifier provided for the reoccurring schedule.
- WireSchedNextDt
- The next scheduled transfer date.
- WireSchedStat
- Identifies the status of the future transfer schedule. Canonical
values are:
- Active
- Expired
- Suspended
WireTrnISOAddRs_MType
WireTrnISOAddRs_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
- TrnRcptId
- The receipt provided for a successful transaction entry.
- 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.