User's Guide
Table Of Contents
- Contents
- Preface
- Managing Payflow Services
- Using the SDK to Perform Recurring Tasks
- About Recurring Billing Profile Actions
- Using the Add Action
- Required Parameters for the Add Action
- Using the Modify and Reactivate Actions
- Required Parameters for the Modify and Reactivate Actions
- Using the Cancel Action
- Required Parameters for the Cancel Action
- Using the Inquiry Action to View Information for a Profile
- Using the Inquiry Action to View the Status of the Profile
- Using the Inquiry Action to View the Status of Payments
- Required Parameters for the Status of Payments Inquiry Action
- Using the Payment Action
- Required Parameters for the Payment Action
- Testing Recurring Billing
- Obtaining Consent to Bill Customers Using Recurring Billing
Managing Payflow Services
Recurring Billing Terms
1
10 July 2011 Payflow Pro Recurring Billing Service User’s Guide
Recurring Billing Terms
Table 1.1 describes terms you should be familiar with when using the Recurring Billing
Service.
Overview of Recurring Billing Actions Using the Payflow SDK
The Payflow SDK supports several actions that enable you to manage recurring payment
accounts. See Chapter 2, “Using the SDK to Perform Recurring Tasks,” for details on
performing the following supported actions:
Add (ACTION=A)
Add a new recurring billing profile either by submitting the required data (credit card number
or PayPal, payment amount, payment period, and so on) or by converting an existing
transaction into a profile. Upon successful creation, PayPal activates the profile, performs the
optional initial transaction if specified, initiates the payment cycle, and returns a Profile ID.
TABLE 1.1 Recurring billing terms
Term Meaning
Payment Sum that is transacted during each payment period. Payments differ
from transactions. Several transactions may be required to successfully
perform a payment for a payment period; for example, due to a lack of
funds during the first transaction attempts. Once a transaction succeeds
for a payment period, the payment is marked as successful.
Payment Period One payment is made per payment period; for example, a $42 payment
on a monthly basis. In this example, the payment period is monthly.
Profile Your definition of a recurring transaction for a single customer. The
profile includes all information required to automatically bill the right
person the right amount of money at the right time for the right period
of time.
Profile ID Twelve-character string (generated by PayPal) that uniquely identifies a
recurring profile. Test profile IDs start with the characters RT and live
profile IDs, with RP.
Term Total number of payment periods over the duration of the agreement.
For example, a three-year, monthly payment contract has a term of 36.
Term defines the number of scheduled payment periods, not the
payments actually made.
Mature Profile Reference to a profile with a completed term (the total number of
payment periods for the profile have occurred). The fact that a profile is
mature does not necessarily mean that the customer has made all
scheduled payments.