getAutoPaymentOption()

getAutoPaymentOptionResponse getAutoPaymentOption(string usn)

This method returns the configured automatic payment option for an account.

Parameters

usn: Format: string; Purpose: Specifies the USN of the account to get the auto payment option from.

Example: Request an accounts automatic payment option

This example requests the automatic payment option for account CN666.

<getAutoPaymentOption xmlns="http://xml.inomial.com/smile/2.xsd">
   <usn>CN666</usn>
</getAutoPaymentOption>

Results

This method returns automatic payment option configured for the requested account

If the payment option returned is from Account Terms then <fromAccountTerms> will have value true, otherwise false.

There are no messages defined by this method.

Example: A returned getAutoPaymentOptionResponse XML document

This example shows a returned getAutoPaymentOptionresponse XML document.

<getAutoPaymentOptionResponse xmlns:"http://xml.inomial.com/smile/2.xsd">
   <AutoPaymentOption fromAccountTerms="false" key="2">Schedule Payment of Account Balance</AutoPaymentOption>
</getAutoPaymentOptionResponse>

Faults

InvalidRequestException

This fault is returned when USN is not specified in the Request.

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.getAutoPaymentOption usn

usn: Purpose: Specifies the USN of the account to get the auto payment option from.

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