cancelScheduledPayment()

Payment cancelScheduledPayment(string paymentNumber)

This method cancels a payment.

Parameters

paymentNumber: Format: string; Purpose: Specifies the payment number to cancel.

Results

This method returns information about the payment that has been cancelled.

There are no messages defined by this method.

Example: A returned Payment XML document

This example shows a returned Payment XML document for payment number 21627930 which was given as a parameter and has been cancelled.

<Payment xmlns:ns2="http://xml.inomial.com/smile/2.xsd" xmlns:ns3="http://ws.inomial.com/smile.2">
  <PaymentNumber>21627930</PaymentNumber>
  <PaymentType>
    <Name>VISA</Name>
  </PaymentType>
  <Account>2142500947</Account>
  <Amount currency="AUD" formatted="$1.00">1.00</Amount>
  <Surcharge>
    <Amount currency="AUD" formatted="$0.00">0</Amount>
    <TaxAmount currency="AUD" formatted="$0.00">0</TaxAmount>
  </Surcharge>
  <Status>Cancelled</Status>
  <PaymentDetails>
    <AccountName Disclosure="Full">Test Visa</AccountName>
    <ExpiryDate Disclosure="Full">12/2017</ExpiryDate>
  </PaymentDetails>
  <ManuallyEntered>false</ManuallyEntered>
  <ManuallyDeclined>true</ManuallyDeclined>
  <AttemptCount>0</AttemptCount>
  <AttemptLogs/>
</Payment>

Faults

NoSuchItemException

This fault is returned when the specified payment number does not exist.

InvalidRequestException

This fault is returned when the payment is not in the 'Waiting' or 'Attention' status.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.CancelScheduledPayment paymentNumber

paymentNumber: Purpose: Specifies the payment number to cancel.

Note: For more information about the Java client and the options it accepts, see Java client syntax.