getPendingPayments()

PaymentListType getPendingPayments(string accountUsn)

This method returns a list of all pending payments, including scheduled payments set up from payment plans, for a particular account.

Parameters

accountUsn: Format: string; Purpose: Specifies the account USN.

Results

This method returns a list of all pending payments, including scheduled payments set up from payment plans, for a particular account USN.

There are no messages defined by this method.

Example: A returned PaymentListType XML document

This example shows a returned PaymentListType XML document when account USN 2142425772 is given as a parameter.

<PaymentList xmlns:ns2="http://xml.inomial.com/smile/2.xsd" xmlns:ns3="http://ws.inomial.com/smile.2">
  <Payment>
    <PaymentNumber>21437017</PaymentNumber>
    <PaymentType>
      <Name>Bill Buddy</Name>
    </PaymentType>
    <Account>2142425772</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-02-17T13:14:31.482+11:00</NextTransfer>
    <PaymentDetails>
      <AccountName Disclosure="Full">test</AccountName>
      <AccountNumber Disclosure="Hint">1234 34</AccountNumber>
      <ExpiryDate Disclosure="Full">12/2017</ExpiryDate>
    </PaymentDetails>
    <ManuallyEntered>true</ManuallyEntered>
    <ManuallyDeclined>false</ManuallyDeclined>
    <AttemptCount>0</AttemptCount>
    <AttemptLogs/>
  </Payment>
  <Payment>
    <PaymentNumber>21437009</PaymentNumber>
    <PaymentType>
      <Name>test.onlineGateway</Name>
    </PaymentType>
    <Account>2142425772</Account>
    <Amount currency="AUD" formatted="$4.00">4.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-02-19T00:00:00.000+11:00</NextTransfer>
    <PaymentDetails>
      <AccountName Disclosure="Full">Mr John Smith</AccountName>
      <ExpiryDate Disclosure="Full">2/2016</ExpiryDate>
    </PaymentDetails>
    <ManuallyEntered>false</ManuallyEntered>
    <ManuallyDeclined>false</ManuallyDeclined>
    <AttemptCount>0</AttemptCount>
    <AttemptLogs/>
  </Payment>
  <Payment>
    <PaymentNumber>21436985</PaymentNumber>
    <PaymentType>
      <Name>test.onlineGateway</Name>
    </PaymentType>
    <Account>2142425772</Account>
    <Amount currency="AUD" formatted="$2.00">2.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-02-19T00:00:00.000+11:00</NextTransfer>
    <PaymentDetails>
      <AccountName Disclosure="Full">Mr John Smith</AccountName>
      <ExpiryDate Disclosure="Full">2/2016</ExpiryDate>
    </PaymentDetails>
    <ManuallyEntered>false</ManuallyEntered>
    <ManuallyDeclined>false</ManuallyDeclined>
    <AttemptCount>0</AttemptCount>
    <AttemptLogs/>
  </Payment>
</PaymentList>

Faults

NoSuchItemException

This fault is returned when the specified USN does not correspond to an existing account.

Java client syntax

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

accountUsn: Purpose: Specifies the account USN.

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