Home > API General, Auto Pay, Payments > SWS ProcessManualAutoPay Method

SWS ProcessManualAutoPay Method


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.

  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: