International Wire Transaction Inquiry

International Wire Transaction Inquiry is a jXchange service designed to provide the consumer's subscribed financial institution the ability to inquire on a specific international wire transaction.

Message Flow

In jXchange, the International Wire Transaction Inquiry service uses a typical exchange of MType messages to provide the subscribed financial institution the ability to inquire on a specific international wire transaction.

Primary Request

The Third Party Consumer forwards the WireIntlTrnInqRq_MType message to the Service Provider. The message contains:

  • FinInstRtId
  • MsgRqHdr_CType
  • WireTrnRefId

Primary Response

The Service Provider returns the WireIntlTrnInqRs_MType message to the Third Party Consumer. The message contains:

  • FinInstName
  • FinInstRtId
  • MsgRsHdr_CType
  • WireIntlTrnInqRec_CType
  • WireTrnRefId

International Wire Transaction Inquiry Behavior

The WireIntlTrnInqRq_MType request message requires a valid FinInstRtId and the WireTrnRefId elements be enrolled in the international wires application. The WireTrnRefId element can be obtained from the Wire Transaction Search message.

The WireIntlTrnInqRs_MType response message echoes back the elements from the request. The response also includes the FinInstName element. The response returns the details related to a specific International Wire Transaction in the WireIntlTrnInqRec_CType. The WireIntlTrnInqRec_CType complex includes the WireIntlTrnDetails_CType complex. The WireIntlTrnDetails_CType complex is reused in services related to specific transaction activity.

The standard message header tenets are applicable.

WireIntlTrnInqRq_MType

WireIntlTrnInqRq_MType is a message MType element.

Contains:

  • MsgRqHdr_CType

Simple Elements

The simple elements contained within this message are listed below.

FinInstRtId
The financial institution's routing and transit identification.
WireTrnRefId
The wire transaction reference identification assigned by the wire provider.

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 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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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.

WireIntlTrnInqRs_MType

WireIntlTrnInqRs_MType is a message MType element.

Contains:

  • MsgRsHdr_CType
  • WireIntlTrnInqRec_CType

Simple Elements

The simple elements contained within this message are listed below.

FinInstName
The depository financial institution name.
FinInstRtId
The financial institution's routing and transit identification.
WireTrnRefId
The wire transaction reference identification assigned by the wire provider.

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 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
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to 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 Soap Header Fault 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.

WireIntlTrnInqRec_CType

WireIntlTrnInqRec_CType is a complex CType element.

Contains:

  • WireIntlTrnDetails_CType

Simple Elements

The simple elements contained within this complex are listed below.

CurrExchRate
The exchange rate for a specific currency.
CurrType
The alphanumeric ISO 4217 currency code.
FeeCurrType
The alphanumeric ISO 4217 currency code.
FornCurrAmt
The foreign currency amount.
FornCurrReSendAmt
The foreign currency amount.
FornCurrRetAmt
The foreign currency amount.
FundMthdType
The method of the fund transfer. Canonical values are:
  • Draft
  • IncomingWire
  • IntraContr
  • OutgoingWire

The default is OutgoingWire.

LondonComExCancFeeAmt
The fee amount charged by the London Commodity Exchange for cancelling a wire transaction.
PartPmtSttlNetCostAmt
The net cost to the client in the settlement currency for performing transactions.
ReSendSttlNetCostAmt
The net cost to the client in the settlement currency for performing transactions.
ReSendWireTrnTimeDt
The time and date of the wire transaction.
RetCurrExchRate
The exchange rate for a specific currency.
RetSttlNetCostAmt
The net cost to the client in the settlement currency for performing transactions.
SttlCostAmt
The cost to the client in the settlement currency for performing transactions.
SttlCurrType
The alphanumeric ISO 4217 currency code.
SttlNetCostAmt
The net cost to the client in the settlement currency for performing transactions.
WireApprvTimeDt
The time and date the wire transaction was approved.
WireBankFeeAmt
The other bank fees mandatory for client notification.
WireBankTaxAmt
The other bank taxes mandatory for client notification.
WireCancRsn
The reason for canceling a wire transaction.
WireCancTimeDt
The time and date the wire transaction was canceled.
WireContrRefId
The wire contract reference identification assigned by the wire provider.
WireCorrelId
The client assigned correlation identification for wire activities.
WireCrtTimeDt
The time and date the wire transaction was created.
WireFeeAmt
The fee amount associated with a transaction.
WirePartPmtRefId
An identification given by the wire provider for a partial payment.
WireQuoteId
The quote identification given by a wire provider.
WireReSendTimeDt
The time and date the wire transaction was resubmitted.
WireRetRsnCode
The code that designates the reason a wire was returned. Canonical values are:
  • 10
  • 20
  • 30
  • 40
  • 50
  • 60
  • 70
WireRetRsnDesc
The description of the code that designates the reason a wire was returned.
WireRetRsnRmk
The remarks as related to the reason a wire was returned.
WireRetTrnTimeDt
The time and date a wire transaction was returned.
WireSttlStatType
Identifies the status of a wire transaction. Canonical values are:
  • Canc
  • InProc
  • PendRel
  • PmtInstrPend
  • PmtInstrSent
  • ReSend
  • Ret
  • Sttl
WireSttlTimeDt
The time and date the wire transaction was settled.
WireTrnTimeDt
The time and date of the wire transaction.

WireIntlTrnDetails_CType

WireIntlTrnDetails_CType is a complex CType element.

Contains:

  • WireIntlCustDetails_CType
  • WireIntlPayeeDetails_CType
Simple Elements

The simple elements contained within this complex are listed below.

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 simple elements contained within this complex are listed below.

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 simple elements contained within this complex are listed below.

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.
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.
WireIntlPayeeId
The identifier attached to a customer.
WirePayeeId
The identifier attached to a customer.