ProBusinessTools


Click here for a complete list of operations.

RecurringBillingVoidPayment

Recurring Billing Module Users Only: This method will allow you to void a payment based on the payment number and payment date. This process cannot be undone.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /publicwebservices/probusinesstools.asmx HTTP/1.1
Host: secure.probusinesstools.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://secure.probusinesstools.com/publicWebServices/RecurringBillingVoidPayment"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RecurringBillingVoidPayment xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <VoidRequest>
        <StatementID>string</StatementID>
        <PaymentDate>dateTime</PaymentDate>
        <PaymentNumber>string</PaymentNumber>
        <AmountPaid>float</AmountPaid>
        <ChartOfAccountID>int</ChartOfAccountID>
        <CollectionAgent>string</CollectionAgent>
        <CustomerIDNumber>string</CustomerIDNumber>
        <PaymentType>None or Cash or Check or CreditCard or Credit or Void or DebitCard</PaymentType>
      </VoidRequest>
    </RecurringBillingVoidPayment>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RecurringBillingVoidPaymentResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <RecurringBillingVoidPaymentResult>
        <StatementList>
          <StatementIDList>
            <StatementID>string</StatementID>
            <StatementDate>string</StatementDate>
          </StatementIDList>
          <StatementIDList>
            <StatementID>string</StatementID>
            <StatementDate>string</StatementDate>
          </StatementIDList>
        </StatementList>
        <TotalAmountVoided>float</TotalAmountVoided>
        <ErrorMessage>string</ErrorMessage>
      </RecurringBillingVoidPaymentResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </RecurringBillingVoidPaymentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /publicwebservices/probusinesstools.asmx HTTP/1.1
Host: secure.probusinesstools.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RecurringBillingVoidPayment xmlns="http://secure.probusinesstools.com/publicWebServices">
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
      <VoidRequest>
        <StatementID>string</StatementID>
        <PaymentDate>dateTime</PaymentDate>
        <PaymentNumber>string</PaymentNumber>
        <AmountPaid>float</AmountPaid>
        <ChartOfAccountID>int</ChartOfAccountID>
        <CollectionAgent>string</CollectionAgent>
        <CustomerIDNumber>string</CustomerIDNumber>
        <PaymentType>None or Cash or Check or CreditCard or Credit or Void or DebitCard</PaymentType>
      </VoidRequest>
    </RecurringBillingVoidPayment>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RecurringBillingVoidPaymentResponse xmlns="http://secure.probusinesstools.com/publicWebServices">
      <RecurringBillingVoidPaymentResult>
        <StatementList>
          <StatementIDList>
            <StatementID>string</StatementID>
            <StatementDate>string</StatementDate>
          </StatementIDList>
          <StatementIDList>
            <StatementID>string</StatementID>
            <StatementDate>string</StatementDate>
          </StatementIDList>
        </StatementList>
        <TotalAmountVoided>float</TotalAmountVoided>
        <ErrorMessage>string</ErrorMessage>
      </RecurringBillingVoidPaymentResult>
      <wsKey>
        <Username>string</Username>
        <Password>string</Password>
        <loginErrorMessage>string</loginErrorMessage>
      </wsKey>
    </RecurringBillingVoidPaymentResponse>
  </soap12:Body>
</soap12:Envelope>