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
Using the SDK to Perform Recurring Tasks
Required Parameters for the Add Action
2
16 July 2011 Payflow Pro Recurring Billing Service User’s Guide
"TRXTYPE=R&TENDER=C&PARTNER=PayPal&VENDOR=Acme&USER=Acme&PWD=a1b2c3d4&ACTIO
N=A&PROFILENAME=RegularSubscription&AMT=42.00&ACCT=4012888888881881&EXPDATE
=0203&START=12012008&PAYPERIOD=WEEK&TERM=12&OPTIONALTRX=S&OPTIONALTRXAMT=2.
00&COMMENT1=First-time customer"
Adding a New Profile for a PayPal Account
The following example Payflow parameter string creates a recurring billing profile that bills a
PayPal account. Parameters are described in “Required Parameters for the Add Action” on
page 15 and “Optional Parameters for the Add Action” on page 17.
"TRXTYPE=R&TENDER=P&PARTNER=PayPal&USER=Acme&PWD=test1234&ACTION=A&PROFILEN
AME=RegularSubscription&AMT=4.46&BAID=B-
29X12812Y7908851G&START=09252009&PAYPERIOD=WEEK&TERM=12&OPTIONALTRX=A&MAXFA
ILPAYMENTS=1&RETRYNUMDAYS=1&CURRENCY=USD"
Converting an Existing Transaction Into a Profile
The following example Payflow parameter string creates a profile for an original transaction
that had a PNREF value of xyz123 and specifies a payment amount of $42. You must set the
ORIGID value to the original transaction’s PNREF value. Parameters are described in
“Required Parameters for the Add Action” on page 15 and “Optional Parameters for the Add
Action” on page 17.
"TRXTYPE=R&TENDER=C&PARTNER=PayPal&VENDOR=Acme&USER=Acme&PWD=a1b2c3d4&ACTIO
N=A&PROFILENAME=RegularSubscription&ORIGID=XYZ 123&START=12012002&PAYPERIOD=
WEEK&TERM=12&OPTIONALTRX=S&OPTIONALTRXAMT=2.00&COMMENT1=First-time
customer&AMT=42.00"
Example Response for the Add Action
The following is an example response for the Add Action. Returned values are described in
“Response Values for the Add Action” on page 18.
RESULT=0&RPREF=RWY504915344&PROFILEID=RP000000001234&RESPMSG=Approved&TRXRE
SULT=0&TRXPNREF=VWYA04915345&TRXRESPMSG=Approved&AUTHCODE=489PNI
Required Parameters for the Add Action
The following are required parameters for the Add action:
TABLE 2.2 Required recurring profile parameters for the Add action
Parameter Description Usage (Length)
TRXTYPE Specifies a recurring profile request. Must be “R”
TENDER Tender type. Is one of the following values:
C = Credit card
P = PayPal
A = Automated Clearinghouse
Must be “C”, “P”,
or “A” (1)