Package paypal.payflow

Class RecurringResponse

java.lang.Object
paypal.payflow.BaseResponseDataObject
paypal.payflow.RecurringResponse
public final class RecurringResponse extends BaseResponseDataObject
Container class for all the messages related to recurring transactions.

This class contains response messages specific to the recurring transactions.

Following example shows how to obtain and use the recurring response.

................... // Trans is the recurring transaction. ................... // Submit the transaction. Response resp = trans.SubmitTransaction(); *

if (resp != null) { // Get the Transaction Response parameters. TransactionResponse trxnResponse = resp.getTransactionResponse(); if (trxnResponse!= null) { System.out.println("RESULT = " + trxnResponse.Result); System.out.println("RESPMSG = " + trxnResponse.RespMsg); } *

// Get the Recurring Response parameters. RecurringResponse recurResponse = resp.getRecurringResponse(); if (recurResponse != null) { System.out.println("RPREF = " + recurResponse.getRPRef()); System.out.println("PROFILEID = " + recurResponse.getProfileId()); } } *

...................

  • Constructor Details

    • RecurringResponse

      protected RecurringResponse()

  • Method Details

    • getProfileId

      public String getProfileId()
      Gets the Profile ID of the original profile.
      Returns:
      - String

      Maps to Payflow Parameter: PROFILEID

    • getRpRef

      public String getRpRef()
      Gets the Reference number to this particular action request.
      Returns:
      - String

      Maps to Payflow Parameter: RPREF

    • getTrxPNRef

      public String getTrxPNRef()
      Gets the PNREF of the optional transaction.
      Returns:
      - String

      Maps to Payflow Parameter: TRXPNREF

    • getTrxResult

      public String getTrxResult()
      Gets the RESULT of the optional transaction.
      Returns:
      - String

      Maps to Payflow Parameter: TRXRESULT

    • getTrxRespMsg

      public String getTrxRespMsg()
      Gets the RESPMSG of the optional transaction.
      Returns:
      - String

      Maps to Payflow Parameter: TRXRESPMSG

    • getProfileName

      public String getProfileName()
      Gets the profileName parameter.
      Returns:
      - String

      Maps to Payflow Parameter: PROFILENAME

    • getStart

      public String getStart()
      Gets the Beginning date for the recurring billing cycle.
      Returns:
      - String

      Maps to Payflow Parameter: START

    • getTerm

      public String getTerm()
      Gets the Number of payments to be made over the life of the agreement.
      Returns:
      - String

      Maps to Payflow Parameter: TERM

    • getPayPeriod

      public String getPayPeriod()
      Gets the PayPeriod parameter.Specifies how often the payment occurs.
      Returns:
      - String

      Maps to Payflow Parameter: PAYPERIOD

    • getStatus

      public String getStatus()
      Gets the Current status of the profile.
      Returns:
      - String

      Maps to Payflow Parameter: STATUS

    • getTender

      public String getTender()
      Gets the tendertype.
      Returns:
      - String

      Maps to Payflow Parameter: TENDER

    • getPaymentsLeft

      public String getPaymentsLeft()
      Gets the PaymentsLeft parameter. Number of payments left to be billed.
      Returns:
      - String

      Maps to Payflow Parameter: PAYMENTSLEFT

    • getNextPayment

      public String getNextPayment()
      Gets the next payment parameter.Date that the next payment is due.
      Returns:
      - String

      Maps to Payflow Parameter: NEXTPAYMENT

    • getEnd

      public String getEnd()
      Gets the profileName parameter.
      Returns:
      - String

      Maps to Payflow Parameter: END

    • getAggregateAmt

      public String getAggregateAmt()
      Gets AggregateAmt.Amount collected so far for scheduled payments.
      Returns:
      - String

      Maps to Payflow Parameter: AGGREGATEAMT

    • getAggregateOptionalAmt

      public String getAggregateOptionalAmt()
      Gets the AggregateOptAmt parameter.Amount collected through sending optional transactions.
      Returns:
      - String

      Maps to Payflow Parameter: AGGREGATEOPTIONALAMT

    • getAmt

      public String getAmt()
      Gets the amt parameter.Base dollar amount to be billed.
      Returns:
      - String

      Maps to Payflow Parameter: AMT

    • getAcct

      public String getAcct()
      Gets Acct.Masked credit card number.
      Returns:
      - String

      Maps to Payflow Parameter: ACCT

    • getExpDate

      public String getExpDate()
      Gets the ExpDate parameter.Expiration date of the credit card account.
      Returns:
      - String

      Maps to Payflow Parameter: EXPDATE

    • getMaxFailPayments

      public String getMaxFailPayments()
      Gets the maxfailpayments parameter.The number of payment periods (specified by PAYPERIOD) for which the transaction is allowed to fail before PayPal cancels a profile.
      Returns:
      - String

      Maps to Payflow Parameter: MAXFAILPAYMENTS

    • getNumFailPayments

      public String getNumFailPayments()
      Gets the NumFailPayments parameter.Number of payments that failed.
      Returns:
      - String

      Maps to Payflow Parameter: NUMFAILPAYMENTS

    • getRetryNumDays

      public String getRetryNumDays()
      Gets the retryNumDays parameter.
      Returns:
      - String

      Maps to Payflow Parameter: RETRYNUMDAYS

    • getEmail

      public String getEmail()
      Gets the email parameter.
      Returns:
      - String

      Maps to Payflow Parameter: EMAIL

    • getCompanyName

      public String getCompanyName()
      Gets the companyName parameter.
      Returns:
      - String

      Maps to Payflow Parameter: COMPANYNAME

    • getName

      public String getName()
      Gets the name parameter.
      Returns:
      - String

      Maps to Payflow Parameter: NAME

    • getFirstName

      public String getFirstName()
      Gets the firstName parameter.
      Returns:
      - String

      Maps to Payflow Parameter: FIRSTNAME

    • getMiddleName

      public String getMiddleName()
      Gets the middleName parameter.
      Returns:
      - String

      Maps to Payflow Parameter: MIDDLENAME

    • getLastname

      public String getLastname()
      Gets the lastname parameter.
      Returns:
      - String

      Maps to Payflow Parameter: LASTNAME

    • getStreet

      public String getStreet()
      Gets the street parameter.
      Returns:
      - String

      Maps to Payflow Parameter: STREET

    • getCity

      public String getCity()
      Gets the city parameter.
      Returns:
      - String

      Maps to Payflow Parameter: CITY

    • getState

      public String getState()
      Gets the state parameter.
      Returns:
      - String

      Maps to Payflow Parameter: STATE

    • getZip

      public String getZip()
      Gets the Zip parameter.
      Returns:
      - String

      Maps to Payflow Parameter: ZIP

    • getCountry

      public String getCountry()
      Gets the Country parameter.
      Returns:
      - String

      Maps to Payflow Parameter: COUNTRY

    • getPhoneNum

      public String getPhoneNum()
      Gets the PhoneNum parameter.
      Returns:
      - String

      Maps to Payflow Parameter: PHONENUM

    • getShipToFName

      public String getShipToFName()
      Gets the hipToFName parameter.
      Returns:
      - String

      Maps to Payflow Parameter: SHIPTOFIRSTNAME

    • getShipToMName

      public String getShipToMName()
      Gets the ShipToMName parameter.
      Returns:
      - String

      Maps to Payflow Parameter: SHIPTOMIDDLENAME

    • getShipToLName

      public String getShipToLName()
      Gets the ShipToLName parameter.
      Returns:
      - String

      Maps to Payflow Parameter: SHIPTOLASTNAME

    • getShipToStreet

      public String getShipToStreet()
      Gets the ShipToStreet parameter.
      Returns:
      - String

      Maps to Payflow Parameter: SHIPTOSTREET

    • getShipToCity

      public String getShipToCity()
      Gets the ShipToCity parameter.
      Returns:
      - String

      Maps to Payflow Parameter: SHIPTOCITY

    • getShipToState

      public String getShipToState()
      Gets the profileName parameter.
      Returns:
      - String

      Maps to Payflow Parameter: PROFILENAME

    • getShipToZip

      public String getShipToZip()
      Gets the ShipToZip parameter.
      Returns:
      - String

      Maps to Payflow Parameter: SHIPTOZIP

    • getShipToCountry

      public String getShipToCountry()
      Gets the ShipToCountry parameter.
      Returns:
      - String

      Maps to Payflow Parameter: SHIPTOCOUNTRY

    • getCreationDate

      public String getCreationDate()
      Gets the CreationDate parameter.
      Returns:
      - String

      Maps to Payflow Parameter: CREATIONDATE

    • getLastChanged

      public String getLastChanged()
      Gets the LastChanged parameter.
      Returns:
      - String

      Maps to Payflow Parameter: LASTCHANGED

    • getRpState

      public String getRpState()
      Gets the RPStateparameter.
      Returns:
      - String

      Maps to Payflow Parameter: RPSTATE

    • getNextPaymentNumber

      public String getNextPaymentNumber()
      Gets the NextPaymentNumber parameter.
      Returns:
      - String

      Maps to Payflow Parameter: NEXTPAYMENTNUMBER

    • getFrequency

      public String getFrequency()
      Gets the Frequency parameter.
      Returns:
      - String

      Maps to Payflow Parameter: FREQUENCY

    • getCurrency

      public String getCurrency()
      Gets the Currency parameter.
      Returns:
      - String

      Maps to Payflow Parameter: CURRENCY

    • getInquiryParams

      public Hashtable getInquiryParams()
      Gets the profileName parameter.
      Returns:
      - String

      Maps to Payflow Parameter: PROFILENAME

    • setParams

      protected void setParams(Hashtable ResponseHashTable)
      Overrides:
      setParams in class BaseResponseDataObject