Archive

Posts Tagged ‘Payment’

SWS ReversePayment Method

May 25, 2011 Leave a comment

Reverses payments associated with a rental item. The given transaction will be reversed entirely, including payment on all rental items and retail items. Use the GetPreReversePayDetails method to determine what items are affected by the reversal and if it can be reversed based on the site rules.

Parameters

Name DataType Is Required
TranReversalInfo:AccountID Long Required
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
TranReversalInfo:DontCreditCard Boolean Optional
Description Indicates if the reversal should be sent back to the card (“False”) or if it should be reversed in Store but not have a credit go back to the card (“False”). This is used for externally processed cards, NSFs on debit card transactions and for charge-backs on cards due to disputes.
TranReversalInfo:RentalID Long Required
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
TranReversalInfo:TranDates TransactionDate Required
Description An array or TransactionDate objects, one for each transaction needing to be reversed.
TransactionDate:TranDate DateTime Required
Description The date of the occurrence for the transaction being reversed.
TransactionDate:TranID Long Required
Description The transaction ID that is being reversed.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
ErrorMessage String
Description Provides details as to why the reversal of the transaction failed.
ReversedTran Long
Description The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system.
ReversingTran Long
Description The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. A null or “0” response indicates the transaction failed.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to our objects.  We’ll need the standard service object, a ReversePayment request object and a ReversePayment response object. We will also need a TranReversalInfo object and a TransactionDate object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.ReversePayment_Request request = new SWS.ReversePayment_Request();
SWS.ReversePayment_Response response;

SWS.TranReversalInfo tranInfo = new SWS.TranReversalInfo();
SWS.TransactionDate tranData = new SWS.TransactionDate();

Here’s my sample code of the Request object.

// Request
tranData.TranID = 123456;
tranData.TranDate = new DateTime(2017, 3, 9);

tranInfo.AccountID = 123456;
tranInfo.RentalID = 123456;
tranInfo.TranDates = new SWS.TransactionDate [] { tranData };
tranInfo.DontCreditCard = false;

request.SiteID = 123456;
request.ReversalDetails =new SWS.TranReversalInfo[] { tranInfo };

Finally we can call the method and pass across the login object and the request object to reverse our payment. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  response = service.ReversePayment(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: Accounting, Payments, Void Tags: ,

SWS ProcessManualAutoPay Method

May 25, 2011 Leave a comment

Processes a manual autopay payment. The rental item must have an active credit card or ACH autopay account set up. You cannot prepay using autopay. This will pay any assessments that are outstanding on the rental item with a start date prior or equal to the current date.

Parameters

Name DataType Is Required
AcctID Long Required
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
RentalID Long Required
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
TranID Long
Description The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. A null or “0” response indicates the transaction failed.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to our objects.  We’ll need the standard service object, a ProcessManualAutoPay request object and a ProcessManualAutoPay response object.  We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.ProcessManualAutoPay_Request request = new SWS.ProcessManualAutoPay_Request();
SWS.ProcessManualAutoPay_Response response;

Here’s my sample code of the Request object.

// ProcessManualAutoPay Request
request.SiteID = 123456;
request.AcctID = 123456;
request.RentalID = 123456;

Finally we can call the method and pass across the login object and the request object to process our manual autopay payment. It’s a good idea to do this in a Try Catch block.

   ' Call the method that will load the response object
try
{
  response = service.ProcessManualAutoPay(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.

SWS VoidTransaction Method

Allows you to void a payment for a rental and/or retail items. A void can only be done the same day as the original transaction and prior to nightly processing.

Parameters

Name DataType Is Required
AccountID Long Required
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
AccountName String Required
Description The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account.
Amount Decimal Required
Description The amount of the payment to be voided.
Ledger LedgerType Optional
Description Indicates if the transaction was for rental or retail.
Available values:

  • Rental
  • Retail
OrgID Long Required
Description The organization’s ID number.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
TransactionDate DateTime Required
Description The date the transaction occurred. For a void transaction it must always have been done current day.
TransactionID Long Required
Description The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. If there is no transaction ID the transaction failed. The transaction ID is returned when any MakePayment method is used. It can also be retrieved using the GetRentalLedger method.

Returned Parameters

Name DataType
Successful Boolean
Description Indicates if the transaction was voided successfully (“True”) or not (“False”).

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects.  We will need the standard service object, a VoidTransaction request object, and a VoidTransaction response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.VoidTransaction_Request request = new SWS.VoidTransaction_Request();
SWS.VoidTransaction_Response response;

Here is a sample code of the request object:

// VoidTransaction Request
request.OrgID = 123456;
request.SiteID = 123546;
request.AccountID = 123456;
request.AccountName = "Doe, John";
request.Amount = 55.26m;
request.TransactionID = 123546;
request.TransactionDate = new DateTime(2016, 2, 3);
request.Ledger = SWS.LedgerType.Rental;

Finally we can call the method and pass across the login object and the request object to retrieve our requested information. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  response = service.VoidTransaction(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.

SWS GetTotalDuePastDue Method

May 23, 2011 1 comment

Retrieves the total amount due and the past due amount for a rental item, including the number of cycles past due. It works the same as the GetTotalDue SWS method with the exception that it requires each rental ID that you wish to include in the total. This will include all fees and services for the applicable past due and future amounts.

Parameters

Name DataType Is Required
AcctID Long Required
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
Cycles Integer Optional
Description The number of rental periods used to calculate the amount. If no cycle is passed in, it is assumed only one cycle should be included. The number of cycles starts from the PTD of the rental. You are limited to the number of cycles you can retrieve based on the ‘Allowed Number of Days Paid Ahead’ rule for the site. The rule information can be retrieved using the GetSiteRules and GetSiteRulesValue methods.
IsRetail Boolean Optional
Description Indicates that the total retrieved should be for retail assessment only (“True”) or if it should be for the rental assessments only (“False”).
IsRetailAndRental Boolean Optional
Description Indicates that the total retrieved should be for both the retail and the rental assessments on the account (“True”) or only for the rental assessments (“False”).
MoveOutDate DateTime Ignored
Description (Deprecated) The date the customer has indicated they will be moving out.
RentalID Long Required
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
PastDueCycles Decimal
Description The number of rental periods that must be paid to bring the account current.
PastDueTotal Decimal
Description The total amount due to bring the account current.
RequestedTotalDue Decimal
Description The total amount due for the requested number of rental periods.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to our objects.  We’ll need the standard service object, a GetTotalDue request object and a GetTotalDuePastDue response object.  We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetTotalDue_Request request = new SWS.GetTotalDue_Request();
SWS.GetTotalDuePastDue_Response response;

Here’s my sample code of the Request object.

// GetTotalDuePastDue Request
request.SiteID = 123456;
request.AcctID = 123456;
request.RentalID = new long[] { 123456 };
request.Cycles = new int[] { 1 };
request.IsRetail = false;
request.IsRetailAndRental = false;

Finally we can call the method and pass across the login object and the request object to retrieve the data. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  response = service.GetTotalDuePastDue(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.