StartSession

Method

StartSession(StartSessionRequest)

Required? Yes

Overview: StartSession initiates a deposit session via single sign-on. It is imperative that mobile applications perform the StartSession request when the End-User selects the deposit menu.

Sequence Requirements: StartSession is the first method used to begin any new session.

note

Do not send fields as Null. All fields must be passed with a value or empty. Use basicHttpBinding, and don't use message security, but only transport level security (SSL).

It is important to note that if an End-User has multiple checks to deposit, the deposits should be completed within the same session. Do NOT call a new StartSession for each check. In some instances, depending on the Financial Institution's configuration, there may be a fee charged (not by Ensenta). For example, credit unions leveraging the Shared Branching network are charged for each member inquiry made to the network. Ensenta is required by the network to perform a member inquiry with each StartSession, so it is important to NOT call StartSession unnecessarily.

Parameters

TYPE	NAME	DESCRIPTION
StartSessionRequest	request

Returns

TYPE	DESCRIPTION
StartSessionResponse

Example Request

<StartSession>
 <request>
	<PartnerId>8257</PartnerId>
	<LanguageId>9</LanguageId>
	<DepositorIpAddress>203.0.113.0</DepositorIpAddress>
	<DeviceIdentifier>21d182e6-10b1-48e2-8c53-1b72674836c1</DeviceIdentifier>
	<LocalDateTime>2019-05-28T15:17:54.0000885-07:00</LocalDateTime>
	<TimeZone>PST -7:00 America/Redwood_Shores</TimeZone>
	<Attributes>
	   <Attribute>
		  <Name></Name>
		  <Value></Value>
	   </Attribute>
	</Attributes>
	<AccountHolderNumber>111222333</AccountHolderNumber>
	<AccountHolderName>Jane Doe</AccountHolderName>
	<Username>Jane2018</Username>
	<Email>example_1@example.com</Email>
	<Accounts>
	   <Account>
		  <AccountNumber>123456</AccountNumber>
		  <Description>Checking</Description>
		  <AccountTypeCode>1</AccountTypeCode>
		  <JointAccountHolderNames>
			 <string>John Doe</string>
			 <string>Amy Doe</string>
		  </JointAccountHolderNames>
		  <Tag>0</Tag>
	   </Account>
	   <Account>
		  <AccountNumber>654321</AccountNumber>
		  <Description>Line of Credit</Description>
		  <AccountTypeCode>32</AccountTypeCode>
		  <JointAccountHolderNames>
			 <string>John Doe</string>
		  </JointAccountHolderNames>
		  <Tag>1</Tag>
	   </Account>
	</Accounts>
	<AccountHolderAttributes>
	   <Attribute>
		  <Name>ECPhoneType</Name>
		  <Value>Android</Value>
	   </Attribute>
	   <Attribute>
		  <Name>ECPhoneOs</Name>
		  <Value>Android</Value>
	   </Attribute>
	   <Attribute>
		  <Name>ECPhoneOsVersion</Name>
		  <Value>Oreo 8.1</Value>
	   </Attribute>
	   <Attribute>
		  <Name>ECPartnerVersion</Name>
		  <Value>1.0</Value>
	   </Attribute>
	   <Attribute>
		  <Name>ECAppDeviceMake</Name>
		  <Value>Samsung</Value>
	   </Attribute>
	   <Attribute>
		  <Name>ECAppDeviceModel</Name>
		  <Value>Galaxy S9</Value>
	   </Attribute>
	</AccountHolderAttributes>
 </request>
</StartSession>

Example Response

<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>
	</StartSessionResult>
</StartSessionResponse>