Skip to main content

Class GetBatchByBatchNumberResponse


Properties

NAMETYPELENGTHDESCRIPTION
EntityIdintUnique identifier that is generated by EPS
LocationIdintUnique identifier generated by EPS for each location
LocationNamestringName assigned to the specific account/location.
BatchNumberstring40Unique identifier of the batch that is being requested
Descriptionstring50
TerminalNumberstring20Serial number of the terminal used to scan the batch of checks.
BatchStatusWSBatchStatusPossible responses are:
  • Open
  • Closed
  • Error
  • ReadyForProcessing
  • Rejected
  • Deleted
  • SentToTransactionProcessing
  • TPError (Transaction processing error)
  • NeedsBalancing
  • PartiallyProcessed
  • TPBatchCreationFailed
  • PartialDeposit
CreateDateTimeDateTimeThis element represents the date and time the batch was created.
CurrentStatusDateTimeDateTimeThis element represents the date and time the batch reached the current status.
ItemCountintThis element represents the number of items scanned in the batch. This is the same as the 'Your Count' field in the SmartPay Business.
ItemAmountDecimalThis element represents the total amount of all the items scanned in the batch. This is the same as the ‘Your Amount’ field displayed in the SmartPay Business.
TotalCountintThis element represents the number of items scanned in the batch that were recognized by the software. This is the same as the ‘Received Count’ field in the SmartPay Business.
TotalAmountDecimalThis element represents the total amount of all the items scanned in the batch that were recognized by the software. This is the same as the ‘Received Amount’ field displayed in the SmartPay Business.
ACHItemCountintThis element represents the total number of ACH items in the batch that will be deposited.
ACHTotalAmountDecimalThis element represents the total amount of the ACH items in the batch that will be deposited.
C21ItemCountintThis element represents the total number of Check21 items in the batch that will be deposited.
C21TotalAmountDecimalThis element represents the total amount of the Check21 items in the batch that will be deposited.
CreatedByUserNamestringThis element is the name of the person that created the batch.
NeedsAttentionbytePossible responses are:
  • 0 = N/A
  • 1 = Needs Attention
  • 2 = Does Not Need Attention
NeedsRescanbytePossible responses are:
  • 0 = N/A
  • 1 = Needs Rescan
  • 2 = Does Not Need Rescan
DepositSlipAuxOnUslongIf this option has been enabled, the value will be provided.
  • 0 = N/A

WSBatchStatus

NAMETYPEDESCRIPTION
Open0
Closed1
Error2
ReadyForProcessing4
Rejected5
Deleted8
SentToTransactionProcessing9
TPError10
NeedsBalancing12
PartiallyProcessed14
TPBatchCreationFailed15
PartialDeposit16

Examples

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBatchByBatchNumberResponse xmlns="https://ssl.selectpayment.com/">
<GetBatchByBatchNumberResult>
<EntityId>12345</EntityId>
<LocationId>102030</LocationId>
<LocationName>Accounts Payable</LocationName>
<BatchNumber>110</BatchNumber>
<Description>08:30:24.6558669 3/2/2011 Deposit</Description>
<TerminalNumber>9671245</TerminalNumber>
<BatchStatus>PartialDeposit</BatchStatus>
<CreateDateTime>2011-03-02T08:33:06.77</CreateDateTime>
<CurrentStatusDateTime>2011-03-02T08:45:26.33</CurrentStatusDateTime>
<ItemCount>3</ItemCount>
<ItemAmount>123.8000</ItemAmount>
<TotalCount>3</TotalCount>
<TotalAmount>123.8000</TotalAmount>
<ACHItemCount>1</ACHItemCount>
<ACHTotalAmount>51.4000</ACHTotalAmount>
<C21ItemCount>1</C21ItemCount>
<C21TotalAmount>25.0000</C21TotalAmount>
<CreatedByUserName>Jane</CreatedByUserName>
<NeedsAttention>2</NeedsAttention>
<NeedsRescan>2</NeedsRescan>
<DepositSlipAuxOnUs>0</DepositSlipAuxOnUs>
</GetBatchByBatchNumberResult>
</GetBatchByBatchNumberResponse>
</soap:Body>
</soap:Envelope>