Class PostDepositBatchResponse
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/> |
| TransactionSummary | TransactionSummary | Contains the Transaction Summary details. The contents of *TransactionSummary *are often used to display details within a receipt page within the app. The parameters listed below will largely match with the GetAccountTransactionHistory request used to optionally display the End-User’s transaction history, but many will have static values at this stage of the transaction. For more details, see GetAccountTransactionHistory Response. | <TransactionSummary> ... </TransactionSummary> |
TransactionSummary
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| TransactionId | String | Unique Transaction ID. This is intended to be internal facing only. | <TransactionId> 63a22672-b4cd-4ec3-bab4-2138d5d27602 </TransactionId> |
| TransactionDate | DateTime | The time the PostDepositBatch request was received in PT time zone. | <TransactionDate> 2018-08-08T09:15:00.737 </TransactionDate> |
| Description | String | The description provided by the End-User (if applicable/available) as originally sent in the Description parameter from the CreateDepositBatch request. | <Description>Birthday Check</Description> |
| ReceiptNumber | Integer | The Receipt Number is a value that uniquely represents the batch. This value is intended to be End-User facing. | <ReceiptNumber>82202042</ReceiptNumber> |
| SubmittedAmount | Decimal | Amount of the total transaction as submitted by the End-User. If displaying the amount within a receipt page, use *CurrentAmount *instead. For more details, see AddDepositItem Request and UpdateDepositItems Request. | <SubmittedAmount>2.11</SubmittedAmount> |
| AdjustmentAmount | Decimal | For this step in the transaction, this value will be “0.00”, ignore. | <AdjustmentAmount>0.00</AdjustmentAmount> |
| CurrentAmount | Decimal | Will always match the SubmittedAmount value. If displaying the amount within a receipt page, display this amount. | <CurrentAmount>2.11</CurrentAmount> |
| NumberOfChecks | Integer | This has been deprecated. Ignore values returned here as they may not match with the number of checks submitted in the request. | <NumberofChecks>1</NumberofChecks> |
| Status | String | For this step in the transaction, this value will be “Submitted”. | <Status>Submitted</Status> |
| AccountNumber | String | The account number into which the deposit is made. This number is masked. | <AccountNumber>x3456</AccountNumber> |
| AccountHolderNumber | String | Will be passed back empty. | <AccountHolderNumber/> |
| TransactionType | String | The 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:
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:
| <TransactionType>Deposit</TransactionType> |
| AcceptedByDescription | String | The name of the Financial Institution (FI) that accepted the deposit. | <AcceptedByDescription> Test FI </AcceptedByDescription> |
| ChannelType | Integer | 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 only value that will be returned is “7”.
| <ChannelType>7</ChannelType> |
| ChannelTypeDescription | String | This is the description of the *ChannelType *above. The Financial Institution (FI) may customize the channel type description with Ensenta. For this integration, typically the FI leaves the description as “Mobile”, but they may decide to customize to specify Consumer or Business Mobile. | <ChannelTypeDescription> Mobile </ChannelTypeDescription> |
| StatusId | Integer | An ID that identifies the status of the transaction. For this step in the transaction, this value will be “0” for Submitted. | <StatusId>0</StatusId> |
| StatusDescription | String | For this step in the transaction, this value will be “Submitted”.
| <StatusDescription> Submitted </StatusDescription> |
| StatusChangeDate | DateTime | Date of most recent change made to transaction by the Financial Institution. For this step in the transaction, this value will just reflect when the PostDepositBatch request was received by Ensenta. | <StatusChangeDate> 2018-08-08T09:15:00.737 </StatusChangeDate> |
| Username | String | This 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/> |
| DepositItems | DepositHistoryItem[] | Contains the DepositItems details. Contains the DepositHistoryItem details. For this integration, there should only be the single instance of the *DepositHitoryItem *object at this stage of the transaction. | <DepositItems> <DepositHistoryItem> ... </DepositHistoryItem> </DepositItems> |
| RedeemedDtTm | DateTime | Note: Not applicable for Mobile Vendors. Ignore values. | <RedeemedDtTm> 0001-01-01T00:00:00 </RedeemedDtTm> |
| PayerAccountNumber | String | Will be passed back empty. | <PayerAccountNumber/> |
| TransactionTypeId | Integer | Like the TransactionType parameter from above, this will identify the transaction as being either a Deposit or Payment transaction type. Possible values:
| <TransactionTypeId>0</TransactionTypeId> |
DepositHistoryItem
| NAME | TYPE | DESCRIPTION | EXAMPLES |
|---|---|---|---|
| ItemNumber | Integer | The number of the item within the batch as sent in the ItemNumber parameter in the original AddDepositItem request. For this integration, the value will be “1”. | <ItemNumber>1</ItemNumber> |
| CheckNumber | String | The Ensenta optical read of the item’s check number, if applicable (not all checks include a check number in the MICR). | <CheckNumber>900024</CheckNumber> |
| AdjustmentAmount | Decimal | For this step in the transaction, this value will be “0.00”. | <AdjustmentAmount>0.00</AdjustmentAmount> |
| SubmittedAmount | Decimal | Amount of the check as submitted by the End-User. For more details, see AddDepositItem Request and UpdateDepositItems Request. | <SubmittedAmount>2.11</SubmittedAmount> |
| CurrentAmount | Decimal | This is the current amount of the check (CurrentAmount = SubmittedAmount + AdjustmentAmount). For this step in the transaction, this value will match the SubmittedAmount. | <CurrentAmount>2.11</CurrentAmount> |
| StatusDescription | String | For this step in the transaction, this value will always be “Submitted”. | <StatusDescription> Submitted </StatusDescription> |
| Check21ReturnReasonDescription | String | For this step in the transaction, this value will always be “Not Applicable / Other”. | <Check21ReturnReasonDescription> Not Applicable / Other </Check21ReturnReasonDescription> |
| StatusId | Integer | An ID that identifies the status of the check. For this step in the transaction, this value will be “0” for Submitted. | <StatusId>0</StatusId> |
Examples
<PostDepositBatchResponse>
<PostDepositBatchResult>
<ResponseCode>00</ResponseCode>
<ErrorResponseText/>
<LocalizedMessageText/>
<TransactionSummary>
<TransactionId>9f189395-620d-4c08-9e3e-b37f39b85f0c</TransactionId>
<TransactionDate>2018-08-08T08:46:00.53</TransactionDate>
<Description>Birthday Check</Description>
<ReceiptNumber>82202037</ReceiptNumber>
<SubmittedAmount>2.11</SubmittedAmount>
<AdjustmentAmount>0.00</AdjustmentAmount>
<CurrentAmount>2.11</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-08T08:46:00.53</StatusChangeDate>
<Username/>
<DepositItems>
<DepositHistoryItem>
<ItemNumber>1</ItemNumber>
<CheckNumber>900024</CheckNumber>
<AdjustmentAmount>0.00</AdjustmentAmount>
<SubmittedAmount>2.11</SubmittedAmount>
<CurrentAmount>2.11</CurrentAmount>
<StatusDescription>Submitted</StatusDescription>
<Check21ReturnReasonDescription>Not Applicable / Other</Check21ReturnReasonDescription>
<StatusId>0</StatusId>
</DepositHistoryItem>
</DepositItems>
<RedeemedDtTm xsi:nil="true"/>
<PayerAccountNumber/>
<TransactionTypeId>0</TransactionTypeId>
</TransactionSummary>
</PostDepositBatchResult>
</PostDepositBatchResponse>