Enterprise Solutions

Transfer Add Validate

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

Transfer Addition Validate

Transfer Addition Validate is a jXchange service designed to allow the consumer to validate the addition of a transfer request.

Message Flow

In jXchange, the Transfer Addition Validate service uses a typical exchange of MType messages to allow the consumer to validate the addition of a transfer request.

Primary Request

The consumer forwards the XferAddValidateRq_MType message to the service provider.

The message contains the following complex element:

  • Custom_CType

The message contains the following message element:

  • XferAddRq_MType

Primary Response

The service provider returns the XferAddValidateRs_MType message to the consumer.

The message contains the following simple element:

  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType

Add Validate Services Behavior

The names for the validation operation always follow the model where the addition operation is followed by validate. For example, AcctAdd validation operation is AcctAddValidate.

The request validate message contains the addition operation request message.

The Service Provider always performs the same processes for the validation as the addition operation. The exception is that there are no new records created in the respective database.

The validation operation is not to be confused as a certification operation as the Service Provider is not altered.

Transfer Add Validate Business Case

The consumer is attempting to validate a transfer addition in this business case.

The Third Party Consumer sends the XferAddValidateRq_MType message with the following values:

Complex ElementSimple ElementEntry Value
XferAddRqXferTypeXfer
AcctIdFromFromAcctId0002235555550015
 FromAcctTypeD
AcctIdToToAcctId0002235555550016
 ToAcctTypeD
FutXferRecAmt2000.00

The Service Provider returns AcctAddValidateRs_MType containing the element RsStat with a value of Success.

XferAddValidateRq_MType

XferAddValidateRq_MType is a message MType element.

Contains:

  • Custom_CType
  • XferAddRq_MType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

XferAddValidateRs_MType

XferAddValidateRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

RsStat

The status of the response. Canonical values are:

  • fail
  • success

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