Account Sweep Inquiry
Account Sweep Inquiry
Account Sweep Inquiry is designed to allow the consumer to inquire upon an existing account sweep established on a service provider.
Message Flow
Account Sweep Inquiry involves the exchange of messages containing XML complex
MType data between the consumer and the service provider.
Primary Request
The consumer sends the AcctSweepInqRq_MType message to the service provider, containing the following
complex elements:
AccountId_CTypeCustom_CTypeMsgRqHdr_CType
Primary Response
The service provider returns the AcctSweepInqRs_MType message,
containing the following complex elements:
AcctSweepInqArray_ATypeCustom_CTypeMsgRsHdr_CType
Account Sweep Inquiry Business Case
The consumer is attempting to inquire upon an existing account sweep in this business case.
The consumer sends the AcctSweepInqRq_MType message to
the Service Provider with the following values:
The MsgRqHdr contains the standard
specifications.
| Complex Element | Simple Element | Entry Value |
|---|---|---|
AccountID | AcctId | 0002235555550015 |
AcctType | D |
The Service Provider returns AcctSweepInqRs_MType to the
consumer with the following values:
| Complex Element | Simple Element | Entry Value |
|---|---|---|
AcctSweepInqArray | ||
AcctSweepInqInfo | ||
MasterAccountId | AcctId | 0002235555550015 |
AcctType | D | |
MasterAcctInfo | MasterCeilBal | 10000.00 |
MasterFlrBal | 1000.00 | |
MasterFlrTgtBal | 1000.00 | |
MasterInvAcctId | 0000259122315678 | |
MasterInvAcctType | B |
Account Sweep Inquiry Behavior
The request requires that valid account identification be submitted.
The response returns all the sweep relationships that exist for the submitted account
identification in the request. For example, the account identification element in the request
may be returned in the response as a Master Account Identification,
MasterAccountId, and as a Sweep Account Identification,
SweepAcctId.
The response provides for two levels of arrays. The first level represents multiple responses for a specific Master Account Identification. The second-level array represents the Sweep Account Identifications related to the Master Account Identification returned in the first-level array. As stated, a single Master Account identification might have multiple sweep accounts that support the master account identification.
AcctSweepInqRq_MType
AcctSweepInqRq_MType is a message
MType element.
Contains:
AccountId_CTypeCustom_CTypeMsgRqHdr_CType
Simple Dictionary
- ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
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.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
AcctSweepInqRs_MType
AcctSweepInqRs_MType is a message
MType element.
Contains:
AcctSweepInqArray_ATypeCustom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
AcctSweepInqRs_MType, the
ActIntentKey can be used to modify the
MasterAccountId.- ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- ActIntentKey
- The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
AcctSweepInqArray_AType
AcctSweepInqArray_AType is an array AType element.
This is an array of elements for account sweep arrangements that are returned in the inquiry
service.
Contains:
AcctSweepInqInfo_CType
AcctSweepInqInfo_CType
AcctSweepInqInfo_CType is a complex
CType element.
Contains:
MasterAccountIdMasterAcctInfo_CTypeSweepAcctInqArray_AType
Simple Dictionary
- ActIntentKey
- The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
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
MasterAcctInfo_CType
MasterAcctInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- MasterCeilBal
- The maximum amount that should be maintained in the master account. This ceiling triggers a sweep transaction when the master account balance exceeds this target balance.
- MasterFlrBal
- The minimum amount that should be maintained in the master account. This floor triggers a sweep transaction when the master account balance goes below this target balance.
- MasterFlrTgtBal
- The balance that should be targeted for the master account when creating sweep transactions. Establishing a target balance reduces the number of sweep transactions that might need to occur under the sweep agreement.
- MasterInvAcctId
- The account identification for the investment account that might be established at a brokerage firm.
- MasterInvAcctType
- The account type for the investment account that might be established at a brokerage firm.
- MasterProcLvl
- The processing level assigned to a sweep arrangement. Used primarily when the master account could exist on other sweep arrangements and the consumer desires to set a prearranged order in which the sweep arrangements should process.
SweepAcctInqArray_AType
SweepAcctInqArray_AType is an array
AType element. This is an array of elements for the sweep
accounts that are returned in the inquiry service.
Contains:
SweepAcctInqInfo_CType
SweepAcctInqInfo_CType
SweepAcctInqInfo_CType is a complex
CType element.
Contains:
SweepAcctInfo_CType
Simple Elements
The following simple elements are contained within this complex.
SweepAcctInqInfo_CType, the
ActIntentKey can be used to modify the
SweetAcctId/SweetAcctType.- ActIntentKey
- The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
- SweepChgDesc
- The description of the code that describes the behavior for charging for sweep transactions.
- SweepClassDesc
- The description of the code that determines the classification of the sweep account.
- SweepFltXferDesc
- The description of the code that describes the behavior of transfer float values from the sweep to/from the master account.
- SweepNotDesc
- The description of the code that describes the behavior for printing sweep transaction notices.
- SweepPayoffDesc
- The description of the code that describes the behavior when the sweep account could be paid off by a sweep transaction.
- SweepResetDesc
- The description of the code that describes the behavior of resetting counts and values for the sweep account.
- SweepRstrDesc
- The description of the code that describes any sweep restrictions placed on the sweep account.
SweepAcctInfo_CType
SweepAcctInfo_CType is a complex
CType element.
Contains:
ApprvOffInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- 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.
- 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.
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_CTypeMsgRecInfoArray_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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.