Home > API General, Refunds, Services > SWS UpdateRefundStatus Method

SWS UpdateRefundStatus Method


Provides the ability to approve or deny a list of refunds which are pending approval.

Parameters

Name DataType Is Required
Note String Optional
Description The notes regarding why a refund was denied or approved.
RefundID Long Required
Description The refund request’s ID number.
RefundStatus RefundStatus Required
Description The status to which you are changing the refund request.
Available values:

  • PendingApproval
  • Approved
  • Denied
  • Processed
  • ReSet
  • CreditFail
  • SystemRefund
  • Cancelled
SiteId Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
RefundID Long
Description The refund request’s ID number that was updated.
Success Boolean
Description Indicates if the refund request was updated successfully (“True”) or if it failed (“False”).
Message String
Description The information describing what went wrong if the update failed.

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, an UpdateRefundStatus request object, and an UpdateRefundStatus response object. We can define and create those like this:

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

Here is a sample code of the request object:

// UdpateRefundStatus Request
request.PhoneId = 123456;
request.Phone = "800-555-1212";

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.UpdateRefundStatus(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.

Categories: API General, Refunds, Services Tags:
  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: