Skip to main content

Class GetSettlementStatusRequest


Properties

NAMETYPELENGTHREQUIREDDESCRIPTION
storeIdlongYesUnique user ID generated by EPS.
storeKeystringYesUnique password generated by EPS.
OwnerEntityIdintYesUnique identifier that is generated by EPS.
WSActentryStatusWSActentryStatusYesAvailable fields that can be included in the report.

Valid values are:
  • ReturnedCancelled
  • SettlementCancelled
  • InProcess
  • All (Default)


Note: The API will only contain ReturnedCancelled, SettlementCancelled, InProcess and all. When “all” status is selected, we would be returning only these three statuses.
beginDateDateTimeYesThe date from which to start reporting batches.
endDateDateTimeYesThe last date for which batches should be reported, not to exceed a date range of 90 days.

WSActentryStatus

NAMETYPEDESCRIPTION
All0
InProcess1
ReturnedCancelled7
SettlementCancelled8

Examples

<GetSettlementStatus>
<MethodParameters>
<storeId>711042</storeId>
<storeKey>u4WgJael1nsviYH7kp1zw6gKRYUk</storeKey>
<ownerEntityId>233177</ownerEntityId>
<wsactentryStatus>All</wsactentryStatus>
<beginDate>7/2/2018 12:00:00 AM</beginDate>
<endDate>8/27/2018 3:06:00 PM</endDate>
</MethodParameters>
</GetSettlementStatus>