paypalnvp.request
Class BillOutstandingAmount

java.lang.Object
  paypalnvp.request.BillOutstandingAmount

All Implemented Interfaces:

java.io.Serializable, Request

public final class BillOutstandingAmount
extends java.lang.Object
implements Request

BillOutstandingAmount Request Message Bill the buyer for the outstanding balance associated with a recurring payments profile.

See Also:

Serialized Form

Constructor Summary

BillOutstandingAmount(java.lang.String profileId)
Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response.

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getNVPRequest() Creates and returns part of the nvp (name value pair) request containing request values
java.util.Map<java.lang.String,java.lang.String>	getNVPResponse() Return response from paypal.
void	setAmount(java.lang.String amount) The amount to bill.
void	setNote(java.lang.String note) The reason for the non-scheduled payment.
void	setNVPResponse(java.util.Map<java.lang.String,java.lang.String> nvpResponse) Setter for nvp (name value pair) response
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BillOutstandingAmount

public BillOutstandingAmount(java.lang.String profileId)
                      throws java.lang.IllegalArgumentException

Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. Character length and limitations: 14 single-byte alphanumeric characters. 19 character profile IDs are supported for compatibility with previous versions of the PayPal API. The profile must have a status of either Active or Suspended.

Parameters:

profileId -

Throws:

java.lang.IllegalArgumentException

Method Detail

setAmount

public void setAmount(java.lang.String amount)
               throws java.lang.IllegalArgumentException

The amount to bill. The amount must be less than or equal to the current outstanding balance of the profile. If no value is specified, PayPal will attempt to bill the entire outstanding balance amount.

Parameters:

amount - Set this field to 0 if the transaction does not include a one-time purchase; for example, when you set up a billing agreement for a recurring payment that is not immediately charged. Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Must have two decimal places, decimal separator must be a period (.), and no thousands separator.

Throws:

java.lang.IllegalArgumentException

setNote

public void setNote(java.lang.String note)

The reason for the non-scheduled payment. For profiles created using Express Checkout, this message will be included in the email notification to the buyer for the non-scheduled payment transaction, and can also be seen by both you and the buyer on the Status History page of the PayPal account.

Parameters:

note -

getNVPRequest

public java.util.Map<java.lang.String,java.lang.String> getNVPRequest()

Description copied from interface: Request

Creates and returns part of the nvp (name value pair) request containing request values

Specified by:

getNVPRequest in interface Request

Returns:

part of the nvp request as a Map

setNVPResponse

public void setNVPResponse(java.util.Map<java.lang.String,java.lang.String> nvpResponse)

Description copied from interface: Request

Setter for nvp (name value pair) response

Specified by:

setNVPResponse in interface Request

getNVPResponse

public java.util.Map<java.lang.String,java.lang.String> getNVPResponse()

Description copied from interface: Request

Return response from paypal. If response is not set/received returns empty Map.

Specified by:

getNVPResponse in interface Request

Returns:

response from paypal as a Map

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object