Class StartSessionResponse

---

Properties

NAME	TYPE	DESCRIPTION	EXAMPLES
ResponseCode	String	Response status. For a successful response, the code will be '00'. One of the more common error response codes experienced at the StartSession response is 'E12' which means that no eligible accounts were found after applying account eligibility controls configured on the Ensenta side or that no accounts were sent in the request. See the AccountKeys parameter below for more details on account eligibility. A subset of other possible response codes: E51 = Session Timeout E500 = Invalid Parameter E97 = Institution Out of Service E77 = Denylisted E78 = Not on Allowlist 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	The value returned in this StartSession response is the session token that you will need to send in the SessionToken parameter for any future requests done within this session.	<SessionToken> 7bdb9860-dcd5-4f75-8629-61c8d18cbfed </SessionToken>
SessionStateId	String	The value returned is the session state ID that you will need to send in the SessionStateID parameter for any future requests done within this session.	<SessionStateId> 00f4a870-6e5b-4163-86ce-b4e80acfddfb </SessionStateId>
SessionInfo	SessionInfo	Contains the SessionInfo details. Reference model links: AccountKey CustomizableMessage IssuerPolicy	<SessionInfo> ... </SessionInfo>
MiSnapLicense	Base64 String	This element will only be present in the StartSession response if there is a valid MiSnap License Key listed for the PartnerId setup on the Ensenta platform. Otherwise, it will not appear in the response.	<MiSnapLicense> Base64 String </MiSnapLicense>

SessionInfo

NAME	TYPE	DESCRIPTION	EXAMPLES
AccountKeys	AccountKey[]	Contains the AccountKeys details. As outlined in the StartSession request for the Accounts parameter, Ensenta will compare the list of accounts sent from the request and enforce any account eligibility controls configured on the Ensenta side for the Financial Institution (FI) and return the eligible accounts in the following array. There are two forms of account eligibility that Ensenta applies: For all FIs: Ensenta will enable allowed account types defined by the FI during the initial implementation which match back to the AccountTypeCode values presented for each account within the StartSession request. For Credit Unions posting in real time via Shared Branching: Upon receiving the StartSession request, Ensenta will reach out to the FI's core system over a third-party vendor named CO-OP via their connection to the core; CO-OP refers to this connection to the core as the Shared Branching Network. The FI's core will return to Ensenta a list of accounts that are marked as eligible to make deposits to over this network and Ensenta will only return the accounts to you where the AccountNumber and AccountTypeCode from the StartSession request match with what was sent by the core. Reach out to your Ensenta PM if there are any questions regarding how account eligibility is enforced on the Ensenta side.	<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	If terms of service are being leveraged with Ensenta and this value is returned as 'true', make sure to call GetTerms to retrieve the terms of service text to be presented to the End-User and subsequently the AcceptTerms method if the End-User accepts the terms.	<IsTermsAcceptanceRequired>true</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	If being leveraged, the Email last used to send an email receipt for this account holder. See the Email parameter from StartSession Request.	<ReceiptEmail>example_1@example.com</ReceiptEmail>
CustomizableMessages	CustomizableMessage[]	Contains the CustomizableMessages 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[]	This will not be returned if the value returned in the AreAcctPermissionsEnabled parameter above is 'false'. Note: Not applicable for mobile. Ignore values.	<AcctPermissions> <int>0</int> </AcctPermissions>
IssuerPolicy	IssuerPolicy[]	Note: Not applicable for mobile. Ignore values. Reference model links: AlertMethod	<IssuerPolicy> ... </IssuerPolicy>

AccountKey

NAME	TYPE	DESCRIPTION	EXAMPLES
AccountNumberIndex	Integer	Ensenta does not pass back the AccountNumber as passed in the StartSession request and instead assigns an index number that you will use to represent the account the End-User selects to deposit into when you submit the CreateDepositBatch request in the DepositToAccountNumberIndex parameter. The accounts are zero-indexed, so first the index number for the first account in the array is 0, second is 1, etc.	<AccountNumberIndex>0</AccountNumberIndex>
Description	String	Description/name of account. This will pass back the description as sent in the StartSession request in the Description parameter but will remove the word 'account' and will append the masked account number if there are any duplicate descriptions.	<Description>Checking</Description>
Tag	String	This will be the same value as was passed in the Tag parameter for this account within the StartSession request.	<Tag>0</Tag>

CustomizableMessage

NAME	TYPE	DESCRIPTION	EXAMPLES
MessageTextCd	String	Ignore values returned here and instead look at the CustomizableMessages parameter within the GetSessionInfo request.	<MessageTextCd>ECP288</MessageTextCd>
LocalizedText	String	Ignore values returned here and instead look at the CustomizableMessages parameter within the GetSessionInfo request.	<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

<StartSessionResponse>
	<StartSessionResult>
		<ResponseCode>00</ResponseCode>
		<ErrorResponseText/>
		<LocalizedMessageText/>
		<SessionToken>7bdb9860-dcd5-4f75-8629-61c8d18cbfed</SessionToken>
		<SessionStateId>00f4a870-6e5b-4163-86ce-b4e80acfddfb</SessionStateId>
		<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>true</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>
		<MiSnapLicense> Base64 string </MiSnapLicense>
	</StartSessionResult>
</StartSessionResponse>