Home > Payments, Printing, Receipts > SWS viewReceiptPdf Method

SWS viewReceiptPdf Method


Provides a URL to view the requested document.

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.
PdfTemplateID Long Required
Description The receipt’s ID number. You are able to retrieve this ID using the LTR_TYPE_ID from the getReceiptTemplateInfo method.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
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.

Returned Parameters

Name DataType
TntPdfFilePath String
Description The file path to where the receipt is stored. Here is an example of what the receipt path might look like:

https://csiapp1.centershift.com/qa40/letters/
1000053626__1000305633_receipt.pdf

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

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

Here is a sample code of the request object:

// ViewReceiptPDF Request
request.SiteID = 123546;
request.AcctID = 123456;
request.TransactionID = 123456;
request.PdfTemplateID = 123456;

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.viewReceiptPdf(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: Payments, Printing, Receipts Tags: ,
  1. swsBecky
    April 6, 2017 at 7:47 am

    Updated March 8, 2013: Updated the code to wait for the the template field to become available to create a receipt. This should drastically reduce the number of “blank” receipts.

  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: