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 Add

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

Transfer Addition

Transfer Addition is a jXchage messaging service designed to allow a consumer to create monetary transfers.

Message Flow

In jXchange, the Transfer Addition service uses a typical exchange of MType messages to create monetary transfers.

Primary Request

The consumer forwards the XferAddRq_MType message to the service provider.

The message contains the following simple element:

  • XferType

The message contains the following complex elements:

  • AcctIdFrom_CType
  • AcctIdTo_CType
  • ACHXferRec_CType
  • Custom_CType
  • FutXferRec_CType
  • MsgRqHdr_CType
  • XferRec_CType

The message contains the following array:

  • ErrOvrRdInfoArray_AType

Primary Response

The service provider returns the XferAddRs_MType message to the consumer.

The message contains the following simple elements:

  • RsStat
  • XferKey

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

Transfer Add Behavior

The available balance calculation code is only supported by the service providers that permit a consumer to request a specific calculation method.

The service provider should create a fault if an invalid available balance calculation code is included with the transfer request. A default value of should be returned is included in the response, as this may not create the transaction the consumer was expecting.

The canonical values SemiMonthly, WeekSkipLast, WeekSkipFirst, BiWeekSkipLast, and BiWeekSkipFirst are explicit as to the frequency being requested. Therefore, the Future Transfer Frequency, 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 will encapsulate all of the ACH related elements for international payments.

The NACHA rules indicate that the world does not distinguish between payments transmitted to either a consumer or business account. 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 message request for Transfer Addition or Transfer Modification that includes the XferSrchDestRstrArray_AType should convey to the Service Provider that the consumer understands the restrictions that exist for the source and/or destination transfer account and are requesting that the Service Provider accept this request in lieu of the error message framework for conveyance of fault condition based on transfer restrictions. The Service Provider should return in the Message Record Information Array a ~override~ error category for audit purposes. The Service Provider governs any values submitted in the RstrExclType element and determines whether those value(s) can be overridden based on their application's behavior for transfers.

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 Add Business Case

This is an example document.

The consumer requests his personal bank to transfer funds from his personal account to the escrow account he holds at the bank holding his mortgage.

Initial Request

The consumer’s personal bank issues an XferAddRq_MType message containing the following elements:

Complex ElementSimple ElementValue
XferAddRq_MTypeXferTypeACH
AcctIdFrom_CTypeFromAcctId332456
 FromAcctTypeD
AcctIdTo_CTypeToAcctId1718891
 ToAcctTypeL
ACHXferRec_CTypeACHDrNameJohn Doe
 AChDrRtNum161788444
 ACHDrAcctId332456
 ACHDrAcctTypeD
 ACHCrAcctId1718891
 ACHCrAcctTypeL
 ACHXferAmt1023.57
 ACHFeeAmt1.50
 ACHOneTimeTrue

Initial Response

The Service Provider bank holding the mortgage and escrow account returns the XferAddRs_MType message containing a key to identify the transfer in the future, and the RsStat element with a value of Success to denote that the transfer addition was successfully completed.

XferAddRq_MType

XferAddRq_MType is a message MType element.

Contains:

  • AcctIdFrom_CType
  • AcctIdTo_CType
  • ACHXferRec_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • FutXferRec_CType
  • MsgRqHdr_CType
  • XferRec_CType

Simple Elements

The following simple elements are contained within this message.

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.

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.

ErrOvrRdInfoArray_AType

ErrOvrRdInfoArray_AType is an array AType element. This is an array of overrides for faults.

Contains:

  • ErrOvrRd_CType

ErrOvrRd_CType

ErrOvrRd_CType is a complex CType element. This element is used to override errors created in a previous request. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

BusSvcType
The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
ErrCode
The error code.

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.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request 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.

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.

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

XferAddRs_MType

XferAddRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

RsStat

The status of the response. Canonical values are:

  • fail
  • success
XferKey
The transfer key returned in search/inquiry requests and is needed to modify or delete a transfer.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

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