International Wire Quote Modification
International Wire Quote Modification
International Wire Quote Modification is a jXchange service designed to provide the consumer's subscribed financial institution the ability to release or delete a transaction created by the successful Wire International Transaction Addition message.
Message Flow
In jXchange, the International Wire
Quote Modification service uses a typical exchange of MType messages to release or
delete a transaction created by the successful Wire International
Transaction Addition message.
Primary Request
The third-party consumer forwards the WireIntlQuoteModRq_MType message
to the service provider.
The message contains the following simple elements:
- Dlt
- FinInstRtId
- WireTrnRefId
The message contains the following complex elements:
MsgRqHdr_CTypeWireIntlTrnModRec_CType
The message contains the following array:
ErrOvrRdInfoArray_AType
Primary Response
The service provider returns the WireIntlQuoteModRs_MType message
to the third-party consumer.
The message contains the following simple elements:
- CurrExchRate
- FeeCurrType
- FornCurrAmt
- QuoteExpTimeDt
- QuoteRemSecs
- RsStat
- SttlCostAmt
- SttlNetCostAmt
- TotFeeAmt
- WireQuoteId
- WireTrnTimeDt
The message contains the following complex element:
MsgRsHdr_CType
International Wire Quote Modification Behavior
The WireIntlQuoteModRq_MType request message requires
a valid FinInstRtId element be enrolled in the
international wires application, along with the
WireTrnRefId element. The WireTrnRefId
element is obtained from the Wire International Transaction Addition
response message.
The Wire International Quote Modification message has a limited set of elements that can be modified but is positioned to allow for future enhancements. The modification only allows for the transaction to be processed or deleted at the time of this document's publication.
The WireIntlQuoteModRq_MType request message with the
WireStat element set to ~P~
conveys to the service provider to process the wire transaction. When the
Dlt element is set to ~true~ in
the request message, it conveys to the service provider to delete the wire
transaction.
The WireIntlQuoteModRs_MType response message
automatically creates a new quote if the request to process the
transaction is submitted after the original quote has expired. The
response would include the elements related to the new quote, which
nullifies the original WireQuoteId element. However, the
transaction will not be processed until the Wire International Quote
Modification request is made with the processing status.
The standard message header tenets are applicable.
WireIntlQuoteModRq_MType
WireIntlQuoteModRq_MType is a message
MType element.
ErrOvrRdInfoArray_ATypeMsgRqHdr_CTypeWireIntlTrnModRec_CType
Simple Elements
The following simple elements are contained within this message.
- Dlt
- The delete element. Canonical values are:
- false
- true
- FinInstRtId
- The financial institution's routing and transit identification.
- WireTrnRefId
- The wire transaction reference identification assigned by the wire provider.
ErrOvrRdInfoArray_AType
ErrOvrRdInfoArray_AType is an array
AType element. This is an array of overrides for
faults.
Contains:
ErrOvrRd_CType
ErrOvrRd_CType
ErrOvrRd_CType is a complex CType element. This
element is used to override errors created in a previous request. This element is
optional.
Simple Elements
The following simple elements are contained within this complex.
- BusSvcType
- The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
- ErrCode
- The error code.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_CType
Simple Elements
The following simple elements are contained within this complex.
- AuthenProdCred
- Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
AuthenUsrCred_CType
AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in
the form of a WS Security element that contains a single SAML V2.0
Assertion.
Simple Elements
The following simple elements are contained within this complex.
- Security
- Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType
jXchangeHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security. - BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the
environment in which the institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number
assigned to financial institutions for routing as assigned by the American
Bankers Association. Any leading zeros must be provided for a complete routing
and transit number. A non-financial institution entity should use a mutually
agreed upon identification that must contain at least one non-integer character.
The canonical value is JHA.
The element is required in all message requests.
- jXLogTrackingId
- An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
- JxVer
- Contains the version jXchange is running for the Soap Header Fault.
- ValidConsmName
- The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
- ValidConsmProd
- The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
- WorkflowCorrelId
- The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
WireIntlTrnModRec_CType
WireIntlTrnModRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- WireStat
- Identifies the status of the wire transaction.
WireIntlQuoteModRs_MType
WireIntlQuoteModRs_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.
- 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.
- WireQuoteId
- The quote identification given by a 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_CTypeMsgRecInfoArray_AType
jXchangeHdr_CType
jXchangeHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security. - BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the
environment in which the institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number
assigned to financial institutions for routing as assigned by the American
Bankers Association. Any leading zeros must be provided for a complete routing
and transit number. A non-financial institution entity should use a mutually
agreed upon identification that must contain at least one non-integer character.
The canonical value is JHA.
The element is required in all message requests.
- jXLogTrackingId
- An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
- JxVer
- Contains the version jXchange is running for the Soap Header Fault.
- ValidConsmName
- The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
- ValidConsmProd
- The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
- WorkflowCorrelId
- The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
- AuthenUsrId
- The user ID which the consumer would like the service provider to
authenticate with for the Soap Header Fault. It is a user ID that the provider
understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
MsgRecInfoArray_AType
MsgRecInfoArray_AType is an array
AType element. This is an array of messages that can be
returned in a response.
Contains:
MsgRec_CType
MsgRec_CType
MsgRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- ErrCat
- The Soap Header Fault error category.
- ErrCode
- The error code.
- ErrDesc
- The Soap Header Fault error description.
- ErrElem
- The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
- ErrElemVal
- The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
- ErrLoc
- The Soap Header Fault error location. This is typically the program that generated the error condition.