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.
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 Broker
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.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Transfer Search

Enterprise SOAP API > API by Reference > Core Services > Transfer Search

Transfer Search

Transfer Search is a jXchange messaging service designed to allow a consumer to search transfer activity.

Message Flow

In jXchange, the Transfer Search service uses a typical exchange of MType messages to allow a consumer to search transfer activity.

Primary Request

The consumer forwards the XferSrchRq_MType message to the service provider.

The message contains the following simple elements:

  • CustId
  • HighAmt
  • LowAmt
  • ToOrFrom
  • XferType

The message contains the following complex elements:

  • AccountId_CType
  • Custom_CType
  • SrchMsgRqHdr_CType

Primary Response

The service provider returns the XferSrchRs_MType message to the consumer.

The message contains the following simple elements:

  • ToOrFrom
  • XferType

The message contains the following complex elements:

  • Custom_CType
  • SrchMsgRsHdr_CType

The message contains the following arrays:

  • ACHXferSrchRecArray_AType
  • FutXferSrchRecArray_AType
  • XferSrchRecArray_AType

Transfer Search Behavior

The canonical values SemiMonthly, WeekSkipLast, WeekSkipFirst, BiWeekSkipLast, and BiWeekSkipFirst are explicit as to the frequency being requested. Therefore, the FutXferFreq element can be ignored by the Service Provider.

The default value for the location source of any transfer requests will be the Service Provider's current behavior. For example, if the jX message was considered a telephone transfer then the default should be Tele.

The ACH International Information Record complex includes all of the ACH related elements for international payments.

The NACHA rules indicate that the world does not distinguish between payments transmitted to either consumer or business accounts. Therefore, all international entries will use the standard entry code of International ACH Transactions (IAT). The contract provides the means to determine if the credit and/or debit side of the ACH transfer is for an international destination under the rules of NACHA for international payments.

The annotation was added to the Transaction Code and Transaction Code Description to convey to the consumer this element represents the credit side of the same day transfer request.

A Service Provider should try to return any restrictions that existed to the transfer to and/or from account identification at the time of the acceptance of the transaction.

The FutXferDayOfWeek and FutXferDayOfWeekOccur elements are closed enumerated elements.

In order to maintain backwards compatibility, the FutXferDayOfMonth element always takes precedence if sent in the request in addition to the FutXferDayOfWeek and FutXferDayOfWeekOccur elements.

Transfer Search Business Case

This is an example document.

In this situation, a mortgage lender needs to verify a money transfer from a consumer's bank into an escrow account created for automatic withdrawal of a monthly mortgage payment at a bank with a Service Provider. The transfer must be verified before the close of day if the consumer is to avoid a late payment fee on his mortgage.

Transfer Search - Message Flow Business Case

The lender sends a XferSrchRq_MType to the Service Provider. It includes the following values:

Complex ElementSimple ElementEntry Value
AccountIdAcctId1718891
 AcctTypeD
 ToOrFromTo
 LowAmt1023.57
 HighAmt1023.57

The Service Provider checks only for transfers to the account for the amount of $1023.57, and issues the response message of XferSrchRs_MType to the lender with the following values:

Complex ElementSimple ElementEntry Value
 ToOrFromTo
XferSrchRec_CTypeXferKeyEsc23224
AcctIdFrom_CTypeAcctIdFrom332456
AcctIdTo_CTypeAcctIdTo1718891
XferRec_CTypeAmt1023.57
 PrtRcptNo
 Fee000.00
 RedPrincN/A
 OffCodeA1773

XferSrchRq_MType

XferSrchRq_MType is a message MType element. This is a message complex requesting real time information on transfers to and/or from a specified account.

Contains:

  • AccountId_CType
  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
HighAmt
The value that designates an ending point for amount selections. Optional filter designating the amount to be used as the highest search criteria.
LowAmt
The value that designates a starting point for amount selections. Optional filter designating the amount to be used as the lowest search criteria.
ToOrFrom
Filter for included records to be only To Account or From Account. Missing elements defaults to all records To or From account number are returned. Canonical values are:
  • From
  • To
  • To - Canonical value designating that the search should be performed on transfers to the designated account identified in the AcctId element.
  • From - Canonical value designating that the search should be performed on transfers from the designated account identified in the AcctId.
  • Blank - Designates that the search should include resulting transfers to and from the account identified in the AcctId.
XferType
Identifies the type of transfer operation. Canonical values are:
  • ACH
  • Fut
  • Xfer

Designates whether the transfer is between accounts within a given financial institution, or between separate institutions.

AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

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

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.

XferSrchRs_MType

XferSrchRs_MType is a message MType element. This message complex returns the details of the transaction, as well as an identity key to identify it.

Contains:

  • ACHXferSrchRecArray_AType
  • Custom_CType
  • FutXferSrchRecArray_AType
  • SrchMsgRsHdr_CType
  • XferSrchRecArray_AType

Simple Elements

The following simple elements are contained within this message.

ToOrFrom
Filter for included records to be only To Account or From Account. Missing elements defaults to all records To or From account number are returned. Canonical values are:
  • From
  • To
  • To - Canonical value designating that the search should be performed on transfers to the designated account identified in the AcctId element.
  • From - Canonical value designating that the search should be performed on transfers from the designated account identified in the AcctId.
  • Blank - Designates that the search should include resulting transfers to and from the account identified in the AcctId.
XferType
Identifies the type of transfer operation. Canonical values are:
  • ACH
  • Fut
  • Xfer

Designates whether the transfer is between accounts within a given financial institution, or between separate institutions.

ACHXferSrchRecArray_AType

ACHXferSrchRecArray_AType is an array AType element. This is an array of responses for an ACH transfer search.

Contains:

  • ACHXferSrchRec_CType

ACHXferSrchRec_CType

ACHXferSrchRec_CType is a complex CType element. This complex defines a transfer through an automated clearing house (bank to bank transfer).

Contains:

  • AcctIdFrom_CType
  • AcctIdTo_CType
  • ACHXferRec_CType
Simple Elements

The following simple elements are contained within this complex.

ACHAcctStatDesc
The ACH account status description.
ACHCrBrDesc
The description of the branch code for the ACH credit account.
ACHCrTrnCodeDesc
The description of the transaction code for the ACH credit account.
ACHDrBrDesc
The description of the branch code for the ACH debit account.
ACHDrTrnCodeDesc
The description of the transaction code for the ACH debit account.
ACHFeeCrBrDesc
The description of the branch code of the fee credit account for the ACH transfer request.
ACHFeeDrTrnCodeDesc
The description of the transaction code of the fee debit account for the ACH transfer request.
ACHNSFDesc
The description of the code that references how the ACH transfer behaves if the debit AcctId does not have sufficient funds to cover the transfer request.
ACHSendPreNoteDesc
The description of the code that determines if an ACH prenotification should be generated, as governed by Nacha® rules.
ACHUseLnAmtDesc
The description of the code that references how the ACH transfer amount behaves if the credit AcctId is a loan.
ACHUseLnDtDesc
The description of the code that references how the ACH transfer date behaves if the credit AcctId is a loan.
ACHXferMatPmtDesc
The description of the code that describes the behavior for loan payments at maturity for ACH transfers.
CustIdFrom
The identifier attached to a customer.
CustIdTo
The identifier attached to a customer.
LnUnitId
The identification assigned to a unit of a loan.
XferKey
The transfer key returned in search/inquiry requests and is needed to modify or delete a transfer.
AcctIdFrom_CType

AcctIdFrom_CType is a complex CType element. This element is the source description (AcctId and AcctType) for a source/destination transfer.

Simple Elements

The following simple elements are contained within this complex.

FromAcctId
The source account ID.
FromAcctType
The source account type.
AcctIdTo_CType

AcctIdTo_CType is a complex CType element. This is the destination description (AcctId and AcctType) for a source/destination transfer.

Simple Elements

The following simple elements are contained within this complex.

ToAcctId
The destination account ID.
ToAcctType
The destination account type.
ACHXferRec_CType

ACHXferRec_CType is a complex CType element. This complex defines a transfer through an ACH transaction (bank to bank transfer). This is not included if the XferType is Xfer.

Contains:

  • ACHAddendaArray_AType
  • ACHIntlInfoRec_CType
  • EftDescArray_AType
Simple Elements

The following simple elements are contained within this complex.

AcctStat
The account status.
ACHAltCompName
The alternate company name that can be used for EFT description requirements.
ACHCompDiscrData
The ACH company discretionary data, as governed by Nacha® rules.
ACHCompEntryDesc
The ACH company entry description, as governed by Nacha® rules.
ACHCompId
The ACH company ID.
ACHCompName
The ACH company name, as governed by Nacha® rules.
ACHCrAcctId
The account ID of the credit account for the ACH item.
ACHCrAcctType
The account type of the ACH credit account ID.
ACHCrName
The account holder's name of the credit account for the ACH item.
ACHCrTrnCodeCode
The transaction code for the ACH credit account.
ACHDayAdv
The number of days in advance to create the ACH transfer request.
ACHDrAcctId
The account ID of the debit account for the ACH item.
ACHDrAcctType
The account type of the ACH debit account ID.
ACHDrBrCode
The branch code for the ACH debit account.
ACHDrName
The account holder's name of the debit account for the ACH item.
ACHDrRtNum
The routing and transit number of the debit account's bank for the ACH item.
ACHDrTrnCodeCode
The transaction code for the ACH debit account.
ACHFeeAmtLTD
The life-to-date fee amount that has been collected for each ACH transaction created.
ACHFeeAmt
The fee amount to be collected for each ACH transaction created.
ACHFeeCrAcctId
The account ID of the fee credit account for the ACH transfer request.
ACHFeeCrAcctType
The account type of the fee credit account for the ACH transfer request.
ACHFeeCrBrCode
The branch code of the fee credit account for the ACH transfer request.
ACHFeeCrRtNum
The routing and transit number of the fee credit account's bank for the ACH transfer request.
ACHFeeCrTrnCodeCode
The transaction code of the fee credit account for the ACH transfer request.
ACHFeeDrAcctId
The account ID of the fee debit account for the ACH transfer request.
ACHFeeDrAcctType
The account type of the fee debit account for the ACH transfer request.
ACHFeeDrBrCode
The branch code of the fee debit account for the ACH transfer request.
ACHFeeDrRtNum
The routing and transit number of the fee debit account's bank for the ACH transfer request.
ACHFeeDrTrnCodeCode
The transaction code of the fee debit account for the ACH transfer request.
ACHIndvId
The ID entered by the originator provides additional identification for the ACH receiver and may be helpful in identifying the consumer.
ACHLastMainDt
The last maintenance date.
ACHLastXferDt
The date of the last ACH transfer request.
ACHNextXferDay
The specific day of the month of each ACH transfer request.
ACHNextXferDt
The date of the next ACH transfer request.
ACHNSFCode
The code that references how the ACH transfer should behave if the debit AcctId does not have sufficient funds to cover the transfer request.
ACHOneTime
Indicates if the ACH transfer should only occur one time and then expire.
ACHOpenDt
The date opened.
ACHSemiDay1
The day of month for first semi-monthly payment.
ACHSemiDay2
The day of month for second semi-monthly payment.
ACHSendPreNoteCode
The code that determines if an ACH prenotification should be generated, as governed by Nacha® rules.
ACHStdEntryClass
The ACH standard entry class.
ACHTermCnt
The integer length of the term.
ACHTermUnits
The term units: years, months, days, indefinite. Canonical values are:
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • Years
ACHUseLnAmtCode
The code that references how the ACH transfer amount should behave if the credit AcctId is a loan.
ACHUseLnDtCode
The code that references how the ACH transfer date should behave if the credit AcctId is a loan.
ACHXferAmtLTD
The life-to-date transfer amount for the ACH transactions.
ACHXferAmt
The transfer amount for the ACH transaction.
ACHXferExpireDt
The expiration date of the ACH transfer request.
ACHXferMatPmtCode
The code that describes the behavior for loan payments at maturity for ACH transfers.
LnUnitId
The identification assigned to a unit of a loan.
RedPrinc
Canonical values are:
  • false
  • true
XferBalType
Answers the question: What balances should be considered for transfer requests? Canonical values are:
  • Avl
  • Col
  • Ldgr
XferSrcType
The source of the transfer request. Canonical values are:
  • ATM
  • InPerson
  • Intnet
  • Mob
  • Tele
ACHAddendaArray_AType

ACHAddendaArray_AType is an array AType element. This is an array containing ACH addenda records.

Contains:

  • ACHAddendaInfoRec_CType
ACHAddendaInfoRec_CType

ACHAddendaInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ACHAddenda
An ACH record type carrying the supplemental data needed to completely identify an account holder or provide information concerning a payment to the RDFI and the receiver.
ACHIntlInfoRec_CType

ACHIntlInfoRec_CType is a complex CType element.

Contains:

  • ACHIntlAddendaArray_AType
Simple Elements

The following simple elements are contained within this complex.

ACHIntlType
Defines which side of the ACH transfer belongs to an international entity. Canonical values are:
  • Credit
  • Debit
ACHRecvId
An originator trace number provided to the receiver of the ACH transactions.
ACHStdEntryClass
The ACH standard entry class.
FornExchRef
The foreign exchange rate used to run the foreign exchange conversion for international items in accord with Nacha® standards.
FornExchRefType
The code used to indicate the content of the foreign exchange reference for international items in accord with Nacha® standards. Canonical values are:
  • FornExchRate
  • FornExchRef
  • NA
FornExchType
The code used to indicate the foreign exchange conversion methodology applied to international items in accord with Nacha® standards. Canonical values are:
  • Fix
  • FixVar
  • VarFix
FornPmtAmt
The amount of foreign payment as expressed in the destination currency code.
ISODestCntry
The code as approved by the International Organization for Standardization (ISO) used to identify the destination country for international items in accordance with Nacha® standards.
ISODestCur
The code as approved by the ISO used to identify the currency denomination of the destination country for international items in accordance with Nacha® standards.
ISOOrigCur
The code as approved by the ISO used to identify the currency denomination of the origination country for international items in accordance with Nacha® standards.
ACHIntlAddendaArray_AType

ACHIntlAddendaArray_AType is an array AType element. This is an array of ACH international addenda records.

Contains:

  • ACHIntlAddendaInfoRec_CType
ACHIntlAddendaInfoRec_CType

ACHIntlAddendaInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ACHCompName
The ACH company name, as governed by Nacha® rules.
ACHIntlAddendaType
The type that defines the classification of the ACH international addenda. Canonical values are:
  • Orign
  • Recv
City
The city name.
Cntry
The country name.
CntryType
The country abbreviation from ISO 3166.
FinInstName
The depository financial institution name.
FinInstQualId
Identifies the numbering scheme used in the depository financial institution identification element. Canonical values are:
  • BIC
  • NCSN
  • IBAN
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.

PostalCode
The postal code or ZIP code.
StateProv
The state or province or region.
StreetAddr1
The street address.
EFTDescArray_AType

EFTDescArray_AType is an array AType element.

Contains:

  • EftDescInfo_CType
EftDescInfo_CType

EftDescInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

EftDesc
A free-format description that further defines pertinent information about the transactions. Often associated with electronic transaction types.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

FutXferSrchRecArray_AType

FutXferSrchRecArray_AType is an array AType element. This is an array of responses for a future dated transfer search.

Contains:

  • FutXferSrchRec_CType

FutXferSrchRec_CType

FutXferSrchRec_Type is a complex CType element.

Contains:

  • AcctIdFrom_CType
  • AcctIdTo_CType
  • Custom_CType
  • FutXferRec_CType
Simple Elements

The following simple elements are contained within this complex.

CustIdFrom
The identifier attached to a customer.
CustIdTo
The identifier attached to a customer.
FutXferLateChgDesc
The description of the code that references how the transfer amount behaves if the ToAcctId is a loan and the loan has late charges due.
FutXferMatPmtDesc
The description of the code that describes the behavior for loan payments at maturity for future transfers.
FutXferNSFDesc
The description of the code that references how the transfer behaves if the FromAcctId does not have sufficient funds to cover the transfer request.
FutXferUseLnAmtDesc
The description of the code that references how the transfer amount behaves if the ToAcctId is a loan.
FutXferUseLnDtDesc
The description of the code that references how the transfer date behaves if the ToAcctId is a loan.
LnUnitId
The identification assigned to a unit of a loan.
TrnCodeDesc
The description of the code that identifies the behavior of a monetary transaction.
XferKey
The transfer key returned in search/inquiry requests and is needed to modify or delete a transfer.
AcctIdFrom_CType

AcctIdFrom_CType is a complex CType element. This element is the source description (AcctId and AcctType) for a source/destination transfer.

Simple Elements

The following simple elements are contained within this complex.

FromAcctId
The source account ID.
FromAcctType
The source account type.
AcctIdTo_CType

AcctIdTo_CType is a complex CType element. This is the destination description (AcctId and AcctType) for a source/destination transfer.

Simple Elements

The following simple elements are contained within this complex.

ToAcctId
The destination account ID.
ToAcctType
The destination account type.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

FutXferRec_CType

FutXferRec_CType is a complex CType element.

Contains:

  • EFTDescArray_AType
  • GLTrnDescArray references Rmk_AType
Simple Elements

The following simple elements are contained within this complex.

Amt
The amount or quantity.
FutXferAmtLTD
The life-to-date transfer amount for the transfer transactions.
FutXferDayOfMonth
The day of the month for transfer transaction. This day is only required if the transfer date is the 29th of the month.
FutXferDayOfWeekOccur
The day of week occurrence. Canonical values are:
  • First
  • Secd
  • Third
  • Fourth
  • Last
FutXferDayOfWeek
The day of the week. Canonical values are:
  • Mon
  • Tues
  • Wed
  • Thur
  • Fri
  • Sat
  • Sun
FutXferExpDt
The expiration date of the transfer request.
FutXferFirstDt
The first date to start a future transfer request.
FutXferFreq
The frequency of the transfer.
FutXferFreqUnits
The units of frequency for the transfer request. Canonical values are:
  • BiWeekSkipFirst
  • BiWeekSkipLast
  • Days
  • Indefinite
  • Months
  • NA
  • SemiMonthly
  • WeekSkipFirst
  • WeekSkipLast
  • Years
FutXferLateChgCode
The code that references how the transfer amount should behave if the ToAcctId is a loan and the loan has late charges due.
FutXferMatPmtCode
The code that describes the behavior for loan payments at maturity for future transfers.
FutXferNextDt
The next scheduled transfer date.
FutXferNSFCode
The code that references how the transfer should behave if the FromAcctId does not have sufficient funds to cover the transfer request.
FutXferOccr
The number of occurrences for future dated transfer requests.
FutXferSuspEndDt
The end date to suspend the transfer request.
FutXferSuspStartDt
The begin date to suspend the transfer request.
FutXferUseLnAmtCode
The code that references how the transfer amount behaves if the ToAcctId is a loan.
FutXferUseLnDtCode
The code that references how the transfer date behaves if the ToAcctId is a loan.
LnUnitId
The identification assigned to a unit of a loan.
PrtPartRcpt
Answers the question: Should a receipt be printed for partial transactions? Canonical values are:
  • false
  • true
PrtRcpt
Print receipt. Canonical values are:
  • false
  • FirstRcptOnly
  • FromAcct
  • ToAcct
  • true
RcptDlvryMthd
The method used to deliver receipts to customers. Canonical values are:
  • Email
  • Mail
RedPrinc
Canonical values are:
  • false
  • true
SemiDay1
The day of month for first semi-monthly payment.
SemiDay2
The day of month for second semi-monthly payment.
TrnCodeCode
The code that identifies the behavior of a monetary transaction.
XferSrcType
The source of the transfer request. Canonical values are:
  • ATM
  • InPerson
  • Intnet
  • Mob
  • Tele
EFTDescArray_AType

EFTDescArray_AType is an array AType element.

Contains:

  • EftDescInfo_CType
EftDescInfo_CType

EftDescInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

EftDesc
A free-format description that further defines pertinent information about the transactions. Often associated with electronic transaction types.
GLTrnDescArray_AType

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

GLTrnDescArray references Rmk_AType.

Contains:

  • RmkInfo_CType
RmkInfo_CType

RmkInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Rmk
Application or user remarks free-form text.

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.

XferSrchRecArray_AType

XferSrchRecArray_ATYpe is an array AType element. This is an array of responses for a transfer search.

Contains:

  • XferSrchRec_CType

XferSrchRec_CType

XferSrchRec_CType is a complex CType element. This is an optional complex detailing the transaction. There can be multiple XferSrchRec complexes forwarded to detail multiple transactions to the specified account.

Contains:

  • AcctIdFrom_CType
  • AcctIdTo_CType
  • CustomXferSrchRec references Custom_CType
  • XferRec_CType
Simple Elements

The following simple elements are contained within this complex.

TrnCodeDesc is applied to the credit side of the transfer transaction.

CustIdFrom
The identifier attached to a customer.
CustIdTo
The identifier attached to a customer.
DrTrnCodeDesc
The description of the code that identifies the behavior of a monetary transaction.
LnUnitId
The identification assigned to a unit of a loan.
TrnCodeDesc
The description of the code that identifies the behavior of a monetary transaction.
XferKey
The transfer key returned in search/inquiry requests and is needed to modify or delete a transfer.
AcctIdFrom_CType

AcctIdFrom_CType is a complex CType element. This element is the source description (AcctId and AcctType) for a source/destination transfer.

Simple Elements

The following simple elements are contained within this complex.

FromAcctId
The source account ID.
FromAcctType
The source account type.
AcctIdTo_CType

AcctIdTo_CType is a complex CType element. This is the destination description (AcctId and AcctType) for a source/destination transfer.

Simple Elements

The following simple elements are contained within this complex.

ToAcctId
The destination account ID.
ToAcctType
The destination account type.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

XferRec_CType

XferRec_CType is a complex CType element. This is the complex that details the transfer. It is not included if the XferType is ACH.

Contains:

  • ApprvOffInfoArray_CType
  • EftDescArray_AType
  • XferSrcDestRstrArray_AType
Simple Elements

The following simple elements are contained within this complex.

Amt
The amount or quantity.
AvlBalCalcCode
A code that conveys to the service provider the method to use for the calculation of the available balance.
DrTrnCodeCode
The code that identifies the behavior of a monetary transaction.
EFTTrnId
A document reference assigned to an EFT transaction by the originating entity.
Fee
The fee amount.
LnUnitId
The identification assigned to a unit of a loan.
OffCode
The code that designates the financial institution officer.
PrtRcpt
Print receipt. Canonical values are:
  • false
  • FirstRcptOnly
  • FromAcct
  • ToAcct
  • true
RedPrinc
Canonical values are:
  • false
  • true
TrnAcptTimeDt
The date and time a transaction was accepted.
TrnCodeCode
The code that identifies the behavior of a monetary transaction.
XferSrcType
The source of the transfer request. Canonical values are:
  • ATM
  • InPerson
  • Intnet
  • Mob
  • Tele
ApprvOffInfoArray_AType

ApprvOffInfoArray_AType is an array AType element. This is an array of approval officers.

Contains:

  • ApprvOffInfoRec_CType
ApprvOffInfoRec_CType

ApprvOffInfoRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ApprvOffCode
The approving officer code.
ApprvOffDesc
The approving officer description.
ApprvType
The optional element contains the element name as defined in the enterprise dictionary and published as enterprise variables, which requires an officer approval. The service provider would convey the elements that could need approval by the Service Dictionary Search.
EFTDescArray_AType

EFTDescArray_AType is an array AType element.

Contains:

  • EftDescInfo_CType
EftDescInfo_CType

EftDescInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

EftDesc
A free-format description that further defines pertinent information about the transactions. Often associated with electronic transaction types.
XferSrcDestRstrArray_AType

XferSrcDestRstrArray_AType is an array AType element. This is an array of elements that indicates the restrictions that could exist on the transfer account.

Contains:

  • XferSrcDestRstrInfo_CType
XferSrcDestRstrInfo_CType

XferSrcDestRstrInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

RstrExcType
The type of restrictions to be excluded from a response set. Canonical values are:
  • ChgdOff
  • Cls
  • Dormant
  • Escheat
  • Frz
  • LmtTrn
  • NoCr
  • NoPost
  • RstrTrn
XferSrcDestType
Indicates the role of the transfer request as the source or destination. Canonical values are:
  • Both
  • Dest
  • Src
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 Thu Feb 8 2024