Click or drag to resize

LoyaltyPartnerClientCancelSaleTransactionBatch Method

Cancel the processing of a queued batch of Transactions, from the submitted Batch RSN. A batch cannot be cancelled after it has been processed.

This method is a step in the workflow for Transaction File Batch submission.

Remarks
Transaction File Batch submission workflow:
  • Initialise Batch - call service: OpenSaleTransactionBatch
  • Submit Transaction File(s) - call service: LoadSaleTransactionBatch
  • Monitor submitted Transaction Batch Progress - call service: QuerySaleTransactionBatch
  • Stop The Transaction Batch Processing - call service: CancelSaleTransactionBatch
Syntax
C#
Copy
public ResultOfBatch CancelSaleTransactionBatch(
	ManagementGroupRequestOfguid request
)

Parameters

request
Type: LoyaltyServiceManagementGroupRequestOfguid

Return Value

Type: ResultOfBatch
Examples
C#
Copy
using (var svc = new LoyaltyService.LoyaltyPartnerClient())
{
  var request = new LoyaltyService.ManagementGroupRequestOfguid();
  request.Token = "Token";//Required - Token returned from AccountService.ManagementGroupLogin
  request.ManagementGroup = "Management group";//Required - ManagementGroup supplied when calling AccountService.ManagementGroupLogin
  request.Value = new Guid("8e523c44-1344-4f28-a7eb-012752451c44");;//Required - RSN of batch

  LoyaltyService.ResultOfBatch result = svc.CancelSaleTransactionBatch(request);

  if (result.FaultCode == 0)
  {
    //Request succeeded
  }
  else
  {
    //Request failed
    throw new Exception(result.FaultDescription);
  }
}
See Also