paypalnvp.request
Class UpdateRecurringPaymentsProfile

java.lang.Object
  paypalnvp.request.UpdateRecurringPaymentsProfile

All Implemented Interfaces:

java.io.Serializable, Request

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

See Also:

Serialized Form

Constructor Summary

UpdateRecurringPaymentsProfile(java.lang.String profileId)

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	setAdditionalBillingCycles(int cycles)
void	setAddress(Address address)
void	setAmount(java.lang.String amount)
void	setAutoBillingOutstandingAmount(boolean autoBilling)
void	setBillingPeriodDetails(BillingPeriodDetails period)
void	setCreditCard(CreditCard card)
void	setDescription(java.lang.String description)
void	setMaxFailedPayments(int maxFailedPayments)
void	setNote(java.lang.String note)
void	setNVPResponse(java.util.Map<java.lang.String,java.lang.String> nvpResponse) Setter for nvp (name value pair) response
void	setOutstandingAmount(java.lang.String amount)
void	setPayerInformation(PayerInformation payer)
void	setProfileReference(java.lang.String reference)
void	setProfileStartDate(java.util.Date startDate)
void	setShippingAmount(java.lang.String amount)
void	setShipToAddress(ShipToAddress address)
void	setSubscriberName(java.lang.String name)
void	setTaxAmount(java.lang.String amount)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateRecurringPaymentsProfile

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

Parameters:

profileId - 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.

Throws:

java.lang.IllegalArgumentException

Method Detail

setNote

public void setNote(java.lang.String note)

Parameters:

note - The reason for the update to the recurring payments profile. This message will be included in the email notification to the buyer for the recurring payments profile update. This note can also be seen by both you and the buyer on the Status History page of the PayPal account.

setDescription

public void setDescription(java.lang.String description)
                    throws java.lang.IllegalArgumentException

Parameters:

description - Description of the recurring payment. Character length and limitations: 127 single-byte alphanumeric characters.

Throws:

java.lang.IllegalArgumentException

setSubscriberName

public void setSubscriberName(java.lang.String name)

Parameters:

name - Full name of the person receiving the product or service paid for by the recurring payment. If not present, the name in the buyer's PayPal account is used. Character length and limitations: 32 single-byte characters.

setProfileReference

public void setProfileReference(java.lang.String reference)
                         throws java.lang.IllegalArgumentException

Parameters:

reference - The merchant’s own unique reference or invoice number. Character length and limitations: 127 single-byte alphanumeric characters.

Throws:

java.lang.IllegalArgumentException

setAdditionalBillingCycles

public void setAdditionalBillingCycles(int cycles)

Parameters:

cycles - The number of additional billing cycles to add to this profile.

setAmount

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

Parameters:

amount - Billing amount for each cycle in the subscription period, not including shipping and tax amounts. Note: For recurring payments with Express Checkout, the payment amount can be increased by no more than 20% every 180 days (starting when the profile is created). Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.). Equivalent to nine characters maximum for USD.

Throws:

java.lang.IllegalArgumentException

setShippingAmount

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

Parameters:

amount - Shipping amount for each billing cycle during the regular payment period. Note: All amounts in the request must have the same currency. Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.). Equivalent to nine characters maximum for USD.

Throws:

java.lang.IllegalArgumentException

setTaxAmount

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

Parameters:

amount - Tax amount for each billing cycle during the regular payment period. Note: All amounts in the request must have the same currency. Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.). Equivalent to nine characters maximum for USD.

Throws:

java.lang.IllegalArgumentException

setOutstandingAmount

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

Parameters:

amount - The current past due or outstanding amount for this profile. You can only decrease the outstanding amount-it cannot be increased. Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.). Equivalent to nine characters maximum for USD.

Throws:

java.lang.IllegalArgumentException

setAutoBillingOutstandingAmount

public void setAutoBillingOutstandingAmount(boolean autoBilling)

Parameters:

autoBilling - This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle.

setMaxFailedPayments

public void setMaxFailedPayments(int maxFailedPayments)

Parameters:

maxFailedPayments - The number of failed payments allowed before the profile is automatically suspended. The specified value cannot be less than the current number of failed payments for this profile.

setProfileStartDate

public void setProfileStartDate(java.util.Date startDate)

Parameters:

startDate - The date when billing for this profile begins. The profile may take up to 24 hours for activation.

setShipToAddress

public void setShipToAddress(ShipToAddress address)

Parameters:

address -

setBillingPeriodDetails

public void setBillingPeriodDetails(BillingPeriodDetails period)

Parameters:

period -

setCreditCard

public void setCreditCard(CreditCard card)

Parameters:

card -

setPayerInformation

public void setPayerInformation(PayerInformation payer)

Parameters:

payer -

setAddress

public void setAddress(Address address)

Parameters:

address -

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