paypalnvp.fields
Class BillingAgreement

java.lang.Object
  paypalnvp.fields.BillingAgreement

All Implemented Interfaces:

java.io.Serializable, RequestFields

public final class BillingAgreement
extends java.lang.Object
implements RequestFields

Billing Agreement Details Fields

See Also:

Serialized Form

Nested Class Summary

static class

BillingAgreement.PaymentType PayPal payment you require for the billing agreement

Constructor Summary

BillingAgreement()

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
void	setBillingType(java.lang.String billingType) Type of billing agreement.
void	setCustomField(java.lang.String field) Custom annotation field for your own use.
void	setDescription(java.lang.String description) Description of goods or services associated with the billing agreement, which is required for each recurring payment billing agreement.
void	setPaymentType(BillingAgreement.PaymentType paymentType) Specifies type of PayPal payment you require for the billing agreement.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BillingAgreement

public BillingAgreement()

Method Detail

setBillingType

public void setBillingType(java.lang.String billingType)

Type of billing agreement. For recurring payments, this field must be set to RecurringPayments and description (setDescription) MUST be set as well. In this case, you can specify up to ten billing agreements. Note: Other defined values are not valid.

Parameters:

billingType -

setDescription

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

Description of goods or services associated with the billing agreement, which is required for each recurring payment billing agreement. PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions. For example, customer will be billed at "9.99 per month for 2 years". Character length and limitations: 127 single-byte alphanumeric bytes.

Parameters:

description -

Throws:

java.lang.IllegalArgumentException

setPaymentType

public void setPaymentType(BillingAgreement.PaymentType paymentType)

Specifies type of PayPal payment you require for the billing agreement. Note: For recurring payments, this field is ignored.

Parameters:

paymentType -

setCustomField

public void setCustomField(java.lang.String field)
                    throws java.lang.IllegalArgumentException

Custom annotation field for your own use. Note: For recurring payments, this field is ignored. Character length and limitations: 256 single-byte alphanumeric bytes.

Parameters:

field -

Throws:

java.lang.IllegalArgumentException

getNVPRequest

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

Description copied from interface: RequestFields

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

Specified by:

getNVPRequest in interface RequestFields

Returns:

part of the nvp request as a Map

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object