Developer Programs

Learn

Docs

Wire Drawdown Transaction Reply Inquiry

Enterprise SOAP API > API by Reference > Core Services > Wire Drawdown Transaction Reply Inquiry

Wire Drawdown Transaction Reply Inquiry

Wire Drawdown Transaction Reply Inquiry is a jXchange service.

Message Flow

In jXchange, the Wire Drawdown Transaction Reply Inquiry service uses a typical exchange of MType messages.

Primary Request

The consumer forwards the WireDrwdwnTrnReplyInqRq_MType message to the service provider.

The message contains the following simple elements:

  • ActIntent
  • TrnRcptId
  • WireCorrelId

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType
  • WireDrwdwnTrnReplyInqInfo_CType

Primary Response

The service provider returns the SERVICERs_MType message to the consumer.

The message contains the following simple elements:

  • ActIntent
  • ActIntentKey
  • WireProcState
  • WireStat
  • WireUsrId
  • WireVerifId

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType
  • WireDrwdwnTrnReplyInqInfo_CType

WireDrwdwnTrnReplyInqRq_MType

WireDrwdwnTrnReplyInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • WireDrwdwnTrnReplyInqInfo_CType

Simple Elements

The following simple elements are contained within this message:

ActIntent

Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:

  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

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.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType

Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

WireDrwdwnTrnReplyInqRs_MType

WireDrwdwnTrnReplyInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • WireDrwdwnTrnReplyInqInfo_CType

Simple Elements

The following simple elements are contained within this message:

ActIntent

Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:

  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

ActIntentKey
The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
WireProcState
Identifies the state of the process for a wire. Canonical values are:
  • Cmplt
  • Pend
WireStat
Identifies the status of the wire transaction.
WireUsrId
The applications' user identification for the transactional activity.
WireVerifId
The verification identification associated with a wire user identification for wire business activity permission.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId

The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.

WireDrwdwnTrnReplyInqInfo_CType

WireDrwdwnTrnReplyInqInfo_CType is a complex CType element.

Contains:

  • Custom_CType
  • OrigDrwdwnInfoRec_CType
  • WireDrwdwnEntityInfoArray_AType
  • WireEntityRec_CType
  • WireSvcPrvdInfo_CType

Simple Elements

The following simple elements are contained within this complex:

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.
MsgId
An identification provided by the logging consumer product that defines the message. The JHANull and Rstr elements are optional.
OMAD
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.
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.
TrnRcptId
The receipt provided for a successful transaction entry.
WireCorrelId
The client assigned correlation identification for wire activities.
WireCrtTimeDt
The time and date the wire transaction was created.
WireDrwdwnCrFinInstAcctId
The draw down credit financial institution account identification.
WireDrwdwnStat
The status of a wire transaction. Canonical values are:
  • Pend
  • Fail
  • Success

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

OrigDrwdwnInfoRec_CType

OrigDrwdwnInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

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.
WireCrtTimeDt
The time and date the wire transaction was created.
WireMsgId
An identification provided by the logging consumer product that defines the message.
WirePmtId
The identification of a payment.
WireRefId
The wire reference identification provided to a transaction.
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.

WireDrwdwnEntityInfoArray_AType

WireDrwdwnEntityInfoArray_AType is an array AType element. This element is an array of wire exception transactions.

Contains:

  • WireDrwdwnEntityInfoRec_CType
WireDrwdwnEntityInfoRec_CType

WireDrwdwnEntityInfoRec_CType is a complex CType element.

Contains:

  • WireEntityRec_CType
  • WireDrwdwnStatSecRmk references Rmk_AType
Simple Elements

The following simple elements are contained within this complex.

WireDrwdwnSeqId
The identifier given to the drawdown structure as a key for the array.
WireDrwdwnStatCode
The code that defines status given to a drawdown request.
WireDrwdwnStatDesc
The description of the code that defines status given to a drawdown request.
WireDrwdwnStatRmk
Application or user remarks free-form text.
WireDrwdwnStatSecRmk

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

WireDrwdwnStatSecRmk 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.
WireEntityRec_CType

WireEntityRec_CType is a complex CType element.

Contains:

  • AddrISO_CType
  • Custom_CType
  • InstEntityInfoArray_AType
  • PersonIdInfo_CType
  • WireFinInstAcctInfo_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_CType
  • FreeFormAddr_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_CType
  • IdArray_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 Rstr attribute.
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.

WireEntityRec_CType

WireEntityRec_CType is a complex CType element.

Contains:

  • AddrISO_CType
  • Custom_CType
  • InstEntityInfoArray_AType
  • PersonIdInfo_CType
  • WireFinInstAcctInfo_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_CType
  • FreeFormAddr_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_CType
  • IdArray_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 Rstr attribute.
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_CType
  • WireSchedRecArray_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, and SrchType attributes.
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:

  • Email
  • 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

Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Wed Feb 5 2025