reschedulePaymentWithNewDetails()

Payment reschedulePaymentWithNewDetails(string paymentNumber, PaymentDetailsRequest request, date timestamp)

This method reschedules a payment to a specified time with specified new payment details, which can be either the latest added stored payment details of an account that this payment number belongs to or specific stored payment details.

Note: Payments can only be rescheduled if they are in Waiting, Declined or Attention status.

Parameters

paymentNumber: Format: string; Purpose: Specifies the payment number.
request: Format: PaymentDetailsRequest XML; Purpose: Defines a PaymentDetailsRequest XML document that specifies the payment details to reschedule the payment.
timestamp: Format: date; Purpose: (Optional) Specifies the time to which the payment will be rescheduled. If not specified, the next transfer date of the payment will be used.

Example: Request of latest stored payment details

This example shows a request of payment details, specified to use the latest stored payment details.

<PaymentDetailsRequest xmlns="http://xml.inomial.com/smile/2.xsd" xmlns:ns3="http://ws.inomial.com/smile.2">  
  <DefaultStoredPaymentDetails/>
</PaymentDetailsRequest>

Example: Request of specific stored payment details

This example shows a request of payment details, specified to use particular stored payment details.

<PaymentDetailsRequest xmlns="http://xml.inomial.com/smile/2.xsd" xmlns:ns3="http://ws.inomial.com/smile.2">
  <StoredPaymentDetailsId>fcb75c9b-1a68-4383-a07c-a8e451c98882</StoredPaymentDetailsId>
</PaymentDetailsRequest>

Results

This method returns information about a new payment that just has been rescheduled.

There are no messages defined by this method.

Example: A returned Payment XML document

This example shows a returned Payment XML document for new payment number 21628284 that just has been rescheduled from the payment number given as a parameter.

<Payment xmlns:ns2="http://xml.inomial.com/smile/2.xsd" xmlns:ns3="http://ws.inomial.com/smile.2">
  <PaymentNumber>21628284</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>Waiting</Status>
  <NextTransfer>2016-08-15T00:00:00.000+10:00</NextTransfer>
  <PaymentDetails>
    <AccountName Disclosure="Full">Test Visa</AccountName>
    <ExpiryDate Disclosure="Full">12/2017</ExpiryDate>
  </PaymentDetails>
  <ManuallyEntered>false</ManuallyEntered>
  <ManuallyDeclined>false</ManuallyDeclined>
  <AttemptCount>0</AttemptCount>
  <AttemptLogs/>
</Payment>

Faults

NoSuchItemException

This fault is returned when the specified payment number does not exist or the account has no stored payment details given as a parameter.

InvalidRequestException

This fault is returned when:

the payment is not in the 'Waiting' or 'Attention' status
there are no new payment details in paymentDetailsRequest
more than one payment details are given

Java client syntax

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

paymentNumber: Purpose: Specifies the payment number.
filename: Purpose: Defines the path to the PaymentDetailsRequest XML document.
timestamp: Purpose: (Optional) Specifies the time to which the payment will be rescheduled. If not specified, the next transfer date of the payment will be used.

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