Overdraft Privilege History Search
Overdraft Privilege History Search is a jXchange service designed to provide Third Party Consumers with the historical activity that tracked the number of occasions of overdraft activity.
Message Flow
In jXchange, the Overdraft Privilege
History Search service uses a typical exchange of MType
messages to provide a
consumer with historical activity that tracked the number of occasions
over overdraft activity.
Primary Request
The Third Party Consumer forwards the
ODPrvlgHistSrchRq_MType
message to the Service Provider. The message contains:
Custom_CType
EndDt
InAcctId
SrchMsgRqHdr_CType
StartDt
If the request contains only a
StartDt
, all of the qualified Overdraft Privilege History
items with a date equal to and greater than the start date are
returned.
If the request contains only an EndDt
,
all of the qualified Overdraft Privilege History items with a date equal
to and less than the end date are returned.
If a
StartDt
and EndDt
are not used, then all
of the qualified Overdraft Privilege History items are
returned.
Primary Response
The Service Provider returns the
ODPrvlgHistSrchRs_MType
message to the Third Party Consumer. The message contains:
AccountId_CType
Custom_CType
EndDt
ODPrvlgAcctInfo_CType
ODPrvlgHistSrchArray_AType
SrchMsgRsHdr_CType
StartDt
Overdraft Privilege History Search Behavior
The Overdraft Privilege History Search service provides consumers with the historical activity that tracked the number of occasions of overdraft activity.
In order to do this, the InAcctId
element is required
in the request from the Third Party Consumer. The StartDt
and EndDt
elements are optional, but the qualified
Overdraft Privilege History items returned varies depending on what is or
is not entered.
The response is returned in last-in-first-out order. The response
contains information related to the ODPrvlgAcctInfo_CType
complex. The ODPrvlgCalArray_AType
array provides the
historical occurrence counters per each calendar month. The Service
Provider should return every month, if known, even if the count is zero.
This lets the Third Party Consumer know that a month did not have any
occurrence counters but was being tracked.
The ExclOdPrvlgRpt
element defaults to false.
The ODPrvlgCntReset
element defaults to false.
The ODPrvlgCntRevo
element defaults to false.
The CalMonth
element has no default value.
ODPrvlgHistSrchRq_MType
ODPrvlgHistSrchRq_MType
is a message
MType
element.
Contains:
Custom_CType
InAcctId
referencesAccountId_CType
SrchMsgRqHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- EndDt
- The date that designates the ending point for date selections.
- StartDt
- The date that designates the starting point for date selections.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
InAcctId
AccountId_CType
is a complex
CType
element. This element contains the incoming account
identification information and any restrictions.
InAcctId
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
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType
is a complex
CType
element. This is a
standard request message 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.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MaxRec
- The maximum number of records when multiple records are returned.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.
ODPrvlgHistSrchRs_MType
ODPrvlgHistSrchRs_MType
is a message
MType
element.
Contains:
AccountId_CType
Custom_CType
ODPrvlgAcctInfo_CType
ODPrvlgHistSrchArray_AType
SrchMsgRsHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- EndDt
- The date that designates the ending point for date selections.
- StartDt
- The date that designates the starting point for date selections.
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.
ODPrvlgAcctInfo_CType
ODPrvlgAcctInfo_CType
is a complex
CType
element.
Simple Elements
The simple elements contained within this complex are listed below.
- ODExmpAvlAmt
- The available balance amount of overdraft balances exempt from overdraft charges.
- ODExmpColAmt
- The collect balance amount of overdraft balances exempt from overdraft charges.
- ODExmpCurCnt
- The number of times items were exempt for overdraft charges for the current period.
- ODExmpLdgrAmt
- The ledger balance amount of overdraft balances exempt from overdraft charges.
- ODExmpPYTDCnt
- The number of times items were exempt for overdraft charges for the prior year-to-date period.
- ODExmpQTDCnt
- The number of times items were exempt for overdraft charges for the quarter-to-date period.
- ODExmpYTDCnt
- The number of times items were exempt for overdraft charges for the year-to-date period.
ODPrvlgHistSrchArray_AType
ODPrvlgHistSrchArray_AType
is an array AType
element. This is an array of responses for account identification overdraft
privilege activity.
Contains:
ODPrvlgHistSrchRec_CType
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType
is a complex
CType
element. It searches specific message response
headers.
Contains:
jXchangeHdr_CType
MsgRecInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MoreRec
- Indicates if there are more records that could be returned. Canonical values are:
- false
- true
- SentRec
- The number of records sent in the response.
- TotRec
- Indicates the total records the request selected, which could be larger than
MaxRec.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.