Developer Programs

Learn

Docs
Important notification about upcoming changes to the DMZ environment. Please read.

Wire Exception Transaction Search

Enterprise SOAP API > API by Reference > Core Services > Wire Exception Transaction Search

Wire Exception Transaction Search

Wire Exception Transaction Search is a jXchange service that allows the consumer to search wire transaction exceptions.

Message Flow

In jXchange, the Wire Exception Transaction Search service uses a typical exchange of MType messages to allow consumers to search wire transaction exceptions.

Primary Request

The consumer forwards the WireTrnISOModRq_MType message to the service provider.

The message contains the following simple elements:

  • ActIntent
  • CrAgentName
  • CrEntityName
  • DrAgentName
  • DrEntityName
  • HighWireAmt
  • LowWireAmt
  • RecvFinInstRtId
  • SndrFinInstRtId
  • WireCorrelId
  • WireExcCode
  • WireExcResolveType
  • WireISOType
  • WireTrnType

The message contains the following complex elements:

  • Custom_CType
  • SrchMsgRqHdr_CType
  • WireAcctId_CType

The message contains the following array:

  • WireExcStateArray_AType

Primary Response

The service provider returns the WireTrnInqRs_MType message to the consumer.

The message contains the following simple elements:

  • ActIntent
  • CrAgentName
  • CrEntityName
  • DrAgentName
  • DrEntityName
  • HighWireAmt
  • LowWireAmt
  • RecvFinInstRtId
  • SndrFinInstRtId
  • WireCorrelId
  • WireExcCode
  • WireExcResolveType
  • WireISOType
  • WireTrnType

The message contains the following elements:

  • Custom_CType
  • SrchMsgRsHdr_CType
  • WireAcctId_CType

The message contains the following arrays:

  • WireExcStateArray_AType
  • WireExcTrnSrchArray_AType

Wire Exception Transaction Search Behavior

The Wire Exception Transaction Search (WireExcTrnSrch) service behavior is as follows.

Wire Exception Transaction Search root request (WireExcTrnSrchRq_MType) contains the following optional elements whereas all are optional but at least one is required:

  • Wire Account Identifier complex WireAcctId_CType
  • Wire Correlation Identifier WireCorrelId
  • Wire ISO Type WireISOType
  • Wire Exception Resolve Type WireExcResolveType
  • High Wire Amount HighWireAmt
  • Low Wire Amount LowWireAmt
  • Wire Exception Code WireExcCode
  • Wire Transaction Type WireTrnType
  • Credit Agent Name CrAgentName [SrchType Canonical values supported Exact, StartsWith, Contains]
  • Debit Agent Name DrAgentName [SrchType Canonical values supported Exact, StartsWith,Contains]
  • Credit Entity Name CrEntityName [SrchType Canonical values supported Exact, StartsWith,Contains]
  • Debit Entity Name DrEntityName [SrchType Canonical values supported Exact,StartsWith, Contains]
  • Wire Exception State Array (WireExcStateArray_AType) which encapsulates Wire Exception State Code WireExcStateCode which contains Wire Exception State Code WireExcStateCode, Wire Exception State Description WireExcStateDesc, Sender Financial Institution Identifier SndrFinInstRtId, Receiving Financial Institution Identifier RecvFinInstRtId, and Activity Intention ActIntent.

Wire Exception Transaction Search root response (WireExcTrnSrchRs_MType) echoes back all the request elements and encapsulates Wire Exception Transaction Search Array (WireExcTrnSrchArray_AType) which encapsulates the Wire Exception Transaction Search Record complex (WireExcTrnSrchRec_CType) which encapsulates the following:

  • Transaction Receipt Identifier TrnRcptId
  • Wire Exception Item Identifier WireExcItemId
  • Wire Exception Transfer Record complex (WireExcTrnRec_CType)
  • Wire Correlation Identifier WireCorrelId
  • Wire ISO Type WireISOType
  • Wire Amount WireAmt
  • Wire Transaction Type WireTrnType
  • Wire Exception Code WireExcCode
  • Credit Agent Name CrAgentName
  • Debit Agent Name DrAgentName
  • Debit Entity Name DrEntityName
  • Sender Financial Institution Identifier SndrFinInstRtId
  • Receiving Financial Institution Identifier RecvFinInstRtId
  • Wire Source WireSrc
  • Activity Intention Key ActIntentKey
  • Wire Exception State Array (WireExcStateArray_AType)

A request with a Low Wire Amount (LowWireAmt) value and the High Wire Amount (HighWireAmt) is null/zero returns all wire exceptions whose Wire Amount (WireAmt) is greater than or equal to the Low Wire Amount (LowWireAmt).

A request with a High Wire Amount (HighWireAmt) value and the Low Wire Amount (LowWireAmt) is null/zero returns all wire exceptions whose Wire Amount (WireAmt) is less than or equal to the High Wire Amount (HighWireAmt).

A request with a Low Wire Amount (LowWireAmt) value and the High Wire Amount HighWireAmt value returns all wire exceptions whose Wire Amount (WireAmt) is greater than or equal to the Low Wire Amount (LowWireAmt) and less than or equal to the High Wire Amount (HighWireAmt).

A request with a Low Wire Amount (LowWireAmt) that is null/zero and the High Wire Amount (HighWireAmt) that is null/zero ignores the amount filter.

Adhere to the Search Message behaviors.

WireExcTrnSrchRq_MType

WireExcTrnSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRqHdr_CType
  • WireAcctId_CType
  • WireExcStateArray_AType

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.

CrAgentName
The depository financial institution name. The SrchType attribute is optional.
CrEntityName
The common name. This element is the full text line name like John Doe.
DrAgentName
The depository financial institution name. The SrchType attribute is optional.
DrEntityName
The common name. This element is the full text line name like John Doe.
HighWireAmt
The transactional amount of the wire transfer.
LowWireAmt
The transactional amount of the wire transfer.
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. 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.
SndrFinInstRtId
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.
WireAcctId
The account identification related to wires.
WireCorrelId
The client assigned correlation identification for wire activities.
WireExcCode
The code for a wire exception.
WireExcResolveType
Has the wire exception item been resolved? Canonical values are:
  • true
  • false
WireISOType
Identifies the type of ISO wire. Canonical values are:
  • CustXfer
  • DrwdwnReply
  • DrwdwnRq
  • FinInstXfer
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.

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

WireAcctId_CType

WireAcctId_CType is a complex CType element. This element contains the incoming wire account identification information.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
BrCode
The branch code.
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.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart

WireExcStateArray_AType

WireExcStateArray_AType is an array AType element. This element is an array of exception states as related to a wire.

Contains:

  • WireExcStateRec_CType

WireExcStateRec_CType

WireExcStateRec_CType is a custom CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

WireExcStateCode
The exception state for a wire exception.
WireExcStateDesc
The description of the exception state for a wire exception.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

WireExcTrnSrchRs_MType

WireExcTrnSrchRs_MType is a message MType element.

  • Custom_CType
  • SrchMsgRsHdr_CType
  • WireAcctId_CType
  • WireExcStateArray_AType
  • WireExcTrnSrchArray

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.

CrAgentName
The depository financial institution name. The SrchType attribute is optional.
CrEntityName
The common name. This element is the full text line name like John Doe.
DrAgentName
The depository financial institution name. The SrchType attribute is optional.
DrEntityName
The common name. This element is the full text line name like John Doe.
HighWireAmt
The transactional amount of the wire transfer.
LowWireAmt
The transactional amount of the wire transfer.
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. 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.
SndrFinInstRtId
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.
WireCorrelId
The client assigned correlation identification for wire activities.
WireExcCode
The code for a wire exception.
WireExcResolveType
Has the wire exception item been resolved? Canonical values are:
  • true
  • false
WireISOType
Identifies the type of ISO wire. Canonical values are:
  • CustXfer
  • DrwdwnReply
  • DrwdwnRq
  • FinInstXfer
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.

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

WireAcctId_CType

WireAcctId_CType is a complex CType element. This element contains the incoming wire account identification information.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
BrCode
The branch code.
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.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart

WireExcStateArray_AType

WireExcStateArray_AType is an array AType element. This element is an array of exception states as related to a wire.

Contains:

  • WireExcStateRec_CType

WireExcStateRec_CType

WireExcStateRec_CType is a custom CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

WireExcStateCode
The exception state for a wire exception.
WireExcStateDesc
The description of the exception state for a wire exception.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

WireExcTrnSrchArray_AType

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

Contains:

  • WireExcTrnSrchRec_CType

WireExcTrnSrchRec_CType

WireExcTrnSrchRec_CType is a custom CType element.

Contains:

  • Custom_CType
  • WireExcStateArray_AType
  • WireExcTrnRec_CType
Simple Dictionary

The following simple elements are contained within this complex.

CrAgentName
The depository financial institution name. The SrchType attribute is optional.
DrAgentName
The depository financial institution name. The SrchType attribute is optional.
DrEntityName
The common name. This element is the full text line name like John Doe.
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. 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.
SndrFinInstRtId
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.
TrnRcptId
The receipt provided for a successful transaction entry.
WireAmt
The transactional amount of the wire transfer.
WireCorrelId
The client assigned correlation identification for wire activities.
WireExcCode
The code for a wire exception.
WireExcItemId
The identifier assigned to a specific account exception item.
WireISOType
Identifies the type of ISO wire. Canonical values are:
  • CustXfer
  • DrwdwnReply
  • DrwdwnRq
  • FinInstXfer
WireSrc
Identifies the source entry of the wire transaction. Canonical values are:
  • DirectLine
  • FIClerk
  • Intnet
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.

WireExcStateArray_AType

WireExcStateArray_AType is an array AType element. This element is an array of exception states as related to a wire.

Contains:

  • WireExcStateRec_CType
WireExcStateRec_CType

WireExcStateRec_CType is a custom CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

WireExcStateCode
The exception state for a wire exception.
WireExcStateDesc
The description of the exception state for a wire exception.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

WireExcTrnRec_CType

WireExcTrnRec_CType is a custom CType element.

Contains:

  • Custom_CType
  • WireAcctId_CType
Simple Elements

The following simple elements are contained within this complex.

CrEntityAcctId
The number or character that identifies an account record.
CrEntityName
The common name. This element is the full text line name like John Doe.
WireExcApprvRmk
Application or user remarks free-form text.
WireExcApprvType
Has the wire exception transaction been approved for processing? Canonical values are:
  • true
  • false
WireExcResolveType
Has the wire exception item been resolved? Canonical values are:
  • true
  • false
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

WireAcctId_CType

WireAcctId_CType is a complex CType element. This element contains the incoming wire account identification information.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
BrCode
The branch code.
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.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart

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 Oct 2 2024