getPayment()

Payment getPayment(string paymentNumber)

This method returns information about a payment for a specified payment number. If the payment returned is in waiting status, its next transfer timestamp will be populated.

Parameters

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

Results

This method returns information about a payment for a particular payment number.

There are no messages defined by this method.

Example: Payment XML document for a payment number that is a pending payment

This example shows a returned Payment XML document when payment number 21578596 is given as a parameter and it is a pending payment.

<Payment xmlns="http://xml.inomial.com/smile/2.xsd"
 xmlns="http://ws.inomial.com/smile.2">
  <PaymentNumber>21578596</PaymentNumber>
  <PaymentType>
    <Name>VISA</Name>
  </PaymentType>
  <Account>2142421094</Account>
  <Amount formatted="$1.00" currency="AUD">1.00</Amount> 
  <Surcharge>
    <Amount formatted="$0.00" currency="AUD">0</Amount>
    <TaxAmount formatted="$0.00" currency="AUD">0</TaxAmount> 
  </Surcharge>
  <Status>Waiting</Status> 
  <NextTransfer>2014-08-06T10:28:46.703+10:00</NextTransfer>
</Payment>

Example: Payment XML document for a payment number that is not a pending payment

This example shows a returned Payment XML document when payment number 21578612 is given as a parameter and it is not a pending payment.

<Payment xmlns="http://xml.inomial.com/smile/2.xsd" 
 xmlns="http://ws.inomial.com/smile.2">
  <PaymentNumber>21578612</PaymentNumber> 
  <PaymentType>
    <Name>Cash</Name>
  </PaymentType>
  <Account>2142421094</Account>
  <Amount formatted="$109.00" currency="AUD">109.00</Amount>
  <Surcharge>
    <Amount formatted="$0.00" currency="AUD">0</Amount>
    <TaxAmount formatted="$0.00" currency="AUD">0</TaxAmount>
  </Surcharge>
  <Status>Accepted</Status>
</Payment>

Faults

NoSuchItemException

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

Java client syntax

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

paymentNumber: Purpose: Specifies the payment number.

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