International Wire Transaction Search
International Wire Transaction Search is a jXchange service designed to provide the consumer's subscribed financial institution the ability to obtain a listing of international wire transactions.
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 obtain a listing of
international wire transactions.
Primary Request
The Third Party Consumer forwards the
WireIntlTrnSrchRq_MType
message to the Service Provider. The message contains:
CurrType
EndDt
FinInstRtId
FundMthdType
SrchMsgRqHdr_CType
StartDt
TrnSrchDtType
WireCorrelId
WireSttlStatType
WireTrnRefId
Primary Response
The Service Provider returns the
WireIntlTrnSrchRs_MType
message to the Third Party Consumer. The message contains:
CurrType
EndDt
FinInstName
FinInstRtId
FundMthdType
SrchMsgRsHdr_CType
StartDt
TrnSrchDtType
WireCorrelId
WireIntlTrnSrchRsArray_AType
WireSttlStatType
WireTrnRefId
International Wire Transaction Search Behavior
The WireIntlTrnSrchRq_MType
request message requires
that a valid FinInstRtId
element be enrolled in the
International Wires application. The
WireIntlTrnSrchRq_MType
request message provides optional
filter elements. The following are the elements that could be submitted as
filters for the request:
- Currency Type <
CurrType
> - Transaction Search Date Type
<
ContrSrchDtType
> - Fund Method Type <
FundMthdType
> - Wire Correlation Identification
<
WireCorrelId
> - Wire Settlement Status Type
<
WireSttlStatType
> - Wire Transaction Reference Identification
<
WireTrnRefId
>
The CurrType
element is a
closed enumerated element governed by ISO 4217 currency codes. The alphanumeric are the
acceptable values (i.e., USD, EUR).
The default canonical value for the FundMthdType
element is ~OutgoingWire~.
A consumer request with a StartDt
and without an
EndDt
, returns all of the qualified transaction records
with a date equal to and greater than the StartDt
and an
EndDt
less than or equal to a date one month from the
StartDt
.
A consumer request with an EndDt
and without a
StartDt
, returns all of the qualified transaction records
with a date equal to and less than the EndDt
and a
StartDt
greater than or equal to a date one month from
the EndDt
.
The search start date will use the 00:00:01 time comparison and the the search end date will use the 24:00:00 time comparison.
A consumer request without a StartDt
or an
EndDt
and has a TrnSrchDtType
, returns
all of the qualified transaction records for a month range from the
current date of the message request.
The consumer must include a TrnSrchDtType
element when
requesting a filter with date ranges. The service providers date value
being used for the StartDt
and EndDt
is
dependent upon the data value for the TrnSrchDtType
element.
The WireIntlTrnSrchRs_MType
response message echoes
back the elements from the request. The response returns an array of
transactions in accord with the filters leveraged in the request. The
WireIntlTrnSrchRsArray_AType
response array is the base
array that includes the WireIntlTrnSrchRsRec_CType
complex, which contains a subset of transaction related elements.
The WireTrnRefId
element may be cached by the consumer
to be used for the Wire International Transaction Inquiry message to
obtain all of the data elements related to a specific transaction.
The standard search message header tenets are applicable with the following exceptions:
- The
MaxRec
element in theSrchMsgRqHdr_CType
complex is limited to 1000 based on constraints of the service provider. However, any value below 1000 is acceptable. - The consumer could receive a fault regardless of
the
MaxRec
element data value because it is based on the filter data values entered at the request. This requires the consumer to create a specific request in order to receive a subset response that adheres to a response set of less than 1000.
WireIntlTrnSrchRq_MType
WireIntlTrnSrchRq_MType
is a message
MType
element.
Contains:
SrchMsgRqHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- CurrType
- The alphanumeric ISO 4217 currency code.
- EndDt
- The date that designates the ending point for date selections.
- 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.
- StartDt
- The date that designates the starting point for date selections.
- TrnSrchDtType
- Identifies the type of date being represented for a transaction
search. Canonical values are:
- Apprv
- Canc
- Crt
- ReSend
- Ret
- Sttl
- Val
- WireCorrelId
- The client assigned correlation identification for wire activities.
- WireSttlStatType
- Identifies the status of a wire transaction. Canonical values are:
- Canc
- InProc
- PendRel
- PmtInstrPend
- PmtInstrSent
- ReSend
- Ret
- Sttl
- WireTrnRefId
- The wire transaction reference identification assigned by the wire provider.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType
is a complex
CType
element. This is a
standard request message 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.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MaxRec
- The maximum number of records when multiple records are returned.
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 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 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 byWS-Security
.
WireIntlTrnSrchRs_MType
WireIntlTrnSrchRs_MType
is a
message MType
element.
Contains:
SrchMsgRsHdr_CType
WireIntlTrnSrchRsArray_AType
Simple Elements
The simple elements contained within this message are listed below.
- CurrType
- The alphanumeric ISO 4217 currency code.
- EndDt
- The date that designates the ending point for date selections.
- FinInstName
- The depository financial institution name.
- 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.
- StartDt
- The date that designates the starting point for date selections.
- TrnSrchDtType
- Identifies the type of date being represented for a transaction
search. Canonical values are:
- Apprv
- Canc
- Crt
- ReSend
- Ret
- Sttl
- Val
- WireCorrelId
- The client assigned correlation identification for wire activities.
- WireSttlStatType
- Identifies the status of a wire transaction. Canonical values are:
- Canc
- InProc
- PendRel
- PmtInstrPend
- PmtInstrSent
- ReSend
- Ret
- Sttl
- WireTrnRefId
- The wire transaction reference identification assigned by the wire provider.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType
is a complex
CType
element. It searches specific message response
headers.
Contains:
jXchangeHdr_CType
MsgRecInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MoreRec
- Indicates if there are more records that could be returned. Canonical values are:
- false
- true
- SentRec
- The number of records sent in the response.
- TotRec
- Indicates the total records the request selected, which could be larger than
MaxRec.
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 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 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 byWS-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.
WireIntlTrnSrchRsArray_AType
WireIntlTrnSrchRsArray_AType
is an array
AType
element. This is an array of international wire
transactions from the search request.
Contains:
WireIntlTrnSrchRsRec_CType
WireIntlTrnSrchRsRec_CType
WireIntlTrnSrchRsRec_CType
is a
complex CType
element.
Simple Elements
The simple elements contained within this complex are listed below.d
- CurrExchRate
- The exchange rate for a specific currency.
- CurrType
- The alphanumeric ISO 4217 currency code.
- CustName
- The common name. This is the full text line name like John Doe.
- FeeCurrType
- The alphanumeric ISO 4217 currency code.
- FinInstName
- The depository financial institution name.
- FornCurrAmt
- The foreign currency amount.
- FundMthdType
- The method of the fund transfer. Canonical values are:
- Draft
- IncomingWire
- IntraContr
- OutgoingWire
The default is OutgoingWire.
- PayeeFinInstRtId
- The financial institution's routing and transit identification.
- PayeeFinInstName
- The depository financial institution name.
- PayeeName
- The name of the payee.
- 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.
- WireAcctId
- The account identification related to wires.
- 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.
- 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.
- WireCustId
- The identifier attached to a customer.
- WireFeeAmt
- The fee amount associated with a transaction.
- WireIntlCustId
- The identifier attached to a customer.
- 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.
- WireOrignFinInstId
- The identification of the originator 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.
- WireQuoteId
- The quote identification given by a wire provider.
- 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.
- WireTrnRefId
- The wire transaction reference identification assigned by the wire provider.
- WireTrnTimeDt
- The time and date of the wire transaction.