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
Payflow Pro Recurring Billing Service User’s Guide July 2011 17
Using the SDK to Perform Recurring Tasks
Required Parameters for the Add Action
2
ACTION Specifies Add, Modify, Cancel, Reactivate, Inquiry, or
Payment.
Must be “A” (1)
PROFILENAME Name for the profile (user-specified). Can be used to
search for a profile.
Non-unique
identifying text
name
Alpha-
numeric(128)
ACCT Required when TENDER=C or TENDER=A. Can be
used to search for a profile.
NOTE: For a credit card profile, be sure to use a valid
credit card number. If necessary, perform an
Authorization with a zero-dollar amount to
verify the credit card.
Alphaumeric (19)
BAID Is the billing agreement ID returned in the Do Express
Checkout Payment or Create Customer Billing
Agreement response. See Express Checkout for
Payflow Pro for details on obtaining and updating
BAIDs.
NOTE: Either a BAID or ORIGID (PNREF) returned
from the original transaction used to create a
new profile is required when TENDER=P.
Alphaumeric (19)
ORIGID Is the PNREF value (length=12) returned from the
original transaction used to create a new profile.
NOTE: Either a BAID or ORIGID is required to create
a new profile when TENDER=P.
Alphaumeric (19)
AMT Dollar amount (US dollars) to be billed.
Specify the exact amount to the cent using a decimal
point—use 34.00, not 34. Do not include comma
separators—use 1199.95 not 1,199.95.
Numeric (10 with
decimal point)
START Beginning date for the recurring billing cycle used to
calculate when payments should be made. Use
tomorrow’s date or a date in the future.
Format: MMDDYYYY
Numeric (8)
TERM Number of payments to be made over the life of the
agreement.
A value of 0 means that payments should continue
until the profile is deactivated.
Numeric
T
ABLE 2.2 Required recurring profile parameters for the Add action(Continued)
Parameter Description Usage (Length)