Enterprise Solutions

ACH Company Modification

Enterprise SOAP API > API by Reference > Core Services > ACH Company Modification
ACH Company Modification

ACH Company Modification

ACH Company Modification is a jXchange service designed to allow consumers to modify ACH company values. Modifiable values specifically include temporary exposure values.

Message Flow

In jXchange, the ACH Company Modification service uses a typical exchange of MType messages to allow consumers to modify ACH company values.

Primary Request

The consumer forwards the ACHCompModRq_MType message to the service provider. The message contains the following elements:

  • ACHCompInfo
  • ACHCompKey
  • ACHCompName
  • ActIntentKey
  • Custom_CType
  • Dlt
  • MsgRqHdr_CType

Primary Response

The service provider returns the ACHCompModRs_MType message to the consumer. The message contains the following elements:

  • Custom_CType
  • MsgRsHdr_CType
  • RsStat

ACH Company Modification Behavior

The ACH Company Modification service behavior is as follows.

The ACH Company Modification root request message (ACHCompModRq_MType) requires the ACH Company Name (ACHCompName), ACH Company Key (ACHCompKey), and Activity Intention Key (ActIntentKey).

The Delete element true value conveys to the service provider to delete the ACH Company as related to the keys included in the request.

The ACH Temporary Exposure array (ACHTempExpsrArray_AType) contains the elements as related to the ACH Company. The ACH Temporary Exposure Information complex (ACHTempExpsrInfo_CType) contains the following elements:

  • ACH Exposure Start Date (ACHExpsrStartDt)
  • ACH Exposure Expiration Date (ACHExpsrExpDt)
  • ACH Exposure State Type (ACHExpsrStatType)
  • Officer Code (OffCode)
  • Officer Description (OffDesc)
  • ACH Temporary Exposure Reason (ACHTempExpsrRsn)
  • ACH Temporary Exposure Amount (ACHTempExpsrAmt)

The ACH Exposure State Type (ACHExpsrStatType) default value is Act. The ACH Exposure Start Date (ACHExpsrStartDt) and ACH Exposure Expiration Date (ACHExpsrExpDt) are required and act as the keys for the complex.

The standard tenets for modification services are applicable.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the concurrency model.

Adhere to the tenets related to the correlation identifications.

Adhere to the tenets related to the JHANull attribute.

ACHCompModRq_MType

ACHCompModRq_MType is a message MType element.

Contains:

  • ACHCompInfo_CType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ACHCompKey
The key as related to an ACH company.
ACHCompName
The ACH company name, as governed by Nacha® rules.
ActIntentKey
The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
Dlt

The delete element. Canonical values are:

  • false
  • true

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.

ACHCompInfo_CType

ACHCompInfo_CType is a complex CType element.

Contains:

  • ACHExpsrArray_AType
  • AcctOffsetArray_AType
  • ACHTempExpsrArray_AType
  • Custom_CType

Simple Elements

This complex element contains the following simple elements.

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.
ACHOrgDlyLmtAmt
The daily ACH origination limit amount.
ACHReqOnUsCnt
The number of on-us items per batch required.
ACHReqOnUsPct
The percentage of total on-us amount per batch required.
ACHStdEntryClass
The ACH standard entry class.
AdvSttlDays
The number of days in advance the account settlement should occur.
AlwACHOrgType

The allowable ACH origination type. Canonical values are:

  • Cr
  • Dr
  • DrCr

The default value is DrCr.

CrDlyLmtAmt
The daily ACH origination limit amount.
DrDlyLmtAmt
The daily ACH origination limit amount.
IntnetFinInstOffsetType
The internet banking offsetting type for submitted transaction files. Canonical values are:
  • Bal
  • NetOffset
  • Offset

The default value is Bal.

SttlOrgEffDtType
Answers the question: Should the ACH originations be settled on the effective date? Canonical values are:
  • false
  • true

ACHExpsrArray_AType

ACHExpsrArray_AType is an array AType element. This element is an array of ACH exposure limits.

Contains:

  • ACHExpsrInfo_CType
ACHExpsrInfo_CType

ACHExpsrInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Dictionary
ACHExpsrAmt
The ACH exposure limit amount set.
ExpsrEffDtType

The type of exposure limits as related to the exposure amount. Canonical values are:

  • Batch
  • Day
  • File
  • Item
  • Month
  • Week
ExpsrDrCr

Either debit or credit. Canonical values are:

  • Dr
  • Cr

This element is a hybrid enumeration.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

AcctOffsetArray_AType

AcctOffsetArray_AType is an array AType element. This element is an array of offset accounts for ACH.

Contains:

  • AcctOffsetInfo_CType
AcctOffsetInfo_CType

AcctOffsetInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Dictionary
AcctId
The number or character that identifies an account record.
AcctOffsetType

Defines the type of category for the offset account. Canonical values are:

  • Intnet
  • Sttl
  • Clerk
AcctType
The number or character that categorizes the AcctId.
ACHOffsetBalType

Defines the type of balance that is used for the offset account. Canonical values are:

  • Hold
  • BalChk
  • HoldBalChk
  • None
ACHOffsetDefType

Should the account be used as the default for offsets? Canonical values are:

  • true
  • false
BrCode
The branch code.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ACHTempExpsrArray_AType

ACHTempExpsrArray_AType is an array AType element. This is an array of ACH Temporary Exposure limits.

Contains:

  • ACHTempExpsrInfo_CType
ACHTempExpsrInfo_CType

ACHTempExpsrInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ACHExpsrDesc
The description given to ACH exposure.
ACHExpsrExpDt
The expiration date.
ACHExpsrStartDt
The date that designates the starting point for date selections.
ACHExpsrStatType

The status of the ACH exposure limits. Canonical values are:

  • Act
  • Inact

The default value is Act.

ACHTempExpsrAmt
The ACH exposure limit amount set.
ACHTempExpsrRsn
Application or user remarks free-form text.
OffCode
The code that designates the financial institution officer.
OffDesc
The officer short name.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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.

ACHCompModRs_MType

ACHCompModRs_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

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