Class GetSessionInfoResponse
Properties
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| ResponseCode | String | Response status. For a successful response, the code will be '00'. A subset of possible response codes:
Note: There are many possible error response codes and the list will continue to grow over time. Whenever you receive a response code other than '00', your app should have a generic screen for handling errors where you can display the End-User facing text specific to the error response code provided in the LocalizedMessageText parameter below. | <ResponseCode>00</ResponseCode> |
| ErrorResponseText | String | If the ResponseCode value is not '00', ErrorResponseText will be populated with the name of the response code. This is a developer/app level description and is intended to be internal facing only. | <ErrorResponseText/> |
| LocalizedMessageText | String | If the ResponseCode value is not '00', LocalizedMessageText will be populated with messaging associated with the specific response code. The messaging for each error response code can be customized by the Financial Institution by request. This error message is intended to be external facing within the app. | <LocalizedMessageText/> |
| SessionToken | String | Ignore the value returned here. For all future requests in a session, use the SessionToken received in StartSession response. | <SessionToken> 32294621-bfc8-4fe8-98d1-865bd9ec1303 </SessionToken> |
| PartnerId | Integer | The Partner ID is a unique ID assigned by Ensenta specific to each setup within Ensenta's platform and will be different for each environment (UAT and Production). For more details, review the PartnerId parameter in Start Session request. | <PartnerId>8257</PartnerId> |
| ChannelTypeId | String | This should only be used internally and is purely informational. This is the Ensenta ID for the channel type the deposit was made through. For this integration, the value will always be '7'. | <ChannelTypeId>7</ChannelTypeId> |
| SessionInfo | SessionInfo | Contains the SessionInfo details. | <SessionInfo> ... </SessionInfo> |
SessionInfo
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| AccountKeys | AccountKey[] | Contains the AccountKeys details. | <AccountKeys> <AccountKey> <AccountNumberIndex>0</AccountNumberIndex> <Description>Checking</Description> <Tag>0</Tag> </AccountKey> <AccountKey> <AccountNumberIndex>1</AccountNumberIndex> <Description>Line Of Credit</Description> <Tag>1</Tag> </AccountKey> </AccountKeys> |
| IsTermsAcceptanceRequired | Boolean | Since GetSessionInfo is only being used to pull End-User facing limits, the value returned here can be ignored. The results will be same from the same named parameter within the StartSession Response. | <IsTermsAcceptanceRequired>false</IsTermsAcceptanceRequired> |
| IsIntroPageEnabled | Boolean | Note: Not applicable for mobile. Ignore values. | <IsIntroPageEnabled>false</IsIntroPageEnabled> |
| IsHelpEnabled | String | Note: Not applicable for mobile. Ignore values. | <IsHelpEnabled>false</IsHelpEnabled> |
| SkinCode | String | Note: Not applicable for mobile. Ignore values. | <SkinCode>155</SkinCode> |
| StartPage | String | Note: Not applicable for mobile. Ignore values. | <StartPage>3</StartPage> |
| ReceiptEmail | String | Since GetSessionInfo is only being used to pull End-User facing limits, the value returned here can be ignored. The results will be same from the same named parameter within the StartSession Response. | <ReceiptEmail>example_1@example.com</ReceiptEmail> |
| CustomizableMessages | CustomizableMessage[] | Contains the CutomizableMessages details. | <CustomizableMessages> <CustomizableMessage> <MessageTextCd>ECP288</MessageTextCd> <LocalizedText>$46412.94 | $50000.00</LocalizedText> </CustomizableMessage> </CustomizableMessages> |
| AreAcctPermissionsEnabled | Boolean | Note: Not applicable for mobile. Ignore values. | <AreAcctPermissionsEnabled>false</AreAcctPermissionsEnabled> |
| AcctPermissions | Int[] | Note: Not applicable for mobile. Ignore values. *AreAcctPermissionsEnabled *should return 'false' and the AcctPermissionsparameter will not be returned. | <AcctPermissions> <int>0</int> </AcctPermissions> |
| IssuerPolicy | IssuerPolicy[] | Note: Not applicable for mobile. Ignore values. Reference model links: | <IssuerPolicy> ... </IssuerPolicy> |
AccountKey
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| AccountNumberIndex | Integer | Since GetSessionInfo is only being used to pull End-User facing limits, the value returned here can be ignored. The results will be same from the same named parameter within the StartSession Response. | <AccountNumberIndex>0</AccountNumberIndex> |
| Description | String | Since GetSessionInfo is only being used to pull End-User facing limits, the value returned here can be ignored. The results will be same from the same named parameter within the StartSession Response. | <Description>Checking </Description> |
| Tag | String | Since GetSessionInfo is only being used to pull End-User facing limits, the value returned here can be ignored. The results will be same from the same named parameter within the StartSession Response. | <Tag>0</Tag> |
CustomizableMessage
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| MessageTextCd | String | Applicable dollar amount limits are passed back with specific MessageTextCd values that represent dollar amount limit periods. The limits themselves are configurable by the Financial Institution (FI) during implementation. There are two main formatting styles that are supported; we will work with you to define which style your app supports so we can configure it correctly for the FI: The simple approach is to only support ECP288 where Ensenta will look at all the applicable limits for the End-User and pass back the effective remaining amount limit (the limit that will be reached first) We can pass back each individual amount limit that is applicable to the End-User via ECP280, ECP282, ECP284, and ECP286. You may decide to run logic on your end and just display the limit that will be hit next or display all of the applicable limits to the End-User (listed or in a table). Note: If desired, we can support sending back both styles. Additional considerations: Important! Some FIs may opt to not enforce any limits in which case none of the MessageTextCd values below will be passed back. For FIs that are leveraging limits and if supporting ECP280, ECP282, ECP284, and ECP286 be aware that we may pass none of these, some of these, or all of these depending on what is applicable to the End-User (the FI may have some users that only have Business Day and Weekly limits setup while other users have all four limits setup).
| <MessageTextCd>ECP288</MessageTextCd> |
| LocalizedText | String | For the actual limits that we pass back, the associated verbiage we send back are configurable. We will work with you to define which formatting your app expects so we can configure it correctly for the FI. In the example formats below, be aware that %1 and %2 are dynamic parameters on our end where %1 is the configured limit amount and %2 is the amount remaining. Style 1 (just pass back values): %2 | %1 Style 2 (pass back full phrase): You have %2 left of your %1 deposit limit. Note: Your app should not allow the End-User to submit a deposit with an amount that would exceed the amount remaining of their limit(s). If the End-User does submit an amount that exceeds their limits, you will receive an error in the PostDepositBatch response | <LocalizedText>$46412.94 | $50000.00</LocalizedText> |
IssuerPolicy
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| IsPlainScannerAllowed | Note: Not applicable for mobile. Ignore values. | <IsPlainScannerAllowed>Y</IsPlainScannerAllowed> | |
| IsCheckScannerAllowed | Note: Not applicable for mobile. Ignore values. | <IsCheckScannerAllowed>N</IsCheckScannerAllowed> | |
| IsDepositDescrDisplayed | Note: Not applicable for mobile. Ignore values. | <IsDepositDescrDisplayed>N</IsDepositDescrDisplayed> | |
| IsMultChecksPerTxn | Note: Not applicable for mobile. Ignore values. | <IsMultChecksPerTxn>N</IsMultChecksPerTxn> | |
| IsHistoryAllowed | Note: Not applicable for mobile. Ignore values. | <IsHistoryAllowed>Y</IsHistoryAllowed> | |
| IsIntroEnabled | Note: Not applicable for mobile. Ignore values. | <IsIntroEnabled>N</IsIntroEnabled> | |
| IsHelpEnabled | Note: Not applicable for mobile. Ignore values. | <IsHelpEnabled>false</IsHelpEnabled> | |
| ImageCaptureMethod | Note: Not applicable for mobile. Ignore values. | <ImageCaptureMethod>-1</ImageCaptureMethod> | |
| IsBatchTotalAllowed | Note: Not applicable for mobile. Ignore values. | <IsBatchTotalAllowed>N</IsBatchTotalAllowed> | |
| IsDepositConfirmEnabled | Note: Not applicable for mobile. Ignore values. | <IsDepositConfirmEnabled>N</IsDepositConfirmEnabled> | |
| IsMicrDisplayEnabled | Note: Not applicable for mobile. Ignore values. | <IsMicrDisplayEnabled>N</IsMicrDisplayEnabled> | |
| IsPlainScannerOptional | Note: Not applicable for mobile. Ignore values. | <IsPlainScannerOptional>N</IsPlainScannerOptional> | |
| IsCheckScannerOptional | Note: Not applicable for mobile. Ignore values. | <IsCheckScannerOptional>N</IsCheckScannerOptional> | |
| IsDepositDescrOptional | Note: Not applicable for mobile. Ignore values. | <IsDepositDescrOptional>N</IsDepositDescrOptional> | |
| IsMultChecksPerTxnOptional | Note: Not applicable for mobile. Ignore values. | <IsMultChecksPerTxnOptional>N</IsMultChecksPerTxnOptional> | |
| IsIntroOptional | Note: Not applicable for mobile. Ignore values. | <IsIntroOptional>N</IsIntroOptional> | |
| IsHelpOptional | Note: Not applicable for mobile. Ignore values. | <IsHelpOptional>N</IsHelpOptional> | |
| IsImageCaptureMethodOptional | Note: Not applicable for mobile. Ignore values. | <IsImageCaptureMethodOptional>N</IsImageCaptureMethodOptional> | |
| IsBatchTotalOptional | Note: Not applicable for mobile. Ignore values. | <IsBatchTotalOptional>N</IsBatchTotalOptional> | |
| IsDepositConfirmOptional | Note: Not applicable for mobile. Ignore values. | <IsDepositConfirmOptional>N</IsDepositConfirmOptional> | |
| IsMicrDisplayOptional | Note: Not applicable for mobile. Ignore values. | <IsMicrDisplayOptional>N</IsMicrDisplayOptional> | |
| MaxCheckPerTxn | Note: Not applicable for mobile. Ignore values. | <MaxCheckPerTxn>1</MaxCheckPerTxn> | |
| IsSettingsEnabled | Note: Not applicable for mobile. Ignore values. | <IsSettingsEnabled>N</IsSettingsEnabled> | |
| CheckGuaranteeMethod | Note: Not applicable for mobile. Ignore values. | <CheckGuaranteeMethod>-1</CheckGuaranteeMethod> | |
| ImageCaptureTimeoutSeconds | Note: Not applicable for mobile. Ignore values. | <ImageCaptureTimeoutSeconds>30</ImageCaptureTimeoutSeconds> | |
| ScanMethods | Int[] | Note: Not applicable for mobile. Ignore values. | <ScanMethods/> |
| AlertMethods | AlertMethod[] | Note: Not applicable for mobile. Ignore values. | <AlertMethods> <AlertMethod AlertMethodId="1" IsRegisteredAddressUsed="Y" IsExtraAddressAllowed="Y" /> </AlertMethods> |
| TerminalFirmwareMinVersion | Note: Not applicable for mobile. Ignore values. | <TerminalFirmwareMinVersion/> | |
| TerminalFirmwareMaxVersion | Note: Not applicable for mobile. Ignore values. | <TerminalFirmwareMaxVersion/> | |
| TerminalConfigMinVersion | Note: Not applicable for mobile. Ignore values. | <TerminalConfigMinVersion/> | |
| TerminalConfigMaxVersion | Note: Not applicable for mobile. Ignore values. | <TerminalConfigMaxVersion/> |
AlertMethod
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| AlertMethod | This parameter is handled uniquely across this API and will contain parameters with values inline. Note: Not applicable for mobile. Ignore values. | <AlertMethod AlertMethodId="1" IsRegisteredAddressUsed="Y" IsExtraAddressAllowed="Y"/> |
Examples
<GetSessionInfoResponse>
<GetSessionInfoResult>
<ResponseCode>00</ResponseCode>
<ErrorResponseText/>
<LocalizedMessageText/>
<SessionToken>32294621-bfc8-4fe8-98d1-865bd9ec1303</SessionToken>
<PartnerId>8257</PartnerId>
<ChannelTypeId>7</ChannelTypeId>
<SessionInfo>
<AccountKeys>
<AccountKey>
<AccountNumberIndex>0</AccountNumberIndex>
<Description>Checking</Description>
<Tag>0</Tag>
</AccountKey>
<AccountKey>
<AccountNumberIndex>1</AccountNumberIndex>
<Description>Line Of Credit</Description>
<Tag>1</Tag>
</AccountKey>
</AccountKeys>
<IsTermsAcceptanceRequired>false</IsTermsAcceptanceRequired>
<IsIntroPageEnabled>false</IsIntroPageEnabled>
<IsHelpEnabled>false</IsHelpEnabled>
<SkinCode>155</SkinCode>
<StartPage>3</StartPage>
<ReceiptEmail>example_1@example.com</ReceiptEmail>
<CustomizableMessages>
<CustomizableMessage>
<MessageTextCd>ECP288</MessageTextCd>
<LocalizedText>$46412.94|$50000.00</LocalizedText>
</CustomizableMessage>
</CustomizableMessages>
<AreAcctPermissionsEnabled>false</AreAcctPermissionsEnabled>
<IssuerPolicy>
<IsPlainScannerAllowed>Y</IsPlainScannerAllowed>
<IsCheckScannerAllowed>N</IsCheckScannerAllowed>
<IsDepositDescrDisplayed>N</IsDepositDescrDisplayed>
<IsMultChecksPerTxn>Y</IsMultChecksPerTxn>
<IsHistoryAllowed>Y</IsHistoryAllowed>
<IsIntroEnabled>N</IsIntroEnabled>
<IsHelpEnabled>N</IsHelpEnabled>
<ImageCaptureMethod>-1</ImageCaptureMethod>
<IsBatchTotalAllowed>N</IsBatchTotalAllowed>
<IsDepositConfirmEnabled>N</IsDepositConfirmEnabled>
<IsMicrDisplayEnabled>N</IsMicrDisplayEnabled>
<IsPlainScannerOptional>N</IsPlainScannerOptional>
<IsCheckScannerOptional>N</IsCheckScannerOptional>
<IsDepositDescrOptional>N</IsDepositDescrOptional>
<IsMultChecksPerTxnOptional>N</IsMultChecksPerTxnOptional>
<IsIntroOptional>N</IsIntroOptional>
<IsHelpOptional>N</IsHelpOptional>
<IsImageCaptureMethodOptional>N</IsImageCaptureMethodOptional>
<IsBatchTotalOptional>N</IsBatchTotalOptional>
<IsDepositConfirmOptional>N</IsDepositConfirmOptional>
<IsMicrDisplayOptional>N</IsMicrDisplayOptional>
<MaxCheckPerTxn>99</MaxCheckPerTxn>
<IsSettingsEnabled>N</IsSettingsEnabled>
<CheckGuaranteeMethod>-1</CheckGuaranteeMethod>
<ImageCaptureTimeoutSeconds>30</ImageCaptureTimeoutSeconds>
<ScanMethods/>
<AlertMethods>
<AlertMethod AlertMethodId="1"
IsRegisteredAddressUsed="Y"
IsExtraAddressAllowed="Y"/>
</AlertMethods>
<TerminalFirmwareMinVersion/>
<TerminalFirmwareMaxVersion/>
<TerminalConfigMinVersion/>
<TerminalConfigMaxVersion/>
</IssuerPolicy>
</SessionInfo>
</GetSessionInfoResult>
</GetSessionInfoResponse>