International Wire Transaction Addition
International Wire Transaction Addition
International Wire Transaction Addition is a jXchange service designed to provide the consumer's subscribed financial institution the ability to create an Outgoing Wire, Outgoing Draft, or Incoming Wire, and/or create a quote with transaction details.
Message Flow
In jXchange, the International Wire
Transaction Search service uses a typical exchange of MType
messages to provide the
subscribed financial institution the ability to create an Outgoing Wire,
Outgoing Draft, or Incoming Wire, and/or create a quote with transaction
details.
Primary Request
The third-party consumer forwards the WireIntlTrnAddRq_MType
message to
the service provider.
The message contains the following simple elements:
- CurrPmtType
- CurrType
- FinInstRtId
- FundMthdType
- SttlCurrType
- SttlFinInstRtId
- SttlMthdType
- SttlWireAcctId
- WireAmt
- WireContrRefId
- WireCorrelId
- WireQuoteId
- WireTrnTimeDt
The message contains the following complex elements:
MsgRqHdr_CType
WireIntlTrnDetails_CType
The message contains the following array:
ErrOvrRdInfoArray_AType
Primary Response
The service provider returns the WireIntlTrnAddRs_MType
message to
the third-party consumer.
The message contains the following simple elements:
- CurrExchRate
- FeeCurrType
- FornCurrAmt
- PartPmtSttlNetCostAmt
- QuoteExpTimeDt
- QuoteRemSecs
- RsStat
- SttlCostAmt
- SttlNetCostAmt
- TotFeeAmt
- WireBankFeeAmt
- WireBankTaxAmt
- WireContrRefId
- WireCorrelId
- WirePartPmtRefId
- WireQuoteId
- WireTrnRefId
- WireTrnTimeDt
The message contains the following complex element:
MsgRsHdr_CType
International Wire Transaction Addition Behavior
The WireIntlTrnAddRq_MType
request message requires a
valid FinInstRtId
element be enrolled in the
international wires application, along with the
WireCorrelId
element and the
WireIntlTrnDetails_CType
complex.
The CurrType
and SttlCurrType
elements are closed enumerated
elements governed by ISO 4217 currency codes. The alphanumeric characters are the acceptable
values (i.e., USD, EUR).
The WireQuoteId
element is required if the consumer
cached the element from the WireIntlQuoteAddRs_MType
response message. The majority of elements in the
WireIntlTrnAddRq_MType
request message will not be
required.
The WireIntlTrnAddRq_MType
request message without a
WireQuoteId
element conveys to the service provider that
a quote and transaction is being created in one message. The same
behavioral aspects pertain to this business case for the Wire
International Quote Addition request message.
The WireIntlTrnAddRs_MType
response message returns a
unique WireTrnRefId
element that should be cached by the
consumer for subsequent wire activities. The
WireIntlTrnAddRs_MType
response message also returns
elements related to obtaining a quote along with the transaction creation.
WireIntlTrnAddRq_MType
WireIntlTrnAddRq_MType
is a message
MType
element.
ErrOvrRdInfoArray_AType
MsgRqHdr_CType
WireIntlTrnDetails_CType
Simple Elements
The following simple elements are contained within this message.
- CurrPmtType
- The type that designates the currency represented for the wire
amount. Canonical values are:
- Forn
- Local
- CurrType
- The alphanumeric ISO 4217 currency code.
- FinInstRtId
- The financial institution's routing and transit identification.
- FundMthdType
- The method of the fund transfer. Canonical values are:
- Draft
- IncomingWire
- IntraContr
- OutgoingWire
The default is OutgoingWire.
- SttlCurrType
- The alphanumeric ISO 4217 currency code.
- SttlFinInstRtId
- The financial institution's routing and transit identification.
- SttlMthdType
- The type that designates method of currency settlement.
Canonical values are:
- 1031Funds
- ACH
- CHAPS
- Wire
- SttlWireAcctId
- The account identification related to wires.
- WireAmt
- The transactional amount of the wire transfer.
- WireContrRefId
- The wire contract reference identification assigned by the wire provider.
- WireCorrelId
- The client assigned correlation identification for wire activities.
- WireQuoteId
- The quote identification given by a wire provider.
- WireTrnTimeDt
- The time and date of the wire transaction.
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_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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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.
WireIntlTrnDetails_CType
WireIntlTrnDetails_CType
is a complex
CType
element.
Contains:
WireIntlCustDetails_CType
WireIntlPayeeDetails_CType
Simple Elements
The following simple elements are contained within this complex.
- BenfEmailAddr1
- Email address.
- BenfEmailAddr2
- Email address.
- BenfEmailAddr3
- Email address.
- OrderCustFundAcctId
- The account identification related to wires.
- OrderCustFundInstRtId
- The financial institution's routing and transit identification.
- WireBenfRmk
- Application or user remarks free-form text.
- WirePmtRmk
- Application or user remarks free-form text.
- WireRmk
- Application or user remarks free-form text.
WireIntlCustDetails_CType
WireIntlCustDetails_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- ConName1
- The common name. This is the full text line name like John Doe.
- ConName2
- The common name. This is the full text line name like John Doe.
- CustName
- The common name. This is the full text line name like John Doe.
- FinInstCity
- The city name.
- FinInstCntryType
- The country abbreviation from ISO 3166.
- FinInstName
- The depository financial institution name.
- FinInstPostalCode
- The postal code or ZIP code.
- FinInstStateProv
- The state or province or region.
- FinInstStreetAddr1
- The street address.
- FinInstStreetAddr2
- The street address.
- PostalCode
- The postal code or ZIP code.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- WireCustId
- The identifier attached to a customer.
- WireIntlCustId
- The identifier attached to a customer.
- WireOrignFinInstId
- The identification of the originator named financial institution for a wire transfer.
WireIntlPayeeDetails_CType
WireIntlPayeeDetails_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- City
- The city name.
- CntryType
- The country abbreviation from ISO 3166.
- FinInstCity
- The city name.
- FinInstCntryType
- The country abbreviation from ISO 3166.
- FinInstName
- The depository financial institution name.
- FinInstPostalCode
- The postal code or ZIP code.
- FinInstRtId
- The financial institution's routing and transit identification.
- FinInstStateProv
- The state or province or region.
- FinInstStreetAddr1
- The street address.
- FinInstStreetAddr2
- The street address.
- IntmdFinInstCity
- The city name.
- IntmdFinInstCntryType
- The country abbreviation from ISO 3166.
- IntmdFinInstPostalCode
- The postal code or ZIP code.
- IntmdFinInstStateProv
- The state or province or region.
- IntmdFinInstStreetAddr1
- The street address.
- IntmdFinInstStreetAddr2
- The street address.
- PayeeFinInstRtId
- The financial institution's routing and transit identification.
- PayeeName
- The name of the payee.
- PostalCode
- The postal code or ZIP code.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- WireAcctId
- The account identification related to wires.
- WireIntlPayeeId
- The identifier attached to a customer.
- WireIntmdFinInstId
- The identification of the intermediary named financial institution for a wire transfer.
- WireIntmdFinInstName
- The name of the intermediary named financial institution for a wire transfer.
- WirePayeeFinInstId
- The identification of the originator named financial institution for a wire transfer.
- WirePayeeId
- The identifier attached to a customer.
WireIntlTrnAddRs_MType
WireIntlTrnAddRs_MType
is a message
MType
element.
MsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CurrExchRate
- The exchange rate for a specific currency.
- FeeCurrType
- The alphanumeric ISO 4217 currency code.
- FornCurrAmt
- The foreign currency amount.
- PartPmtSttlNetCostAmt
- The net cost to the client in the settlement currency for performing transactions.
- QuoteExpTimeDt
- The date and time that a quote expires. Expressed in ISO 8601 time format and should contain either Zulu time or local time and the UTC offset. The format should follow this example: [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm].
- QuoteRemSecs
- The quote remaining time as expressed in seconds.
- RsStat
- The status of the response. Canonical values are:
- Fail
- Success
- SttlCostAmt
- The cost to the client in the settlement currency for performing transactions.
- SttlNetCostAmt
- The net cost to the client in the settlement currency for performing transactions.
- TotFeeAmt
- The amount of fees.
- WireBankFeeAmt
- The other bank fees mandatory for client notification.
- WireBankTaxAmt
- The other bank taxes mandatory for client notification.
- WireContrRefId
- The wire contract reference identification assigned by the wire provider.
- WireCorrelId
- The client assigned correlation identification for wire activities.
- WirePartPmtRefId
- An identification given by the wire provider for a partial payment.
- WireQuoteId
- The quote identification given by a wire provider.
- WireTrnRefId
- The wire transaction reference identification assigned by the wire provider.
- WireTrnTimeDt
- The time and date of the wire transaction.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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.