Wire Payment Return Add
Wire Payment Return Addition
Wire Payment Return Addition is a jXchange service designed to allow consumers to create wire payment returns.
Message Flow
In jXchange, the Wire Payment Return Addition service uses a typical exchange
of MType messages to allow
consumers to create wire payment returns.
Primary Request
The consumer forwards the WirePmtRetAddRq_MType message to
the service provider.
The message contains the following simple elements:
- DestFinInstRtId
- IMAD
- OrignFinInstRtId
- RetCrtTimeDt
- RetRqId
The message contains the following complex elements:
Custom_CTypeMsgRqHdr_CTypeRetOrigTrnInfo_CTypeRetPmtInfo_CTypeRetRsnInfo_CTypeWireSvcPrvdInfo_CType
The message contains the following arrays:
ErrOvrRdInfoArray_ATypeWireAgentInfoArray_ATypeWireEntityInfoArray_AType
Primary Response
The service provider returns the WirePmtRetAddRs_MType
message to the consumer.
The message contains the following simple element:
- RsStat
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
Wire Payment Return Addition Behavior
The Wire Payment Return Addition (WirePmtRetAdd) service behavior is as
follows.
The Wire Payment Return Addition root request (WirePmtRetAddRq_MType)
requires IMAD (IMAD), Return Creation Time/Date
(RetCrtTimeDt), Originator Financial Institution Routing ID
(OrignFinInstRtId), Destination Financial Institution Routing ID
(DestFinInstRtId), Return Request Identifier
(RetRqId), Return Original Transaction Information complex
(RetOrigTrnInfo_CType), Return Payment Information complex
(RetPmtInfo_CType), Return Reason Information complex
(RetRsnInfo_CType), Wire Agent Information Array
(WireAgentInfoArray_AType), and Wire Entity Information Array
(WireEntityInfoArray_AType).
Wire Payment Return Addition root request
(WirePmtRetAddRq_MType) optionally includes Wire Service Provider
Information complex (WireSvcPrvdInfo_CType) and Error Override Information
Array (ErrOvrRdInfoArray_AType).
The Return Original Transaction Information complex (RetOrigTrnInfo_CType)
encapsulates Message ID (MsgId), Wire Message Name
(WireMsgName), Wire Create Time/Date
(WireCrtTimeDt), Wire Instruction Identifier
(WireInstrId), Wire Reference ID (WireRefId),
Wire Instruction Transaction ID (WireInstrTrnId), Wire UETR
(WireUETR), Wire Amount (WireAmt), Wire
Currency Type (WireCurrType), and Wire Settlement Date
(WireSttlDt).
The Return Payment Information complex (RetPmtInfo_CType) encapsulates
Intermediary Amount (IntmdAmt), Intermediary Currency Type
(IntmdCurrType), Wire Intermediary Settlement Date
(WireIntmdSttlDt), Instruction Amount
(InstrAmt), Instruction Currency Type
(InstrCurrType), Currency Exchange Rate
(CurrExchRate), Compensation Amount
(CompenAmt), Compensation Currency Type
(CompenCurrType), Wire Charge Information complex
(WireChgInfo_CType), Sender Financial Institution Routing ID
(SndrFinInstRtId), and Receiving Financial Institution Routing ID
(RecvFinInstRtId).
The Return Reason Information complex (RetRsnInfo_CType) encapsulates
Originator Name (OrignName), Originator Address complex
(OrignAddrISO_CType), Originator Institution BIC
(OrignInstBIC), Originator Institution Legal Entity ID
(OrignInstLegalEntityId), Institution Entity Information Array
(InstEntityInfoArray_AType), Person Identification Information complex
(PersonIdInfo_CType), Resident Country Type
(ResCntryType), Return Reason Code
(RetRsnCode), Remark Array (RmkArray_AType), and Local
Transfer Type (LocalTrfType).
The Wire Agent Information Array (WireAgentInfoArray_AType) represents the
agent information from the original transaction. The Wire Entity Information Array
(WireEntityInfoArray_AType) represent the entities information from the
original transaction.
The Wire Payment Return Addition root response (WirePmtRetAddRs_MType)
includes Transaction Receipt ID (TrnRcptId), Wire Correlation ID
(WireCorrelId), and Response Status
(RsStat).
Adhere to the behavior as related to addition service.
WirePmtRetAddRq_MType
WirePmtRetAddRq_MType
is a message MType element.
Contains:
Custom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CTypeRetOrigTrnInfo_CTypeRetPmtInfo_CTypeRetRsnInfo_CTypeWireAgentInfoArray_ATypeWireEntityInfoArray_ATypeWireSvcPrvdInfo_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. If applicable, leading zeros are required for a complete routing and transit number. A non-financial institution entity must use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.
- IMAD
- The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
- 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. If applicable, leading zeros are required for a complete routing and transit number. A non-financial institution entity must use a mutually agreed upon identification containing at least one non-integer character. The canonical value is JHA.
- RetCrtTimeDt
- The time and date the wire transaction was created.
- RetRqId
- An identification provided by the logging consumer product that defines the message.
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 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.
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.
RetOrigTrnInfo_CType
RetOrigTrnInfo_CType
is a complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex:
- MsgId
- An identification provided by the logging consumer product that defines the message. The JHANull and Rstr elements are optional.
- WireAmt
- The transactional amount of the wire transfer.
- WireCrtTimeDt
- The time and date the wire transaction was created.
- WireCurrType
- The alphanumeric ISO 4217 currency code.
- 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.
- WireInstrTrnId
- Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.
- WireMsgName
- Specifies the message name identifier to which the wire message refers.
- WireRefId
- The wire reference identification provided to a transaction.
- WireSttlDt
- The date the wire transaction was settled.
- WireUETR
- A universally unique identifier to provide an end-to-end reference.
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. - FinInstRtIdType
- Identifies the clearing system for financial institutions.
Canonical values are:
- ATBLZ - AustrianBankleitzahl
- AUBSB - AustralianBankStateBranchCodeBSB
- CACPA - CanadianPaymentsAssociationPaymentRoutingNumber
- CHBCC - SwissFinancialInstitutionIdentificationShort
- CHSIC - SwissFinancialInstitutionIdentificationLong
- CNAPS - CNAPSIdentifier
- DEBLZ - GermanBankleitzahl
- ESNCC - SpanishDomesticInterbankingCode
- GBDSC - UKDomesticSortCode
- GRBIC - HelenicBankIdentificationCode
- HKNCC - HongKongBankCode
- IENCC - IrishNationalClearingCode
- INFSC - IndianFinancialSystemCode
- ITNCC - ItalianDomesticIdentificationCode
- JPZGN - JapanZenginClearingCode
- NZNCC - NewZealandNationalClearingCode
- PLKNR - PolishNationalClearingCode
- PTNCC - PortugueseNationalClearingCode
- RUCBC - RussianCentralBankIdentificationCode
- SESBA - SwedenBankgiroClearingCode
- SGIBG - IBGSortCode
- THCBC - ThaiCentralBankIdentificationCode
- TWNCC - FinancialInstitutionCode
- USABA - UnitedStatesRoutingNumberFedwireNACHA
- USPID - CHIPSParticipantIdentifier
- ZANCC - SouthAfricanNationalClearingCode
- 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.
RetPmtInfo_CType
RetPmtInfo_CType is
a complex CType element.
Contains:
Custom_CTypeWireChgInfo_CType
Simple Elements
The following simple elements are contained within this complex:
- CompenAmt
- The amount of money to be moved between the instructing agent and the instructed agent in the returned instruction.
- CompenCurrType
- The alphanumeric ISO 4217 currency code.
- CurrExchRate
- The exchange rate for a specific currency.
- InstrAmt
- The transactional amount of the wire transfer.
- InstrCurrType
- The alphanumeric ISO 4217 currency code.
- IntmdAmt
- The transactional amount of the wire transfer.
- IntmdCurrType
- The alphanumeric ISO 4217 currency code.
- 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. If applicable, leading zeros are required for a complete routing and transit number. A non-financial institution entity must use a mutually agreed upon identification that contains 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. If applicable, leading zeros are required for a complete routing and transit number. A non-financial institution entity must use a mutually agreed upon identification that contains at least one non-integer character. The canonical value is JHA.
- WireIntmdSttlDt
- The date the wire transaction was settled.
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. - FinInstRtIdType
- Identifies the clearing system for financial institutions.
Canonical values are:
- ATBLZ - AustrianBankleitzahl
- AUBSB - AustralianBankStateBranchCodeBSB
- CACPA - CanadianPaymentsAssociationPaymentRoutingNumber
- CHBCC - SwissFinancialInstitutionIdentificationShort
- CHSIC - SwissFinancialInstitutionIdentificationLong
- CNAPS - CNAPSIdentifier
- DEBLZ - GermanBankleitzahl
- ESNCC - SpanishDomesticInterbankingCode
- GBDSC - UKDomesticSortCode
- GRBIC - HelenicBankIdentificationCode
- HKNCC - HongKongBankCode
- IENCC - IrishNationalClearingCode
- INFSC - IndianFinancialSystemCode
- ITNCC - ItalianDomesticIdentificationCode
- JPZGN - JapanZenginClearingCode
- NZNCC - NewZealandNationalClearingCode
- PLKNR - PolishNationalClearingCode
- PTNCC - PortugueseNationalClearingCode
- RUCBC - RussianCentralBankIdentificationCode
- SESBA - SwedenBankgiroClearingCode
- SGIBG - IBGSortCode
- THCBC - ThaiCentralBankIdentificationCode
- TWNCC - FinancialInstitutionCode
- USABA - UnitedStatesRoutingNumberFedwireNACHA
- USPID - CHIPSParticipantIdentifier
- ZANCC - SouthAfricanNationalClearingCode
- 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.
RetRsnInfo_CType
RetRsnInfo_CType is
a complex CType element.
Contains:
AddrISO_CTypeCustom_CTypeInstEntityInfoArray_ATypePersonIdInfo_CTypeRmkArrayreferencesRmk_AType
Simple Elements
The following simple elements are contained within this complex:
- 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
- OrignInstBIC
- 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).
- OrignInstLegalEntityId
- Legal Entity Identifier is a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
- OrignName
- The common name. This element is the full text line name like John Doe.
- 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.
- RetRsnCode
- The code that describes the reason an account/draft item was returned.
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.
RmkArray
Rmk_AType is an array
AType element. This is an array of application or user
remarks in free form text.
RmkArray references Rmk_AType
Contains:
RmkInfo_CType
RmkInfo_CType
RmkInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- Rmk
- Application or user remarks free-form text.
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. - FinInstRtIdType
- Identifies the clearing system for financial institutions.
Canonical values are:
- ATBLZ - AustrianBankleitzahl
- AUBSB - AustralianBankStateBranchCodeBSB
- CACPA - CanadianPaymentsAssociationPaymentRoutingNumber
- CHBCC - SwissFinancialInstitutionIdentificationShort
- CHSIC - SwissFinancialInstitutionIdentificationLong
- CNAPS - CNAPSIdentifier
- DEBLZ - GermanBankleitzahl
- ESNCC - SpanishDomesticInterbankingCode
- GBDSC - UKDomesticSortCode
- GRBIC - HelenicBankIdentificationCode
- HKNCC - HongKongBankCode
- IENCC - IrishNationalClearingCode
- INFSC - IndianFinancialSystemCode
- ITNCC - ItalianDomesticIdentificationCode
- JPZGN - JapanZenginClearingCode
- NZNCC - NewZealandNationalClearingCode
- PLKNR - PolishNationalClearingCode
- PTNCC - PortugueseNationalClearingCode
- RUCBC - RussianCentralBankIdentificationCode
- SESBA - SwedenBankgiroClearingCode
- SGIBG - IBGSortCode
- THCBC - ThaiCentralBankIdentificationCode
- TWNCC - FinancialInstitutionCode
- USABA - UnitedStatesRoutingNumberFedwireNACHA
- USPID - CHIPSParticipantIdentifier
- ZANCC - SouthAfricanNationalClearingCode
- 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. 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.
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. - TmpltAlwIntnetCashUsr
- Answers the question: Is the template allowed to be used by the
internet cash user? Canonical values are:
- true
- false
- 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
- WireSrcDestCode
- The code that describes the source and/or destination of a wire for delivery of the wire.
- WireSrcDestDesc
- The description of the code that describes the source and/or destination of a wire for delivery of the wire
- WireStat
- Identifies the status of the wire transaction.
- WireTmpltCode
- The code that represent the type of wire template.
- 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
- TempltOnly
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
WirePmtRetAddRs_MType
WirePmtRetAddRs_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.
- WireCorrelId
- The client assigned correlation identification for wire activities.
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 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.
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.