Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Developer Account
Create a developer acccount to access resources that help you integrate with Jack Henry.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Hub
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and 3rd-party apps using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and 3rd-party apps 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.
Full List of APIs
Begin working with Jack Henry's public APIs to build financial applications today.
The security model enhancement for jXchange SOAP APIs begins on May 1st, 2025.
More info

Account Sweep Modification

Enterprise SOAP API > API by Reference > Core Services > Account Sweep Modification

Account Sweep Modification

Account Sweep Modification is designed to allow the consumer to delete and add additional account sweeps on a Service Provider.

Message Flow

Account Sweep Modification involves the exchange of messages containing XML complex data of type MType between the Third Party Consumer and the Service Provider.

Primary Request

The consumer sends the AcctSweepModRq_MType message containing the required MsgRqHdr_CType and MasterAccountId_CType complexes. The request can contain the optional ErrOvrRdinfoArray_AType array, SweepAcctModInfo_CType complex, MasterAcctInfo_CType complex, and Custom_CType complex along with the optional simple elements SweepAcctId, SweepAcctType, and Dlt.

Primary Response

The service provider returns the AcctSweepModRs_MType message to the consumer. The message contains the status of the request.

Account Sweep Modification Behavior

The Master Account Identification, MasterAccountId, is required for the modification service.

A request that provides only a Master Account Identification, MasterAccountId, and delete element, Dlt, that contains true conveys to the Service Provider to remove the Master Account Identification along with all of the Sweep Account Identifications directly related to the sweep arrangement.

A request that provides a Master Account Identification, MasterAccountId, a Sweep Account Identification, SweepAcctId, and the delete (Dlt) element that contains true conveys to the service provider to remove the singular relationship between the Master Account Identification and the Sweep Account Identification but retain the sweep arrangement for the Master Account Identification. However, if the sweep arrangement was a singular relationship between Master Account identification and Sweep Account Identification, this would warrant the deletion of the sweep arrangement.

Account Sweep Modification can be used to add Sweep Account Identifications for an already established sweep arrangement. However, the Sweep Account Identification cannot be modified. That requires a deletion of that specific sweep account identification.

Account Sweep Modification Business Case

The consumer is attempting to remove an existing sweep from an account in this example.

The consumer sends the AcctSweepModRq_MType message to the Service Provider with the following values:

The element MsgRqHdr contains the standard specifications.

Complex ElementSimple ElementEntry Value
MasterAccountIDAcctId0002235555550015
 AcctTypeD
 DltTrue

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

AcctSweepModRq_MType

AcctSweepModRq_MType is a message MType element.

Contains:

  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • MasterAccountId
  • MasterAcctInfo_CType
  • MsgRqHdr_CType
  • SweepAcctModInfo_CType

Simple Elements

The following simple elements are contained within this message.

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
SweepAcctId
The sweep account identification for the account that sweeps from and to the master account.
SweepAcctType
The sweep account type for the account that sweeps from and to the master account.

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.

MasterAccountId

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

MasterAccountId references AccountId_CType.

Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
Rstr
The level of restrictions that can exist at a parent and/or child node. Canonical values are:
  • Hid
  • NoAccess
  • NoAccessPart
  • ReadOnly
  • ReadOnlyPart
  • ReadWrite
  • ReadWritePart

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.

SweepAcctModInfo_CType

SweepAcctModInfo_CType is a complex CType element.

Contains:

  • ApprvOffInfoArray_AType

Simple Elements

The following simple elements are contained within this complex.

SweepBalType
The type of balance that should be used in determining if the sweep account can meet the sweep transaction request. Canonical values are:
  • Avl
  • Col
  • Ldgr
SweepCeilBal
The maximum amount that should be maintained in the sweep account. The amount that is swept from the master account does not exceed the sweep balance above the ceiling.
SweepChgAmt
The service charge amount that would be created for each sweep transaction created.
SweepChgCode
The code that describes the behavior for charging for sweep transactions.
SweepClassCode
The code that determines the classification of the sweep account.
SweepFlrBal
The minimum amount that should be maintained in the sweep account. The amount that is swept to the master account does not drop the balance of the sweep below the floor.
SweepFlrTgtBal
The balance that should be targeted for the sweep account when creating sweep transactions. Establishing a target balance reduces the number of sweep transactions that might need to occur under the sweep agreement.
SweepFltXferCode
The code that describes the behavior of transfer float values from the sweep to/from the master account.
SweepFromMasterIncrBal
The incremental amount that should be used when creating sweep transactions to the sweep account from the master account.
SweepFromMasterLvl
The processing order level assigned to the sweep account when the request is to sweep from the master account.
SweepNotCode
The code that describes the behavior for printing sweep transaction notices.
SweepPartType
The behavior when the sweep account can only transfer a partial amount to/from the master account. Canonical values are:
  • Both
  • From
  • To
SweepPayoffCode
The code that describes the behavior when the sweep account could be paid off by a sweep transaction.
SweepResetCode
The code that describes the behavior of resetting counts and values for the sweep account.
SweepRstrCode
The code that describes any sweep restrictions placed on the sweep account.
SweepToMasterIncrBal
The incremental amount that should be used when creating sweep transactions from the sweep account to the master account.
SweepToMasterLvl
The processing order level assigned to the sweep account when the request is to sweep to the master account.

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.

AcctSweepModRs_MType

AcctSweepModRs_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.
Did this page help you?
Last updated Thu Feb 8 2024