Developer Programs

Learn

Docs

Wire Transaction Return ISO Search

Enterprise SOAP API > API by Reference > Core Services > Wire Transaction Return ISO Search

Wire Transaction Return ISO Search

Wire Transaction Return ISO Search is a jXchange service designed to search ISO return messages.

Message Flow

In jXchange, the Wire Transaction Return ISO Search service uses a typical exchange of MType messages to search ISO return messages.

Primary Request

The consumer forwards the WireTrnRetISOSrchRq_MType message to the service provider.

The message contains the following simple elements:

  • CancelRsnType
  • CancelRsRsnType
  • HighAmt
  • IMAD
  • LowAmt
  • OMAD
  • RecvFinInstRtId
  • RetRqStat
  • WireCrtEndDt
  • WireCrtStartDt
  • WireISOType
  • WireTrnRoleType
  • WireTrnType

The message contains the following complex elements:

  • Custom_CType
  • SrchMsgRqHdr_CType

Primary Response

The service provider returns the WireTrnRetISOSrchRs_MType message to the consumer.

The message contains the following simple elements:

  • CancelRsnType
  • CancelRsRsnType
  • HighAmt
  • IMAD
  • LowAmt
  • OMAD
  • RecvFinInstRtId
  • RetRqStat
  • WireCrtEndDt
  • WireCrtStartDt
  • WireISOType
  • WireTrnRoleType
  • WireTrnType

The message contains the following complex elements:

  • Custom_CType
  • SrchMsgRSHdr_CType

The message contains the following arrays:

  • WireTrnRetISOSrchRecArray_AType

Wire Transaction Return ISO Search Behavior

The Wire Transaction Return ISO Search (WireTrnRetISOSrch) service behavior is as follows.

The Wire Transaction Return ISO Search root request (WireTrnRetISOSrchRq_MType) optionally includes the filters Wire Transaction Role Type (WireTrnRoleType), IMAD (IMAD), OMAD (OMAD), Receiving Financial Institution Routing ID (RecvFinInstRtId), Return Request Status (RetRqStat), Cancel Reason Type (CancelRsnType), Cancel Response Reason Type (CancelRsRsnType), Wire Transaction Type (WireTrnType), Wire ISO Type (WireISOType), Wire Create Start Date (WireCrtStartDt), Wire Create End Date (WireCrtEndDt), Low Amount (LowAmt), and High Amount (HighAmt).

A consumer request with a Wire Create Start Date (WireCrtStartDt), without a Wire Create End Date (WireCrtEndDate) returns qualified Wire History records with a date equal to and greater than the Wire Create Time Date (WireCrtTimeDt).

A consumer request with a Wire Create End Date (WireCrtEndDt), but without a Wire Create Start Date (WireCrtStartDt), returns qualified Wire History records with a date equal to and less than the Wire Create Time Date (WireCrtTimeDt).

A consumer request with a Wire Create Start Date (WireCrtStartDt) and a Wire Create End Date (WireCrtEndDt) returns qualified Wire History records with a date equal to and greater than the Wire Create Time Dt (WireCrtTimeDt) and a date equal to and less than the Wire Create Time Date (WireCrtTimeDt).

A consumer request with a Low Amount (LowAmt), without a High Amount (HighAmt), returns qualified Wire History records with an amount equal to and greater than the Wire Amount (WireAmt).

A consumer request with a High Amount (HighAmt), without a Low Amount (LowAmt), returns qualified Wire History records with an amount equal to and less than the Wire Amount (WireAmt).

A consumer request with a Low Amount (LowAmt) and a High Amount (HighAmt) returns qualified Wire History records with an amount equal to and greater than the Wire Amount (WireAmt) and the amount equal to and less than the Wire Amount (WireAmt).

The Wire Transaction Return ISO Search root response (WireTrnRetISOSrchRs_MType) returns echo back request filters, Wire Transaction Return ISO Search record array (WireTrnRetISOSrchRecArray_AType) which encapsulates Wire Transaction Return ISO Search Record complex (WireTrnRetISOSrch_CType), Wire Transaction Return ISO Search Record complex (WireTrnRetISOSrch_CType) encapsulates, Wire Transaction Role Type (WireTrnRoleType) IMAD (IMAD), (OMAD), Wire Correlation ID (WireCorrelId), Transaction Acceptance Time/Date (TrnAcptTimeDt), Wire Amount (WireAmt), Receiving Financial Institution Routing ID (RecvFinInstRtId), Return Request Status (RetRqStat), Cancel Reason Type (CancelRsnType) Cancel Response ID (CancelRsId), Return Request Message ID (RetRqMsgId), Transaction Receipt ID (TrnRcptId), Wire Create Time / Date (WireCrtTimeDt), Cancel Response Reason Type (CancelRsRsnType), Cancel Response Reason Description (CancelRsRsnDesc), Cancel Response Remark Array (CancelRsRmkArray_AType), Wire Transaction Type (WireTrnType), and Wire ISO Type (WireISOType).

Adhere to the behavior as related to search service.

WireTrnRetISOSrchRq_MType

WireTrnStatusISOSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message:

CancelRsnType
The status of the request to cancel a wire transaction. Canonical values are:
  • InvalidCrAcct
  • InvalidAmt
  • AgentRq
  • CustRq
  • RetFunds
  • Dup
  • Fraud
  • Misc
  • Tech
  • OvrPmt
CancelRsRsnType
The status of the response to return a wire. Canonical values are:
  • AcctCls
  • AgentDiscr
  • InvalidSeq
  • Misc
  • MissingOrigTrn
  • NoCustRs
  • NSF
  • PendCustAuth
  • PendCustRs
  • PendLegal
  • PendReply
  • RetProc
  • RqDrAuth
  • TrfAgent
HighAmt
The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
IMAD
The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
LowAmt
The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
OMAD
The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
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. If applicable, leading zeros are required for a complete routing and transit number. A non-financial institution entity must use a mutually agreed upon identification that contains at least one non-integer character. The canonical value is JHA.
RetRqStat
The status of a request to return a wire. Canonical values are:
  • Apprv
  • PartApprv
  • Pend
  • Rej
WireCrtEndDt
The date that designates the ending point for date selections.
WireCrtStartDt
The date that designates the starting point for date selections.
WireISOType
Identifies the type of ISO wire. Canonical values are:
  • CustXfer
  • DrwdwnReply
  • DrwdwnRq
  • FinInstXfer
WireTrnRoleType
Identifies the type of role specific to wire non-value transactions. Canonical values are:
  • Requestor
  • Responder
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.

WireTrnRetISOSrchRs_MType

WireTrnRetISOSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message:

CancelRsnType
The status of the request to cancel a wire transaction. Canonical values are:
  • InvalidCrAcct
  • InvalidAmt
  • AgentRq
  • CustRq
  • RetFunds
  • Dup
  • Fraud
  • Misc
  • Tech
  • OvrPmt
CancelRsRsnType
The status of the response to return a wire. Canonical values are:
  • AcctCls
  • AgentDiscr
  • InvalidSeq
  • Misc
  • MissingOrigTrn
  • NoCustRs
  • NSF
  • PendCustAuth
  • PendCustRs
  • PendLegal
  • PendReply
  • RetProc
  • RqDrAuth
  • TrfAgent
HighAmt
The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
IMAD
The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
LowAmt
The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
OMAD
The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
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. If applicable, leading zeros are required for a complete routing and transit number. A non-financial institution entity must use a mutually agreed upon identification that contains at least one non-integer character. The canonical value is JHA.
RetRqStat
The status of a request to return a wire. Canonical values are:
  • Apprv
  • PartApprv
  • Pend
  • Rej
WireCrtEndDt
The date that designates the ending point for date selections.
WireCrtStartDt
The date that designates the starting point for date selections.
WireISOType
Identifies the type of ISO wire. Canonical values are:
  • CustXfer
  • DrwdwnReply
  • DrwdwnRq
  • FinInstXfer
WireTrnRoleType
Identifies the type of role specific to wire non-value transactions. Canonical values are:
  • Requestor
  • Responder
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.

WireTrnStatusISOSrchRecArray_AType

WireTrnStatusISOSrchRecArray_AType is an array AType element. This element is an array of responses for wire transaction status [requestor and responder] search.

Contains:

  • WireTrnStatusISOSrchRec_CType
WireTrnStatusISOSrchRec_CType

WireTrnStatusISOSrchRec_CType is a complex CType element.

Contains:

  • WireSvcPrvdInfo_CType
Simple Elements

The following simple elements are contained within this complex:

ActIntentKey
The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
DestFinInstRtId
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. If applicable, leading zeros are required for a complete routing and transit number. A non-financial institution entity must use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.
IMAD
The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
OMAD
The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission.
OrigIMAD
The Message Accountability Data, referred to as MAD, which uniquely identifies each FedWire® message during processing and transmission. The JHANull and Rstr elements are optional.
OrigMsgCode
The original message type.
OrigWireCrtTimeDt
The time and date the wire transaction was created.
OrigWireInstrId
The instruction identification is a point-to-point reference that can be used between the instructing party and the instructed party to refer to the individual instruction.
OrigWireInstrTrnId
Unique identification, as assigned by the first instructing agent, to identify the transaction that is passed on, unchanged, throughout the entire interbank chain.
OrigWireRefId
The wire reference identification provided to a transaction.
OrigWireUETR
A universally unique identifier to provide an end-to-end reference.
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. If applicable, leading zeros are required for a complete routing and transit number. A non-financial institution entity must use a mutually agreed upon identification that contains at least one non-integer character. The canonical value is JHA.
TrnRcptId
The receipt provided for a successful transaction entry.
WireProcState
Identifies the state of the process for a wire. Canonical values are:
  • Cmplt
  • Pend
WireTrnRoleType
Identifies the type of role specific to wire non-value transactions. Canonical values are:
  • Requestor
  • Responder
WireSvcPrvdInfo_CType

WireSvcPrvdInfo_CType is a complex CType element.

Contains:

  • Custom_CType
  • WireSchedRecArray_CType
Simple Elements

The following simple elements are contained within this complex.

AvlBalCalcCode
A code that conveys to the service provider the method to use for the calculation of the available balance.
BrCode
The branch code.
FornWireType
The element identifying if a wire is foreign or domestic. Canonical values are:
  • false
  • true
  • blank
FraudRefId
A unique identification provided by the fraud risk application when a request for review is submitted.
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.
InPersonWireType
The element identifying if wire was initiated in person. Canonical values are:
  • true
  • false
IntnetFinInstId
The identification assigned to a consumer for the financial institution internet product.
OffCode
The code that designates the financial institution officer.
RemitSubjRuleType
Is the wire subject to the remittance rule? Canonical values are:
  • true
  • false
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
TmpltAlwIntnetCashUsr
Answers the question: Is the template allowed to be used by the internet cash user? Canonical values are:
  • true
  • false
WireAcctId
The account identification related to wires.
WireAcctType
The number or character that categorizes the AcctId.
WireAnlysCode
The code that identifies the behavior for Account Analysis activity for the transaction.
WireCompEmplId
The identification given to a company's employee.
WireCompEmplName
The employer name.
WireCompId
The company identification for wire created transactions.
WireCompVerifId
The verification identification associated with a wire user identification for wire business activity permission.
WireCompVerifName
The employer name.
WireCorrelId
The client assigned correlation identification for wire activities.
WireFeeAmt
The fee amount associated with a transaction.
WireNotType

Identifies the behavior for wire notification for a transaction. Canonical values are:

  • Email
  • Fax
  • None
  • Prt
  • EmailFax
  • EmailPrt
WireSrc
Identifies the source entry of the wire transaction. Canonical values are:
  • DirectLine
  • FIClerk
  • Intnet
WireSrcDestCode
The code that describes the source and/or destination of a wire for delivery of the wire.
WireSrcDestDesc
The description of the code that describes the source and/or destination of a wire for delivery of the wire
WireStat
Identifies the status of the wire transaction.
WireTmpltCode
The code that represent the type of wire template.
WireTempltRef
An application's transactional reference that provides guidance as to the source.
WireTmpltCrt

Answers the question: Should a wire template be created for the wire transaction? Canonical values are:

  • false
  • true
  • TempltOnly

The default value is False.

WireTmpltDesc
The readable description assigned to a wire template.
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.

WireSchedRecArray_AType

WireSchedRecArray_AType is an array AType element. This is an array of responses for wire schedules.

Contains:

  • WireSchedRec_CType
WireSchedRec_CType

WireSchedRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Amt
The amount or quantity.
IntnetFinInstId
The identification assigned to a consumer for the financial institution internet product.
SemiDay1
The day of the month for first semi-monthly payment.
SemiDay2
The day of month for second semi-monthly payment.
WireInitDt
The date a wire entry was initiated.
WireInitTime
The time a wire entry was initiated.
WireSchedDayOfMonth
The day of the month for transfer transaction. This day is only required if the transfer date is the 29th of the month.
WireSchedDayOfWeekOccur
The day of week occurrence. Canonical values are:
  • First
  • Secd
  • Third
  • Fourth
  • Last
WireSchedDayOfWeek
The day of the week. Canonical values are:
  • Mon
  • Tues
  • Wed
  • Thur
  • Fri
  • Sat
  • Sun
WireSchedExpDt
The expiration date of the transfer request.
WireSchedFirstDt
The first date to start a future transfer request.
WireSchedFreq
The frequency of the transfer.
WireSchedFreqUnits
The units of frequency for the transfer request. Canonical values are:
  • BiWeekSkipFirst
  • BiWeekSkipLast
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • WeekSkipFirst
  • WeekSkipLast
  • Years
WireSchedId
An identifier provided for the reoccurring schedule.
WireSchedNextDt
The next scheduled transfer date.
WireSchedStat
Identifies the status of the future transfer schedule. Canonical values are:
  • Active
  • Expired
  • Suspended

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 Feb 5 2025