Platform Status Inquiry
Platform Status Inquiry
Platform Status Inquiry is a jXchange messaging service designed for a third-party consumer to inquire about the status of the platform account to a service provider.
Message Flow
In jXchange, the Platform Status Inquiry service uses a typical exchange of
MType
messages for a
third-party consumer to inquire about the status of the platform account to a service
provider.
Primary Request
The consumer forwards the PltfmStatInqRq_MType
message to the
service provider containing the Platform Identification number.
The message contains the following simple element:
- PltfmId
The message contains the following complex element:
Custom_CType
The message contains the following message element:
MsgRqHdr_CType
Primary Response
The service provider returns the PltfmStatInqRs_MType
message to
the consumer.
The message contains the following simple elements:
- PltfmId
- PltfmStat
- PltfmStatDesc
The message contains the following complex elements:
AccountId_CType
Custom_CType
MsgRsHdr_CType
Platform Status Inquiry Behavior
The behavior of PltfmStatInq
.
The third-party consumer must submit the PltfmId
that was returned on the
PltfmAppAdd
response for a successful platform addition. This
requires the third-party consumer to store the platform identification for future
inquiries.
The service provider returns a third-party consumer friendly description of the status of the platform account. The service provider's status code is optional.
The service provider returns the account identification when the platform account status indicates that the request was moved from a staging status to an established account.
PltfmStatInqRq_MType
PltfmStatInqRq_MType
is a message
MType
element.
Contains:
Custom_CType
MsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- PltfmId
- The identification provided to a platform record that can be used for other services.
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 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 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 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.
PltfmStatInqRs_MType
PltfmStatInqRs_MType
is a message
MType
element.
Contains:
AccountId_CType
Custom_CType
MsgRsHdr_CType
PltfmAppTaskCatArray_AType
Simple Elements
The following simple elements are contained within this message.
- PltfmId
- The identification provided to a platform record that can be used for other services.
- PltfmStat
- The status that represents the state or condition of a platform record.
- PltfmStatDesc
- The description of the status that represents the state or condition of a platform record.
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.
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 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 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 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.
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.
PltfmAppTaskCatArray_AType
PltfmAppTaskCatArray_AType
is an array
AType
element. This element is an array of platform application tasks by
category.
Contains:
PltfmAppTaskCatInfo_CType
PltfmAppTaskCatInfo_CType
PltfmAppTaskCatInfo_CType
is a complex
CType
element.
Contains:
PltfmAppTaskRoleArray_AType
Simple Dictionary
- PltfmAppTaskCatCode
- The code that conveys to what category platform application tasks are assigned.
PltfmAppTaskRoleArray_AType
PltfmAppTaskRoleArray_AType
is an array
AType
element. This element is an array of platform application tasks by
role.
Contains:
PltfmAppTaskRoleInfo_CType
PltfmAppTaskRoleInfo_CType
PltfmAppTaskRoleInfo_CType
is a complex
CType
element.
Contains:
PltfmAppTaskArray_AType
Simple Dictionary
- PltfmAppTaskRoleCode
- The code that conveys to what role platform application tasks are assigned.
PltfmAppTaskArray_AType
PltfmAppTaskArray_AType
is an array
AType
element. This element is an array of platform application
tasks.
Contains:
PltfmAppTaskInfo_CType
PltfmAppTaskInfo_CType
PltfmAppTaskInfo_CType
is a complex
CType
element.
Simple Dictionary
- TaskName
- The name of a name value pair.
- TaskVal
- The value of a name value pair.
PltfmAppTaskInfo_CType
PltfmAppTaskInfo_CType
is a complex
CType
element.
Simple Dictionary
- TaskName
- The name of a name value pair.
- TaskVal
- The value of a name value pair.