Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Developer Account
Create a developer acccount to access resources that help you integrate with Jack Henry.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Hub
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.

Wire Payment Return Search

Enterprise SOAP API > API by Reference > Core Services > Wire Payment Return Search

Wire Payment Return Search

Wire Payment Return Search is a jXchange service designed to allow consumers to search wire payment returns.

Message Flow

In jXchange, the Wire Payment Return Search service uses a typical exchange of MType messages to allow consumers to search wire payment returns.

Primary Request

The consumer forwards the WirePmtRetSrchRq_MType message to the service provider.

The message contains the following simple elements:

  • EndDt
  • HighAmt
  • LocalTrfType
  • LowAmt
  • RetRqId
  • RetRsnCode
  • StartDt
  • WireCorrelId
  • WireISOType
  • WireProcState
  • WireRefId
  • WireTrnType

The message contains the following complex elements:

  • Custom_CType
  • InAcctId references WireAcctId_CType
  • SrchMsgRqHdr_CType

Primary Response

The service provider returns the WirePmtRetSrchRs_MType message to the consumer.

The message contains the following simple element:

  • EndDt
  • HighAmt
  • LocalTrfType
  • LowAmt
  • RetRqId
  • RetRsnCode
  • StartDt
  • WireCorrelId
  • WireISOType
  • WireProcState
  • WireRefId
  • WireTrnType

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType
  • InAcctId references WireAcctId_CType

The message contains the following array:

  • WirePmtRetRecArray_AType

Wire Payment Return Search Behavior

The Wire Payment Return Search (WirePmtRetSrch) service behavior is as follows.

The Wire Payment Return Search root request (WirePmtRetSrchRq_MType) optionally includes In Account Identifier complex (InAcctId_CType), Return Request Identifier (RetRqId), Wire Reference Identifier (WireRefId), Wire ISO Type (WireISOType), Local Transfer Type (LocalTrfType), Return Reason Code (RetRsnCode), Wire Correlation ID (WireCorrelId), Wire Transaction Type (WireTrnType), Start Date (StartDt), End Date (EndDt), Low Amount (LowAmt), High Amount (HighAmt), and Wire Processing State (WireProcState).

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

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

A consumer request with a Start Date (StartDt) and an End Date (EndDt) returns the 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 the 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 the 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 the 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 Payment Return Search root response (WirePmtRetSrchRs_MType) echoes back the request elements and Wire Payment Return Record Array (WirePmtRetRecArray_AType), which encapsulates Wire Payment Return Record complex (WirePmtRetRec_CType), which encapsulates Wire Account Identification complex (WireAcctId_CType), Wire Transaction Type (WireTrnType), Wire ISO Type (WireISOType), Credit Entity Name (CrEntityName), Credit Entity Account ID (CrEntityAcctId), Debit Entity Name (DrEntityName), Debit Entity Account ID (DrEntityAcctId), Credit Agent Name (CrAgentName), Debit Agent Name (DrAgentName), Wire Amount (WireAmt), Wire Settlement Date (WireSttlDt), Return Reason Code (RetRsnCode), Return Reason Description (RetRsnDesc), Return Request Identifier (RetRqId), Wire Reference Identifier (WireRefId), Local Transfer Type (LocalTrfType), Transaction Receipt (TrnRcptId), Wire Correlation ID (WireCorrelId), Wire Create Time/Date (WireCrtTimeDt), and Wire Processing State (WireProcState).

WirePmtRetSrchRq_MType

WirePmtRetSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • InAcctId references WireAcctId_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message:

EndDt
The date that designates the ending point for date selections.
HighAmt
The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
LocalTrfType
Specifies a local instrument, local clearing option, or further qualifies the service or service level. Canonical values are:
  • AcctCoverPmt
  • AcctCustTrf
  • AcctFinInstTrf
  • CustCoverPmt
  • CustDrawdwn
  • CustDrawdwnRq
  • CustTrf
  • FinInstDrawdwn
  • FinInstDrawdwnRq
  • FinInstTrf
LowAmt
The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
RetRqId
An identification provided by the logging consumer product that defines the message.
RetRsnCode
The code that describes the reason an account/draft item was returned.
StartDt
The date that designates the starting point for date selections.
WireCorrelId
The client assigned correlation identification for wire activities.
WireISOType
Identifies the type of ISO wire. Canonical values are:
  • CustXfer
  • DrwdwnReply
  • DrwdwnRq
  • FinInstXfer
WireProcState
Identifies the state of the process for a wire. Canonical values are:
  • Cmplt
  • Pend
WireRefId
The wire reference identification provided to a transaction.
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.

InAcctId

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

InAcctId references WireAcctId_CType.

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

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 submitted message. A financial institution entity uses the routing transit or ABA nine-digit number assigned to financial institutions for the purpose of 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 uses a mutually agreed upon identification that must contain at least one non-integer character. When a record is directed to a specific financial institution within a holding company, the institution routing identification is the specific financial institution routing identification and not the holding company identification. 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.

WirePmtRetSrchRs_MType

WirePmtRetSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType
  • InAcctId references WireAcctId_CType
  • WirePmtRetRecArray_AType
  • WirePmtRetRec_CType

Simple Elements

The following simple elements are contained within this message:

EndDt
The date that designates the ending point for date selections.
HighAmt
The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
LocalTrfType
Specifies a local instrument, local clearing option, or further qualifies the service or service level. Canonical values are:
  • AcctCoverPmt
  • AcctCustTrf
  • AcctFinInstTrf
  • CustCoverPmt
  • CustDrawdwn
  • CustDrawdwnRq
  • CustTrf
  • FinInstDrawdwn
  • FinInstDrawdwnRq
  • FinInstTrf
LowAmt
The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
RetRqId
An identification provided by the logging consumer product that defines the message.
RetRsnCode
The code that describes the reason an account/draft item was returned.
StartDt
The date that designates the starting point for date selections.
WireCorrelId
The client assigned correlation identification for wire activities.
WireISOType
Identifies the type of ISO wire. Canonical values are:
  • CustXfer
  • DrwdwnReply
  • DrwdwnRq
  • FinInstXfer
WireProcState
Identifies the state of the process for a wire. Canonical values are:
  • Cmplt
  • Pend
WireRefId
The wire reference identification provided to a transaction.
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.

InAcctId

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

InAcctId references WireAcctId_CType.

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

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 submitted message. A financial institution entity uses the routing transit or ABA nine-digit number assigned to financial institutions for the purpose of 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 uses a mutually agreed upon identification that must contain at least one non-integer character. When a record is directed to a specific financial institution within a holding company, the institution routing identification is the specific financial institution routing identification and not the holding company identification. 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.

WirePmtRetRec_CType

WirePmtRetRec_CType is a complex CType element.

Contains:

  • WireAcctId_CType
Simple Elements

The following simple elements are contained within this complex:

CrAgentName
The depository financial institution name. The SrchType attribute is optional.
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.
DrAgentName
The depository financial institution name. The SrchType attribute is optional.
DrEntityAcctId
The number or character that identifies an account record.
DrEntityName
The common name. This element is the full text line name like John Doe.
LocalTrfType
Specifies a local instrument, local clearing option, or further qualifies the service or service level. Canonical values are:
  • AcctCoverPmt
  • AcctCustTrf
  • AcctFinInstTrf
  • CustCoverPmt
  • CustDrawdwn
  • CustDrawdwnRq
  • CustTrf
  • FinInstDrawdwn
  • FinInstDrawdwnRq
  • FinInstTrf
RetRqId
An identification provided by the logging consumer product that defines the message.
RetRsnCode
The code that describes the reason an account/draft item was returned.
RetRsnDesc
The description of the code that describes the reason an account/draft item was returned.
TrnRcptId
The receipt provided for a successful transaction entry.
WireAcctId
The account identification related to wires.
WireAmt
The transactional amount of the wire transfer.
WireCorrelId
The client assigned correlation identification for wire activities.
WireCrtTimeDt
The time and date the wire transaction was created.
WireISOType
Identifies the type of ISO wire. Canonical values are:
  • CustXfer
  • DrwdwnReply
  • DrwdwnRq
  • FinInstXfer
WireProcState
Identifies the state of the process for a wire. Canonical values are:
  • Cmplt
  • Pend
WireRefId
The wire reference identification provided to a transaction.
WireSttlDt
The date the wire transaction was settled.
WireTrnType
Identifies the wire transactional activity. Canonical values are:
  • Both
  • Incoming
  • Outgoing
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 Tue Feb 11 2025