SWS RollbackUnitTransfer Method
Allows you to cancel a transfer that has been initiated, but not completed, through the InitiateUnitTransfer method.
Parameters
Name | DataType | Is Required |
---|---|---|
OrgID | Long | Required |
Description | The organization’s ID number. | |
TransactionID | Long | Required |
Description | The transaction ID returned from the InitiateUnitTransfer method. |
Returned Parameters
Name | DataType |
---|---|
Succeeded | Boolean |
Description | Indicates if the rollback/void was successful (“True”) or not (“False”). |
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 RollbackUnitTransfer request object and a RollbackUnitTransfer response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.RollbackUnitTransfer_Request request = new SWS.RollbackUnitTransfer_Request();
SWS.RollbackUnitTransfer_Response response;
Here’s my sample code of the Request object.
// RollbackUnitTransfer Request
request.OrgID = 123456;
request.TransactionID = 123456;
Finally we can call the method and pass across the login object and the request object to perform our rollback. 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.