paypalnvp.request
Class CreateRecurringPaymentsProfile

java.lang.Object
  paypalnvp.request.CreateRecurringPaymentsProfile

All Implemented Interfaces:

java.io.Serializable, Request

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

Create a recurring payments profile. You must invoke the CreateRecurringPaymentsProfile API operation for each profile you want to create. The API operation creates a profile and an associated billing agreement. Note: There is a one-to-one correspondence between billing agreements and recurring payments profiles. To associate a a recurring payments profile with its billing agreement, the description in the recurring payments profile must match the description of a billing agreement. Use SetExpressCheckout to initiate creation of a billing agreement.

See Also:

Serialized Form

Constructor Summary

CreateRecurringPaymentsProfile(CreditCard card)

CreateRecurringPaymentsProfile(java.lang.String token, ScheduleDetails details)
Token is appended to the return or cancel url set in SetExpressCheckout.

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	setActivationDetails(ActivationDetails details)
void	setAddress(Address address)
void	setBillingPeriodDetails(BillingPeriodDetails details)
void	setNVPResponse(java.util.Map<java.lang.String,java.lang.String> nvpResponse) Setter for nvp (name value pair) response
void	setPayerInformation(PayerInformation payer)
void	setPayerName(PayerName name)
void	setRecurringPaymentsProfileDetails(RecurringPaymentsProfileDetails details)
void	setShipToAddress(ShipToAddress address)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateRecurringPaymentsProfile

public CreateRecurringPaymentsProfile(java.lang.String token,
                                      ScheduleDetails details)
                               throws java.lang.IllegalArgumentException

Token is appended to the return or cancel url set in SetExpressCheckout.

Parameters:

token - A timestamped token, the value of which was returned in the response to the first call to SetExpressCheckout. You can also use the token returned in the SetCustomerBillingAgreement response. Either this token or a credit card number is required. If you include both token and credit card number, the token is used and credit card number is ignored. Call CreateRecurringPaymentsProfile once for each billing agreement included in SetExpressCheckout request and use the same token for each call. Each CreateRecurringPaymentsProfile request creates a single recurring payments profile. Note: Tokens expire after approximately 3 hours.

details -

Throws:

java.lang.IllegalArgumentException

CreateRecurringPaymentsProfile

public CreateRecurringPaymentsProfile(CreditCard card)

Parameters:

card -

Method Detail

setRecurringPaymentsProfileDetails

public void setRecurringPaymentsProfileDetails(RecurringPaymentsProfileDetails details)

Parameters:

details -

setBillingPeriodDetails

public void setBillingPeriodDetails(BillingPeriodDetails details)

Parameters:

details -

setActivationDetails

public void setActivationDetails(ActivationDetails details)

Parameters:

details -

setShipToAddress

public void setShipToAddress(ShipToAddress address)

Parameters:

address -

setPayerInformation

public void setPayerInformation(PayerInformation payer)

Parameters:

payer -

setPayerName

public void setPayerName(PayerName name)

Parameters:

name -

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