Skip to main content

Class GetAccountTransactionHistoryResponse

Properties​

NAMETYPELENGTHDESCRIPTIONEXAMPLES
ResponseCodeStringResponse status. For a successful response, the code will be “00”.

A subset of possible response codes:
  • E51 = Session Timeout
  • E500 = Invalid Parameter


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>
ErrorResponseTextStringIf 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/>
LocalizedMessageTextStringIf 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/>
TransactionListTransactionSummary[]Contains the TransactionList details.

Contains the TransactionSummary details.		<TransactionList>
<TransactionSummary> ... </TransactionSummary>
<TransactionSummary> ... </TransactionSummary>
</TransactionList>

TransactionSummary​

NAMETYPEDESCRIPTIONEXAMPLES
TransactionIdStringThe Transaction ID is a value that uniquely represents the deposited check. If attempting to retrieve the binarized (not the original uploaded) images of this check, you will need to send this value in the TransactionId parameter in the GetAccountTransactionCheckImage request.<TransactionId>
63a22672-b4cd-4ec3-bab4-2138d5d27602
</TransactionId>
TransactionDateDateTimeThe time the transaction was posted or initiated in PT time zone.<TransactionDate>
2018-08-08T09:15:00.737
</TransactionDate>
DescriptionStringDescription of the deposit if provided by the End-User. This may be empty.<Description>Birthday Check</Description>
ReceiptNumberIntegerReceipt number. This is only present if the deposit was successfully posted.

The Receipt Number is a value that uniquely represents the batch. If attempting to retrieve the binarized (not the original uploaded) images of a check from this batch, you will need to send this value in the ReceiptNumber parameter in the GetAccountTransactionCheckImage request.		<ReceiptNumber>82202042</ReceiptNumber>
SubmittedAmountDecimalAmount of the total transaction as submitted by the End-User. If displaying the amount within a receipt page, use CurrentAmount instead.

Note: For transaction history pulled for deposits made through this integration, while you would have passed “0” in the Amount parameter in the CreateDepositBatch request, the amount returned in this response will be the amount as handled in the AddDepositItem request and/or UpdateDepositItem request.		<SubmittedAmount>2.11</SubmittedAmount>
AdjustmentAmountDecimalThis is the amount the transaction was adjusted by when the Financial Institution (FI) manually reviewed the individual check(s).
  • A positive amount means the FI adjusted the SubmittedAmount value up during review.
  • If there is a negative amount, there are a couple of scenarios that are tied to the Status parameter below: 1) Status is “Approved”, and the amount was adjusted down during review. 2) Status is “Rejected”; the amount will be equal and opposite to the SubmittedAmount.
  • If the value is 0.00, there are a couple of scenarios that are tied to the Status parameter below: 1) Status is “Submitted”, and the check is pending review. 2) Status is “Approved”, and no adjustment was made.
<AdjustmentAmount>0.00</AdjustmentAmount>
CurrentAmountDecimalThis is the current amount of the transaction (CurrentAmount = SubmittedAmount + AdjustmentAmount)<CurrentAmount>2.11</CurrentAmount>
NumberOfChecksIntegerNumber of checks within the batch for the transaction.<NumberofChecks>1</NumberofChecks>
StatusStringStatus of the transaction. If planning to display the transaction status, instead use the StatusDescription parameter below.

Possible values include:
  • Submitted = All checks within the transaction have been submitted and are pending review by the Financial Institution (FI).
  • Approved = All checks within the transaction have been approved by the FI.
  • Rejected = All checks within the transaction have been rejected by the FI.
  • Split = The transaction contains multiple checks and have a mix if individual status’.
<Status>Submitted</Status>
AccountNumberStringThe account number into which the deposit is made. This number is masked.<AccountNumber>x3456</AccountNumber>
AccountHolderNumberStringWill be passed back empty.

Note: In the future the masked Account Holder Number will be passed back in this field. The integration should not enforce an empty value in this field. This field is normally internal only and is not exposed to the End-User.		<AccountHolderNumber/>
TransactionTypeStringThe transaction type associated with the transaction is based on the account type of the account the End-User selected and then subsequently submitted within the original CreateDepositBatch request in the DepositToAccountNumberIndex parameter.

Possible values include:
  • Deposit
  • Payment


Note: Going back to the StartSession where you original passed the AccountTypeCode value (see StartSession Request), the account types codes are handled as the following:
  • Deposit = 0, 1
  • Payment = 32, 64, 128, 256
<TransactionType>Deposit</TransactionType>
AcceptedByDescriptionStringThe name of the Financial Institution (FI) that accepted the deposit.

As noted in the beginning of GetAccountTransactionHistory, the FI may be leveraging shared history functionality and their name may be expressed slightly differently between their different products (i.e., Test Credit Union vs. TCU).		<AcceptedByDescription>
Test FI
</AcceptedByDescription>
ChannelTypeIntegerThis should only be used internally and is purely informational. This is the Ensenta ID for the channel type the deposit was made through.

As noted in the beginning of GetAccountTransactionHistory, for Financial Institutions (FI) that are sharing History between channels, you may see different IDs being used. Relevant channel types include:
  • 7 = Mobile (Could be for either Consumer or Business Mobile)
  • 8 = Convergence (Typically represents Consumer and Business desktop)
  • 10 = Partner ATM (not likely to see this, but may be possible in some circumstances)
<ChannelType>7</ChannelType>
ChannelTypeDescriptionStringThis is the description of the *ChannelType *above. The Financial Institution may customize the channel type description with Ensenta.

Common descriptions include:
  • Mobile
  • My Deposit (common for Consumer Desktop)
  • Merchant Capture (common for Business Desktop)
<ChannelTypeDescription>
Mobile
</ChannelTypeDescription>
StatusIdIntegerAn ID that identifies the status of the transaction:
  • 0 = Submitted
  • 1 = Approved
  • 2 = Rejected
  • 3 = Split


Note: Additional statuses may be added in future releases. Do not hard code to these values.		<StatusId>0</StatusId>
StatusDescriptionStringAs of today, this should match the value of the Status parameter from above. Future functionality may allow the Financial Institution to customize the status descriptions.

Status of the transaction. Default values include:
  • Submitted = All checks within the transaction have been submitted and are pending review by the Financial Institution (FI).
  • Approved = All checks within the transaction have been approved by the FI.
  • Rejected = All checks within the transaction have been rejected by the FI.
  • Split = The transaction contains multiple checks and have a mix if individual status’.
<StatusDescription>
Submitted
</StatusDescription>
StatusChangeDateDateTimeDate of most recent change made to transaction by the Financial Institution.<StatusChangeDate>
2018-08-08T09:15:00.737
</StatusChangeDate>
UsernameStringThis will be passed back empty.

Note: In the future, the Username of the End-User if provided in the StartSession (see StartSession Request) will be passed back in this field. The integration should not enforce an empty value and should be configurable so that once the Username is passed back, the mobile application can display it (see History for a UI example). This is important for mobile applications geared towards business End-Users.		<Username/>
DepositItemsDepositHistoryItem[]Contains the DepositItems details.

Contains the DepositHistoryItem details.		<DepositItems>
<DepositHistoryItem>
...
</DepositHistoryItem>
</DepositItems>
RedeemedDtTmDateTimeNote: Not applicable for Mobile Vendors. Ignore values.<RedeemedDtTm>
0001-01-01T00:00:00
</RedeemedDtTm>
PayerAccountNumberStringWill be passed back empty.<PayerAccountNumber/>
TransactionTypeIdIntegerLike the TransactionType parameter from above, this will identify the transaction as being either a Deposit or Payment transaction type.

Possible values:
  • 0 = Deposit
  • 3 = Payment
<TransactionTypeId>0</TransactionTypeId>

DepositHistoryItem​

NAMETYPEDESCRIPTIONEXAMPLES
ItemNumberIntegerThe number of the item within the batch as sent in the ItemNumber parameter in the original AddDepositItem request.<ItemNumber>1</ItemNumber>
CheckNumberStringThe Ensenta optical read of the item’s check number, if applicable (not all checks include a check number in the MICR).<CheckNumber>900024</CheckNumber>
AdjustmentAmountDecimalThis is the amount the check was adjusted by when the Financial Institution (FI) manually reviewed it.
  • A positive amount means the FI adjusted the SubmittedAmount value up during review.
  • If there is a negative amount, there are a couple of scenarios that are tied to the StatusId parameter below:
  • 1) StatusId is “1” and the amount was adjusted down during review.
  • 2) StatusId is “2”; the amount will be equal and opposite to the SubmittedAmount.
  • If the value is 0.00, there are a couple of scenarios that are tied to the StatusId parameter below:
  • 1) StatusId is “0” and the check is pending review.
  • 2) StatusId is “1” and no adjustment was made.
<AdjustmentAmount>0.00</AdjustmentAmount>
SubmittedAmountDecimalAmount of the check as submitted by the End-User. For more details, see AddDepositItem Request and UpdateDepositItems Request.<SubmittedAmount>2.11</SubmittedAmount>
CurrentAmountDecimalThis is the current amount of the check (CurrentAmount = SubmittedAmount + AdjustmentAmount)<CurrentAmount>2.11</CurrentAmount>
StatusDescriptionStringStatus of the transaction. Default values include:
  • Submitted = All checks within the transaction have been submitted and are pending review by the Financial Institution (FI).
  • Approved = All checks within the transaction have been approved by the FI.
  • Rejected = All checks within the transaction have been rejected by the FI.
<StatusDescription>
Submitted
</StatusDescription>
Check21ReturnReasonDescriptionStringWhen the Financial Institution (FI) manually reviews a check and decides to reject it (*StatusID *of “2”), the FI will choose what is called a return reason which is typically displayed to End-Users when viewing history.

For checks with a *StatusID *of “0” or “1”, the value returned for this parameter will be “Not Applicable / Other” and is not intended to be displayed to the End-User.		<Check21ReturnReasonDescription>
Not Applicable / Other
</Check21ReturnReasonDescription>
StatusIdIntegerAn ID that identifies the status of the check:
  • 0 = Submitted
  • 1 = Approved
  • 2 = Rejected
<StatusId>0</StatusId>

Examples​

<GetAccountTransactionHistoryResponse>
	<GetAccountTransactionHistoryResult>
		<ResponseCode>00</ResponseCode>
		<ErrorResponseText/>
		<LocalizedMessageText/>
		<TransactionList>
			<TransactionSummary>
				<TransactionId>329cb675-9604-46cc-9f20-8692b353dd68</TransactionId>
				<TransactionDate>2018-08-03T08:10:50.843</TransactionDate>
				<Description>Birthday Check</Description>
				<ReceiptNumber>23527</ReceiptNumber>
				<SubmittedAmount>512.79</SubmittedAmount>
				<AdjustmentAmount>0.00</AdjustmentAmount>
				<CurrentAmount>512.79</CurrentAmount>
				<NumberofChecks>1</NumberofChecks>
				<Status>Submitted</Status>
				<AccountNumber>x3456</AccountNumber>
				<AccountHolderNumber/>
				<TransactionType>Deposit</TransactionType>
				<AcceptedByDescription>Test FI</AcceptedByDescription>
				<ChannelType>7</ChannelType>
				<ChannelTypeDescription>Mobile</ChannelTypeDescription>
				<StatusId>0</StatusId>
				<StatusDescription>Submitted</StatusDescription>
				<StatusChangeDate>2018-08-03T08:10:50.843</StatusChangeDate>
				<Username/>
				<DepositItems>
					<DepositHistoryItem>
						<ItemNumber>1</ItemNumber>
						<CheckNumber>1402</CheckNumber>
						<AdjustmentAmount>0.00</AdjustmentAmount>
						<SubmittedAmount>512.79</SubmittedAmount>
						<CurrentAmount>512.79</CurrentAmount>
						<StatusDescription>Submitted</StatusDescription>
						<Check21ReturnReasonDescription>Not Applicable / Other</Check21ReturnReasonDescription>
						<StatusId>0</StatusId>
					</DepositHistoryItem>
				</DepositItems>
				<RedeemedDtTm>0001-01-01T00:00:00</RedeemedDtTm>
				<PayerAccountNumber/>
				<TransactionTypeId>0</TransactionTypeId>
			</TransactionSummary>
			<TransactionSummary>
				<TransactionId>cfc59924-d7cd-46ff-9726-6368064475f5</TransactionId>
				<TransactionDate>2018-07-07T17:04:44.05</TransactionDate>
				<Description/>
				<ReceiptNumber>22880</ReceiptNumber>
				<SubmittedAmount>450.00</SubmittedAmount>
				<AdjustmentAmount>0.00</AdjustmentAmount>
				<CurrentAmount>450.00</CurrentAmount>
				<NumberofChecks>2</NumberofChecks>
				<Status>Submitted</Status>
				<AccountNumber>x3456</AccountNumber>
				<AccountHolderNumber/>
				<TransactionType>Deposit</TransactionType>
				<AcceptedByDescription>Test FI</AcceptedByDescription>
				<ChannelType>8</ChannelType>
				<ChannelTypeDescription>Merchant Capture</ChannelTypeDescription>
				<StatusId>0</StatusId>
				<StatusDescription>Submitted</StatusDescription>
				<StatusChangeDate>2018-07-07T17:04:44.05</StatusChangeDate>
				<Username>bakerymanager</Username>
				<DepositItems>
					<DepositHistoryItem>
						<ItemNumber>1</ItemNumber>
						<CheckNumber>0535</CheckNumber>
						<AdjustmentAmount>0.00</AdjustmentAmount>
						<SubmittedAmount>350.00</SubmittedAmount>
						<CurrentAmount>350.00</CurrentAmount>
						<StatusDescription>Submitted</StatusDescription>
						<Check21ReturnReasonDescription>Not Applicable / Other</Check21ReturnReasonDescription>
						<StatusId>0</StatusId>
					</DepositHistoryItem>
					<DepositHistoryItem>
						<ItemNumber>2</ItemNumber>
						<CheckNumber>0548</CheckNumber>
						<AdjustmentAmount>0.00</AdjustmentAmount>
						<SubmittedAmount>100.00</SubmittedAmount>
						<CurrentAmount>100.00</CurrentAmount>
						<StatusDescription>Submitted</StatusDescription>
						<Check21ReturnReasonDescription>Not Applicable / Other</Check21ReturnReasonDescription>
						<StatusId>0</StatusId>
					</DepositHistoryItem>
				</DepositItems>
				<RedeemedDtTm>0001-01-01T00:00:00</RedeemedDtTm>
				<PayerAccountNumber/>
				<TransactionTypeId>0</TransactionTypeId>
			</TransactionSummary>
		</TransactionList>
	</GetAccountTransactionHistoryResult>
</GetAccountTransactionHistoryResponse>