GetSettlementStatus

Method

GetSettlementStatus(storeId, storeKey, ownerEntityId, wsactentryStatus, beginDate, endDate)

This Operation will generate a report based on settlement status. Although there are eight possible status types, this method request will focus on ReturnedCancelled, SettlementCancelled, InProcess or all (return only three listed statuses). The method will be executed at the Owning Entity level and will return results based on a specified merchant (Merchant ID) within the data range specified. Data will be retrieved as a data set. User must have the Settlement Report Permission enabled to execute this method.

Response will return all the transactions entry status which user has selected in the request for all the merchants of an owner entity within the provided data range.

Parameters

TYPE	NAME	DESCRIPTION
GetSettlementStatusRequest	request

Returns

TYPE	DESCRIPTION
GetSettlementStatusResponse

Example Request

<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>

Example Response

<GetSettlementStatus>
	<MethodParameters>
		<WSMoneyCenterSettlementArray>
			<WSMoneyCenterSettlementArray0>
				<EntityId>265126</EntityId>
				<EntityName>SOW Test Merchant</EntityName>
				<LocationId>1210026</LocationId>
				<LocationName>"CP Location1 LLC - 01"</LocationName>
				<EffectiveDate>8/17/2018 12:00:00 AM</EffectiveDate>
				<EntryStatus>ReturnedCancelled</EntryStatus>
				<Amount>-100.0000</Amount>
				<TransactionNumber>AuthTraW/Customer32-AB</TransactionNumber>
				<ReferenceNumber>T:CVLKV9HJA1</ReferenceNumber>
				<RCode isNull="false" />
			</WSMoneyCenterSettlementArray0>
			<WSMoneyCenterSettlementArray1>
				<EntityId>265126</EntityId>
				<EntityName>SOW Test Merchant</EntityName>
				<LocationId>1210026</LocationId>
				<LocationName>"CP Location1 LLC - 01"</LocationName>
				<EffectiveDate>8/17/2018 12:00:00 AM</EffectiveDate>
				<EntryStatus>InProcess</EntryStatus>
				<Amount>-100.0000</Amount>
				<TransactionNumber>AuthTraW/Customer33-AB</TransactionNumber>
				<ReferenceNumber>T:DVLKV9HJA1</ReferenceNumber>
				<RCode isNull="false" />
			</WSMoneyCenterSettlementArray1>
			<WSMoneyCenterSettlementArray2>
				<EntityId>265126</EntityId>
				<EntityName>SOW Test Merchant</EntityName>
				<LocationId>1210026</LocationId>
				<LocationName>"CP Location1 LLC - 01"</LocationName>
				<EffectiveDate>8/17/2018 12:00:00 AM</EffectiveDate>
				<EntryStatus>SettlementCancelled</EntryStatus>
				<Amount>-100.0000</Amount>
				<TransactionNumber>AuthTraW/Customer31-AB</TransactionNumber>
				<ReferenceNumber>T:BVLKV9HJA1</ReferenceNumber>
				<RCode isNull="false" />
			</WSMoneyCenterSettlementArray2>
		</WSMoneyCenterSettlementArray>
	</MethodParameters>
</GetSettlementStatus>