PayPal Website Payments Pro - 2010 - Recurring Payments Payflow Edition Developer's Guide

Website Payments

Pro Payflow Edition -

Recurring Payments

Developer’s Guide

Last updated: January 2010

Website Payments Pro Payflow Edition - Recurring Payments Developer’s Guide

Document Number: 200040.en_US-201001

© 2010 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other trademarks and brands are the property of their respective owners.

The information in this document belongs to PayPal, Inc. It may not be used, reproduced or disclosed without the written approval of PayPal, Inc.

Copyright © PayPal. All rights reserved. PayPal (Europe) S.à r.l. et Cie., S.C.A., Société en Commandite par Actions. Registered office: 22-24 Boulevard

Royal, L-2449, Luxembourg, R.C.S. Luxembourg B 118 349.

Consumer advisory: The PayPal™ payment service is regarded as a stored value facility under Singapore law. As such, it does not require the approval of the Monetary Authority of Singapore. You are advised to read the terms and conditions carefully.

Notice of non-liability:

PayPal, Inc. is providing the information in this document to you “AS-IS” with all faults. PayPal, Inc. makes no warranties of any kind (whether express, implied or statutory) with respect to the information contained herein. PayPal, Inc. assumes no liability for damages (whether direct or indirect), caused by errors or omissions, or resulting from the use of this document or the information contained in this document or resulting from the application or use of the product or service described herein. PayPal, Inc. reserves the right to make changes to any information herein without further notice.

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Where To Go For More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 1 Recurring Payments Overview . . . . . . . . . . . . . . . 7

About the Payflow Recurring Payment Services. . . . . . . . . . . . . . . . . . . . . . . . 7

Managing Recurring Payments Profiles Through PayPal . . . . . . . . . . . . . . . . . . . 8

Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Recurring Payments Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 2 Creating Recurring Payments Profiles . . . . . . . . . . . 11

Preparing to Create Recurring Payments Profiles . . . . . . . . . . . . . . . . . . . . . . 11

Creating Profiles Through Your PayPal Account. . . . . . . . . . . . . . . . . . . . . . . 11

Creating Recurring Payments Profiles Programmatically . . . . . . . . . . . . . . . . . . 13

Options for Creating a Recurring Payments Profile Programmatically. . . . . . . . . . . . 14

Specifying the Regular Payment Period . . . . . . . . . . . . . . . . . . . . . . . . . 15

Including an Optional Trial Payment Period . . . . . . . . . . . . . . . . . . . . . . . 15

Specifying an Initial Payment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Setting the Number of Failed Payments . . . . . . . . . . . . . . . . . . . . . . . . . 16

Billing the Outstanding Amount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Example: Creating a Recurring Payments Profile For Billing a Credit Card . . . . . . . . . 16

Example: Creating a Recurring Payments Profile For Billing a PayPal Account . . . . . . 18

Chapter 3 Deactivating and Reactivating Recurring Payments Profiles .

21

Deactivating a Profile Through Your PayPal Account . . . . . . . . . . . . . . . . . . . . 21

Reactivating a Profile Through Your PayPal Account . . . . . . . . . . . . . . . . . . . . 22

Deactivating a Profile Programmatically . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Reactivating a Profile Programmatically . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Example of Deactivating a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Payflow Recurring Payments Developer’s Guide 3

4

Contents

Example of Reactivating a Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Chapter 4 Canceling Recurring Payments Profiles . . . . . . . . . . . 25

Canceling Recurring Payments Profiles Through Your PayPal Account. . . . . . . . . . . 25

Chapter 5 Getting Recurring Payments Profile Details . . . . . . . . . 29

Profile Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Obtaining Profile Details Through Your PayPal Account. . . . . . . . . . . . . . . . . . . 30

Obtaining Profile Details Programmatically . . . . . . . . . . . . . . . . . . . . . . . . . 31

Example of Getting Recurring Payments Profile Details . . . . . . . . . . . . . . . . . . . 31

Chapter 6 Billing the Outstanding Amount . . . . . . . . . . . . . . 33

Billing the Outstanding Amount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Chapter 7 Updating Recurring Payments Profiles . . . . . . . . . . . 35

Updating Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Updating a Profile Through Your PayPal Account . . . . . . . . . . . . . . . . . . . . . . 35

Updating Profiles Programmatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Example of Updating Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Chapter 8 Recurring Payments Reference . . . . . . . . . . . . . . . 39

Creating Recurring Payments Profiles (ACTION=A) . . . . . . . . . . . . . . . . . . . . 39

Updating Recurring Payments Profiles (ACTION=M) . . . . . . . . . . . . . . . . . . . . 46

Deactivating Recurring Payments Profiles (ACTION=C) . . . . . . . . . . . . . . . . . . 52

Reactivating Recurring Payments Profiles (ACTION=R) . . . . . . . . . . . . . . . . . . 53

Viewing Recurring Payments Profile Details (ACTION=I) . . . . . . . . . . . . . . . . . . 53

Billing Outstanding Amount Request (ACTION=P) . . . . . . . . . . . . . . . . . . . . . 61

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Payflow Recurring Payments Developer’s Guide

Preface

This guide describes how to perform recurring payments transactions using the Payflow SDK.

It also describes how to manage recurring payments profiles through the merchant’s PayPal account. Recurring Payments is a scheduled payment solution that enables you to automatically bill the buyer at regular intervals – for example, a monthly fee of $42 for 36 months with an initial fee of $129.

Audience

This guide assumes that its users: z

Have PayPal accounts that have the ability to use Payflow credentials. z z z

Are experienced web or application developers or merchants offering recurring payment solutions to their buyers on their websites

Have a background in payments services

Have experience with Express Checkout if billing the buyer’s PayPal account on a recurring basis

Where To Go For More Information

For more information, see the following documentation, which is available on Developer

Central : z z

Website Payments Pro Payflow Edition Developer’s Guide

Express Checkout for Payflow Pro

Revision History

T ABLE 1.1 Revision history

Date

January 2010

Changes

Updated Preface description of Recurring Payments users.


Revision History

T ABLE 1.1 Revision history

Date

August 2009

March 2009

Changes

Added an example of obtaining a TOKEN from the Set Express

Checkout response to create a Recurring Payments profile for billing a PayPal account.

First publication of Payflow Recurring Payments for credit cards and PayPal accounts on a recurring basis

6 Payflow Recurring Payments Developer’s Guide

1

Recurring Payments Overview

Website Payments Pro Payflow Edition (Payflow) Recurring Payments allows you to bill a buyer’s credit card or PayPal account for a fixed amount of money on a fixed schedule.

Consider the following examples: z

A buyer purchases a subscription to a magazine or newsletter from your site and agrees to pay a monthly fee.

z

A buyer agrees to pay an Internet Service Provider a one-time setup fee and a flat fee on a semi-annual basis to host a website.

A buyer agrees to an installment plan to purchase a high-ticket item.

z

These examples represent payment transactions that reoccur periodically and are for a fixed amount. PayPal offers Payflow recurring payments with the Direct Payments (credit card processing) and Express Checkout payment solutions.

N

O TE

: To use recurring payments to bill a buyer’s PayPal account, you must first establish a billing agreement with the buyer through the Express Checkout flow. For details, see the document entitled Express Checkout for Payflow Pro, which is available on

Developer Central .

About the Payflow Recurring Payment Services

When you create recurring payments for a buyer, you create a recurring payments profile. The recurring payments profile contains information about the recurring payments, including details for an optional trial payment period and a regular payment period. If the profile is for billing the buyer’s credit card, it specifies the credit card account to bill and the expiration date. A recurring payments profile also includes the associated contact information, the amount to charge each time, the billing period (monthly, weekly, and so on), and the number of payment periods over the life of the recurring billing agreement.

After a recurring payments profile is created, PayPal automatically queues payments based on the billing start date, billing frequency, and billing amount, until the profile expires or is canceled by the merchant.

After the recurring payments profile is created, you can view recurring payments details and perform other recurring payments profile management tasks: z z

Manually, by accessing your PayPal Business account

Programmatically, by making calls to Payflow recurring payments requests

The following sections describe how to perform recurring payments profile tasks: z z

“Creating Recurring Payments Profiles” on page 11

“Deactivating and Reactivating Recurring Payments Profiles” on page 21


Recurring Payments Overview

Managing Recurring Payments Profiles Through PayPal z z z z

“Canceling Recurring Payments Profiles” on page 25

“Getting Recurring Payments Profile Details” on page 29

“Billing the Outstanding Amount” on page 33

“Updating Recurring Payments Profiles” on page 35

Managing Recurring Payments Profiles Through PayPal

After you have created recurring payments profiles, you can manage them through your

PayPal Business account:

1. Log in to your business account.

2. Click the Recurring Payments link either in the Tools section of the Account Overview page or on your Profile page.

The Recurring payments overview page appears, as shown below.

F IGURE 1.1 Recurring payments overview page



Limitations

Limitations

The current release of Payflow recurring payments has the following limitations: z z

A recurring payments profile can have at most one optional trial payment period and a single regular payment period.

The recurring payments profile start date may not be earlier than the profile creation date.

Recurring Payments Terms

Table 1.1 lists commonly used terms related to Payflow Recurring Payments.

T ABLE 1.1 Payflow Recurring Payments Terms

Term

Payment

Regular payment period

Trial payment period

Term

Recurring payments profile

Profile ID

Outstanding balance

Meaning

The amount that is transacted during each regular payment period, not including shipping and tax. It is represented by the

Payflow AMT parameter. Payments differ from transactions.

Several transactions may be required to successfully perform a payment for a payment period, for example, because of a lack of funds during the first transaction attempts.

The period during which a single regular (non-trial) payment is made. It is represented by the PAYPERIOD parameter. If, for example, a $42 payment is due on a monthly basis, the regular payment period is monthly.

An optional subscription period before the regular payment period begins. It is represented by the TRIALPAYPERIOD parameter. A trial payment period and trial payment may differ from the regular payment period and regular payment.

The total number of regular or trial payment periods. It is represented by the TERM and TRIALTERM parameters. If there are 36 monthly payments, for example, the term is 36. On the

PayPal website, term is called payment cycle.

Your definition of a recurring transaction for a single buyer. The profile includes all information required to automatically bill the right person the right amount per payment period over the billing frequency.

A 19-character string PayPal generates to uniquely identify a recurring profile.

If a payment fails for any reason, that amount is added to the profile’s outstanding balance.



Recurring Payments Terms


2

Creating Recurring Payments

Profiles

N

O TE

: The Payflow SDK recurring payments operations are available only to merchants who have signed up for Payflow Recurring Payments.

Preparing to Create Recurring Payments Profiles

To set up recurring payments, you must collect all necessary information from the buyer including the billing amount of the payment.

For recurring payments that you bill through the buyer’s credit card, this includes the buyer’s credit card information.

For recurring payments that you bill through the buyer’s PayPal account, you must first call the Set Express Checkout request, specifying the RecurringPayments billing type and providing the billing description for one or more profiles that you want to create. For details, see Express Checkout for Payflow Pro.

After you have collected the information, you can create the recurring payments profile either through the PayPal website or programmatically using the PayPal SDK recurring payments

SDK operations.

Creating Profiles Through Your PayPal Account

To create a recurring payments profile through your PayPal Business account:

1. Log in to your business account.


The Recurring payments overview page appears, as shown in Figure 2.1

.


Creating Recurring Payments Profiles

Creating Profiles Through Your PayPal Account


12

3. Click the Create a new profile link.

4. On the Create a Recurring Payment profile page, fill in all required information about the buyer, and click continue.

If successful, the Review a Recurring Payment profile page appears.

5. Review the profile description. Click Update to edit, if necessary, or Cancel to cancel the profile. Click Submit to create the profile.

Upon successful profile creation, you will receive a status message along with a summary of the profile information, such as shown in Figure 2.2 .You can use the profile ID to locate and obtain information about this profile in the future.

Click the Recurring Payments link either in the Tools section of the Account Overview page or on your Profile page to view the Recurring payments overview page. From this page, you can

manage the profiles you create. For more information, see “Managing Recurring Payments

Profiles Through PayPal” on page 8

.


F IGURE 2.2 Profile created


Creating Recurring Payments Profiles Programmatically

Creating Recurring Payments Profiles Programmatically

You can create recurring payments profiles programmatically using the Payflow SDK.

Table 2.1 lists the Payflow parameters required in the request string to create a new profile.

The ACTION value for creating a profile is always A.

T ABLE 2.1 Required Parameters to Create a New Profile

Parameter

TRXTYPE

TENDER

Notes

The value R for recurring payments.

The value C for credit card or P for PayPal


14


Options for Creating a Recurring Payments Profile Programmatically

T ABLE 2.1 Required Parameters to Create a New Profile

Parameter

ACTION

PROFILENAME

ACCT

EXPDATE

AMT

START

TERM

PAYPERIOD

TOKEN

L_BILLINGAGREEMENTDESCR

IPTIONn

BA_DESC

Notes

The value A for creating a new recurring payments profile.

Unique profile name.

Credit card account number. Required for credit card billing only.

Credit card expiration date. Required for credit card billing only.

The amount to bill.

Start date for the recurring payment. The date is tomorrow or a date in the future.

Life of the payment.

How often the payment occurs, such as weekly or twice a month.

A TOKEN returned in the Set Express Checkout response.

Required for PayPal account billing only.

One or more billing agreement descriptions up to a maximum of

10. Required for PayPal account billing only.

A single billing agreement description only; if

L_BILLINGAGREEMENTDESCRIPTIONn is specified, it overrides this value. Required for PayPal account billing if

L_BILLINGAGREEMENTDESCRIPTIONn is not specified.

Upon successful creation of a profile, PayPal activates the profile, initiates the billing cycle, and returns a profile ID. Upon failure, PayPal does not generate the profile and, instead, returns a status message.

As with all direct payments, PayPal is completely invisible to the buyer. The buyer’s credit card statement will not indicate that PayPal processed the payment.

Options for Creating a Recurring Payments Profile

Programmatically

You have the following options when creating a recurring payments profile: z

Specifying the Regular Payment Period

z z z

Including an Optional Trial Payment Period

Specifying an Initial Payment

Setting the Number of Failed Payments



Options for Creating a Recurring Payments Profile Programmatically

Specifying the Regular Payment Period

Each recurring payments profile has a regular payment period that defines the amount and frequency of the payment.

Table 2.2 lists the required fields associated with creating the

regular payment period.

T ABLE 2.2 Regular Payment Period Parameters

AMT

START

TERM

PAYPERIOD

Including an Optional Trial Payment Period

You can optionally include a trial payment period in the profile by specifying the following

fields in the request to create a profile. Table 2.3

lists the required fields if you are also creating an optional trial payment period.

N

O TE

: If you include any of the trial payment period parameters, you must include all them in the request to create a recurring payments profile.

T ABLE 2.3 Trial Payment Period Parameters

TRIALSTART

TRIALTERM

TRIALPAYPERIOD

TRIALAMT

TRIALFREIGHTAMT

TRIALTAXAMT

Specifying an Initial Payment

You can optionally specify an initial non-recurring payment when the recurring payments

profile is created by including the fields listed in Table 2.4

in the request to create a profile.

T ABLE 2.4 Optional Initial Payment Parameters

OPTIONALTRXAMT

FAILEDINITAMTACTION

When you specify an amount for OPTIONALTRXAMT, the profile is billed for that amount initially upon recurring payments profile creation. If you don’t supply a value for this


16


Example: Creating a Recurring Payments Profile For Billing a Credit Card parameter, PayPal performs a $1.00 authorization using the merchant-supplied credentials to create a recurring payments profile.

By default, PayPal will not activate the profile if the initial payment amount fails. You can override this default behavior by setting FAILEDINITAMTACTION to ContinueOnFailure, which indicates that if the initial payment amount fails, PayPal should add the failed payment amount to the outstanding balance due on this recurring payment profile.

If FAILEDINITAMTACTION is not set or is set to CancelOnFailure, PayPal creates the recurring payments profile but places it in a pending status until the initial payment is completed. If the initial payment clears, this means PayPal activated the pending profile. If the

payment fails, PayPal did not activate it. To check the profile status, see “Obtaining Profile

Details Through Your PayPal Account” on page 30

.

Setting the Number of Failed Payments

By including the optional MAXFAILEDPAYMENTS parameter in the request to create a profile, you can set the number of failed scheduled payments allowed before PayPal deactivates

(suspends) the profile. By default, the value is 0, which means no limit.

Billing the Outstanding Amount

If a payment fails for any reason, the amount that was to be billed (including shipping and tax, if applicable) is added to the profile’s outstanding balance. Use the AUTOBILLOUTSTANDINGAMT parameter field in the request to create a profile to specify whether or not the outstanding amount should be added to the payment amount for the next billing cycle.

Example: Creating a Recurring Payments Profile For Billing a

Credit Card

The following Payflow parameter string creates a profile for credit card recurring payments billing. Parameter fields required for creating the credit card recurring payments profile are in boldface. The example includes the following: z z

An initial non-recurring payment of $10.00

Profile activation even if the initial payment amount fails z z z

A trial payment period starting August 2, 2009, for 2 months at a trial rate of $56.00 per month plus $20.00 shipping and $2.50 tax

A regular payment starting October 27, 2009, for 10 months at a rate of $60.00 per month excluding shipping and tax

The outstanding amount is added to the payment amount for the next billing cycle

(PAYPERIOD)



Example: Creating a Recurring Payments Profile For Billing a Credit Card

Create Credit Card Recurring Payments Profile Request

"USER=SuperMerchant

&PWD=SuperUserPassword

&PARTNER=PayPal

&TRXTYPE=R

&TENDER=C

&ACTION=A

&PROFILENAME=J Smith

&ACCT=510510511105105100

&EXPDATE=1209

&CVV2=657

&AMT=60.00

&START=10272009

&TERM=10

&PAYPERIOD=MONT

&CURRENCY=USD

&MAXFAILPAYMENTS=4

&[email protected]

&COMPANYNAME=PayPal

&DESC=To See Cricket Matches

&OPTIONALTRXAMT=10.00

&FIRSTNAME=John

&MIDDLENAME=J

&LASTNAME=Smith

&STREET=1 Main St

&ZIP=95131&CITY=San Jose

&STATE=CA

&COUNTRY=US

&PHONENUM=294-9555

&CARDSTART=1008

&CARDISSUE=Solo

&FREIGHTAMT=20.00

&TAXAMT=2.50

&TRIALSTART=08022009

&TRIALTERM=2

&TRIALPAYPERIOD=MONT

&TRIALAMT=56.00

&TRIALFREIGHTAMT=20.00

&TRIALTAXAMT=2.50

&FAILEDOPTIONALTRXACTION=ContinueOnFailure

&AUTOBILLOUTSTANDINGAMT=AddToNextBilling"

Create Credit Card Recurring Payments Profile Response

RESULT=0

&RESPMSG=Approved

&RPREF=RRRF0A08BD40

&PROFILEID=I-98E07417J1765691F

&CORRELATIONID=63ba4af1de909


18


Example: Creating a Recurring Payments Profile For Billing a PayPal Account

Example: Creating a Recurring Payments Profile For Billing a

PayPal Account

To create a Recurring Payments profile for a PayPal account, you must call Set Express

Checkout and pass the following parameter information: z

The billing type value RecurringPayments (required)

A description of the goods or services associated with the agreement (required) z

The example below passes the billing type and descriptions for two billing agreements. The parameters required to create the Recuring Payments profile are in boldface.

Set Express Checkout Request

"TRXTYPE=A

&USER=User

&TENDER=P

&PARTNER=PayPal

&VENDOR=Vendor

&PWD=Pwd

&ACTION=S

&AMT=10.00

&RETURNURL=http://...

&CANCELURL=http://...

&CURRENCY=USD

&L_BILLINGTYPE0=RecurringPayments

&L_BILLINGAGREEMENTDESCRIPTION0=Time magazine

&L_BILLINGTYPE1=RecurringPayments

&L_BILLINGAGREEMENTDESCRIPTION1=Newsweek magazine

&SHIPTOCITY=San Jose

&SHIPTOCOUNTRY=USA US

&SHIPTOSTATE=CA

&SHIPTOSTREET=1 Main St

&SHIPTOZIP=95131

&PAYMENTTYPE=any"

Set Express Checkout Response

RESULT=0

&RESPMSG=Approved

&TOKEN=EC-5FA74536B1724550T

&CORRELATIONID=e8f1f97944872

When creating the recurring payments profile with ACTION=A, you pass the TOKEN returned in the Set Express Checkout response, along with the following parameters: z

The L_BILLINGAGREEMENTDESCRIPTIONn string (exactly as it was passed in the call to

Set Express Checkout) for the profile you want to create z z

TENDER type P to identify the recurring payments as billing a PayPal account

The TOKEN returned in the Set Express Checkout response




The following example creates a recurring payments profile that bills a PayPal account.

Parameters required for creating the PayPal account recurring payments profile are in boldface. The example allows four failed scheduled payments before PayPal deactivates the profile.

Create Express Checkout Recurring Payments Profile Request

"TRXTYPE=R

&TENDER=P

&ACTION=A

&USER= ser

&VENDOR= Vendor

&PWD=Pwd

&PARTNER=PayPal

&TOKEN=EC-5FA74536B1724550T

&PROFILENAME=J Smith Profile

&AMT=30.00

&START=10272010

&TERM=5

&PAYPERIOD=WEEK

&CURRENCY=USD

&MAXFAILPAYMENTS=4

&COMPANYNAME=PayPal

&FIRSTNAME=J

&LASTNAME=Smith

&STREET=1 Main St

&ZIP=95131

&CITY=San Jose

&STATE=CA

&COUNTRY=USA

&[email protected]

&PHONENUM=4082354545

&FREIGHTAMT=30.00

&TAXAMT=34.00

&AUTOBILLOUTSTANDINGAMT=NoAutoBill

&L_BILLINGAGREEMENTDESCRIPTION1=Newsweek magazine"

Create Express Checkout Recurring Payments Profile Response

RESULT=0

&RESPMSG=Approved

&RPREF=RTTF0D917B7D

&PROFILEID=I-EANRHMUGWESK

&CORRELATIONID=350f1e135ab53





3

Deactivating and Reactivating

Recurring Payments Profiles

You can deactivate (suspend) and reactivate recurring payments profiles as a service to buyers who would like to have their billing suspended while away on vacation, for example.

N

O TE

: The Payflow SDK does not support canceling (terminating) recurring payments profiles programmatically. You must cancel a profile on the PayPal website. For details, see

Chapter 4, “Canceling Recurring Payments Profiles

.”

Deactivating a Profile Through Your PayPal Account

To deactivate a profile through your PayPal account:

1. Log in to your PayPal account.

2. Click the Recurring Payments link either in the Tools section in the Account Overview page or on the Profile page.

3. On the Recurring payments overview page that appears, browse for the profile.

4. In the search results, click the profile Details.

The Recurring Payments Profile Details page appears.

5. In the Profile Status section (shown in

Figure 3.1 ), click Suspend to deactivate the

recurring payments profile.


Deactivating and Reactivating Recurring Payments Profiles

Reactivating a Profile Through Your PayPal Account

F IGURE 3.1 Profile Status section of Recurring Payments Profile Details page

22

6. The Suspend a recurring payment profile page appears.

7. Click Suspend to deactivate the profile or Cancel to cancel the action.

Reactivating a Profile Through Your PayPal Account

To reactivate a deactivated (suspended) profile through your PayPal account:


2. Click the Recurring Payments link either in the Tools section of the Account Overview page or on the Profile page.




5. In the Profile Status section, click Reactivate to reactivate the recurring payments profile.

The Review a recurring payment profile page appears.



Deactivating a Profile Programmatically

6. Click Submit to reactivate the profile or Cancel to cancel the action.

Upon successful reactivation, the Reactivate a profile page displays the message confirming profile reactivation.

Deactivating a Profile Programmatically

You can deactivate a recurring payments profile programmatically using the Payflow SDK.

Table 3.1 lists the parameters required in a request to deactivate a profile. Provide values for

the following parameters. The ACTION value is always C.

T ABLE 3.1 Parameters Required to Deactivate a Profile

Parameter

TRXTYPE

TENDER

ACTION=C

ORIGPROFILEID

Notes


The value C for credit card or P for PayPal.

The value C for deactivating a recurring payments profile.

Profile ID of the profile to deactivate.

Reactivating a Profile Programmatically

You can reactivate a recurring payments profile programmatically using the Payflow SDK.

Table 3.2 lists the parameters required in a request to reactivate a profile. Provide values for

the following parameters. The ACTION value is always R.

T ABLE 3.2 Parameters Required to Reactivate a Profile

Parameter

TRXTYPE

TENDER

ACTION

ORIGPROFILEID

Notes



The value R for reactivating a recurring payments profile.

Profile ID of the profile to reactivate.

Example of Deactivating a Profile

The following example request deactivates (suspends) a profile.


24


Example of Reactivating a Profile

"USER=SuperMerchant


&PARTNER=PayPal

&TRXTYPE=R

&TENDER=C

&ACTION=C

&ORIGPROFILEID=I-26F60651P9935932P"

This is the example response.

RESULT=0

&RESPMSG=Approved

&RPREF=RRRF0A08BD4D

&PROFILEID=I-26F60651P9935932P

&CORRELATIONID=f87c07be9f95

Example of Reactivating a Profile

The following example request reactivates a profile.

"USER=SuperMerchant


&PARTNER=PayPal

&TRXTYPE=R

&TENDER=C

&ACTION=R


This is the example response.

RESULT=0

&RESPMSG=Approved

&RPREF=RRRF0A08BD4F


&CORRELATIONID=c582c009acceb


4

Canceling Recurring Payments

Profiles

You cancel (terminate) a profile by browsing for it from the Recurring Payments Overview page on the PayPal website and manually canceling it, as described below.

N

O TE

: You cannot cancel recurring payments profiles programmatically.

Canceling Recurring Payments Profiles Through Your PayPal

Account

To cancel a recurring payments profile:

1. Log in to your PayPal business account.


The Recurring Payments Overview page appears, as shown in Figure 4.1 .


3. Click the Browse for profiles link. Alternately, if you know the profile ID of the profile you want to cancel, click the Search for profiles by ID link.


Canceling Recurring Payments Profiles

Canceling Recurring Payments Profiles Through Your PayPal Account



5. In the Profile Status section of the page (shown in Figure 4.2

), click Cancel to cancel the profile.

F IGURE 4.2 Profile Status section of Recurring Payments Pofile Details page

26

You are prompted to confirm canceling the profile. Upon confirmation, the Profile Status

History page appears (see

Figure 4.3 ) showing the status history of the profile.




F IGURE 4.3 Profile Status History page





5

Getting Recurring Payments

Profile Details

You can request to get details of a profile. Along with the information that you specified in the request, a successful response returns the following summary information: z z z

Subscriber’s name

Profile status

Number of billing cycles as defined by PAYPERIOD completed during the current active billing period z z z z z

Number of payments left to be billed

Current outstanding balance

Total number of failed payments

Amount of the last successful payment received

Last four digits of the buyer’s credit card number for credit card recurring billing

N

O TE

: Only the last 4 digits of the credit card account number are returned and CVV2 is never returned.

Profile Status

A recurring payments profile can have one of the following status values: z z z z

ACTIVE

PENDING

DEACTIVATED BY MERCHANT (profile is suspended)

PROFILE TERMINATED (profile is canceled) z

EXPIRED

To view the status of a profile, see “ Obtaining Profile Details Through Your PayPal Account

.”

If the profile is successfully created, its status is ACTIVE. If, however, a non-recurring initial payment fails and the FAILEDINITAMTACTION parameter is set to CancelOnFailure in the request to create the profile, the profile is created with a status of PENDING until the initial payment either completes successfully or fails.

You can reactivate a deactivated (suspended) profile. See Chapter 3, “Deactivating and

Reactivating Recurring Payments Profiles ,” for details.

You can cancel (terminate) a profile through your PayPal account. See

Chapter 4, “Canceling

Recurring Payments Profiles

,” for details.


Getting Recurring Payments Profile Details

Obtaining Profile Details Through Your PayPal Account

A profile has a status of EXPIRED when the total billing cycles for the optional trial payment period and the regular payment period have been completed.

Obtaining Profile Details Through Your PayPal Account

To obtain details of a profile through your PayPal account:

1. Log in to your PayPal Business account.


3. On the Recurring payments overview page, browse for the profile.




Figure 5.1 ), click the View Status History link to

view the status history of a profile.



Obtaining Profile Details Programmatically


Obtaining Profile Details Programmatically

You can obtain profile details programmatically using the Payflow SDK.

Table 5.1 lists the

Payflow parameters required in the request string to obtain the details of a recurring payments profile.The ACTION value is always I.

T ABLE 5.1 Required Parameters in a Profile Status Inquiry Request

Parameter

TRXTYPE

TENDER

ACTION

ORIGPROFILEID

Notes



The value I for inquiring about recurring payments profile details.

Profile ID of the profile to deactivate.

Example of Getting Recurring Payments Profile Details

The following example Payflow parameter string requests the details of a credit card recurring payments profile.


32


Example of Getting Recurring Payments Profile Details

"USER=SuperMerchant


&PARTNER=PayPal

&TRXTYPE=R

&TENDER=C

&ACTION=I


This is the response to the request for profile details.

RESULT=0

&RESPMSG=Approved


&CORRELATIONID=d73839395ccee

&PROFILENAME=JSmith

&ACCT=510510511105105100

&START=10272008

&TERM=2

&PAYPERIOD=DAY

&STATUS=DEACTIVATED BY MERCHANT

&PAYMENTSLEFT=2&END=

&NUMFAILPAYMENTS=0

&CURRENCY=USD

&MAXFAILPAYMENTS=4

&[email protected]

&DESC=TO SEE CRICKET MATCHES

&FIRSTNAME=John

&LASTNAME=Smith

&STREET=1 Main St&ZIP=95131

&CITY=San Jose

&STATE=CA

&COUNTRY=US

&FREIGHTAMT=56.00

&TAXAMT=34.00

&AUTOBILLOUTAMT=NoAutoBill


6


You can request to bill the outstanding amount of a profile to immediately bill the buyer for the current past due or outstanding amount for a recurring payments profile. To bill the outstanding amount: z

The profile status must be active or deactivated (suspended). z z

N

O TE

: You cannot activate a suspended profile in the request for billing the outstanding amount. You must reactivate with the reactivate recurring payments profile request.

See

“Deactivating and Reactivating Recurring Payments Profiles” on page 21 .

The profile must have a non-zero outstanding balance.

The amount of the payment cannot exceed the outstanding amount for the profile. z

The request to bill the outstanding amount cannot be within 24 hours of a regularly scheduled payment for this profile.

Log in to PayPal to determine the success or failure of the outstanding payment. See

Chapter 5, “Getting Recurring Payments Profile Details

,” for information on how to obtain profile details.


You can bill the outstanding amount of a profile through the Payflow SDK. Table 6.1

lists the parameters required in a request to bill the outstanding amount.The ACTION value is always P.

T ABLE 6.1 Parameters Required to Retry a Transaction

Parameter

TRXTYPE

ACTION

ORIGPROFILEID

Notes


The value P for billing the outstanding amount.

Profile ID of the profile for which the outstanding amount will be billed.


Billing the Outstanding Amount

Billing the Outstanding Amount


7

Updating Recurring Payments

Profiles

You can update a recurring payments profile by sending a subset of the profile parameters in a request to modify the profile.

N

O TE

: You can only update active or deactivated (suspended) profiles.

You can only update specific information about the profile, including the following: z

Subscriber name or address (see

Updating Addresses )

z z z z

Additional billing cycles

Billing amount, tax amount, or shipping amount (see

Updating Addresses )

Past due or outstanding amount

Whether to bill the outstanding amount with the next billing cycle z z z

Maximum number of failed payments allowed

Buyer’s credit card information (see

Updating Addresses

for a restriction)

Profile description and reference

N

O TE

: You cannot modify the payment period (PAYPERIOD) of a profile.

N

O TE

: For recurring payments with Express Checkout, certain updates, such as billing amount, are not allowed within 3 days of the scheduled billing date, and an error is returned.

Updating Addresses

When you update the following addresses, you must enter all of address fields, not just those that are changing: z

Subscriber shipping address

Credit card billing address z

If, for example, you want to update the street address for shipping, you must specify all of the shipping address fields listed in

Table 8.1 in Chapter 8, “Recurring Payments Reference ,” not

just the SHIPTOSTREET parameter.

Updating a Profile Through Your PayPal Account

To update a profile through your PayPal account:



Updating Recurring Payments Profiles

Updating a Profile Through Your PayPal Account






Figure 7.1 ), click Modify to update the recurring

payments profile.

The Update a recurring payments profile page appears.


36

6. Edit the page as necessary, and click Continue or Cancel to cancel the action.

7. Review your changes on the Review a Recurring Payment profile page. Then click Submit to update the profile or Cancel to cancel the profile changes.

8. Follow the links on the Recurring payments profile updated page to review the profile details or to perform other profile tasks listed.



Updating Profiles Programmatically

Updating Profiles Programmatically

You can update profiles using the Payflow SDK. Table 7.1

lists the parameters you are required to send in a request to update a profile. The ACTION value is always M.

T ABLE 7.1 Parameters Required to Update Profiles

TRXTYPE

TENDER

ACTION

ORIGPROFILEID



The value M for updating the profile.

Profile ID of the profile to update.

Example of Updating Profiles

The following example Payflow parameter string is a request to update the shipping address for profile ID number I-26F60651P9935932P. Updating the shipping address requires providing values for each of the SHIPTO* parameters.

"USER= SuperMerchant

&PWD= SuperUserPassword

&PARTNER= PayPal

&TRXTYPE=R

&TENDER=C

&ACTION=M

&SHIPTOFIRSTNAME=John

&SHIPTOMIDDLENAME=J

&SHIPTOLASTNAME=SMITH

&SHIPTOSTREET=1 Main St

&SHIPTOCITY=San Jose

&SHIPTOSTATE=CA

&SHIPTOCOUNTRY=US

&SHIPTOZIP=95155

&ORIGPROFILEID=I-26F60651P9935932P

&PROFILENAME= JSmith

&EMAIL= [email protected]

&

COMPANYNAME=PayPal"

The following is an example response to the request to update the profile.

RESULT=0

&RESPMSG=Approved

&RPREF=RRRF0A08BD4B


&CORRELATIONID=95d7b814512bb



Example of Updating Profiles


8

Recurring Payments Reference

Creating Recurring Payments Profiles (ACTION=A)

T ABLE 8.1 Create Recurring Payments Profile Request Parameters

Parameter

TRXTYPE

ACTION

TENDER

TOKEN

PROFILENAME

L_BILLINGAGREEMENTD

ESCRIPTIONn

Description

(Required) The transaction type R for recurring payments profile request.

Character length and limitations: One alpha character.

(Required) The value A for creating a new recurring payments profile.


(Required) The tender type. Is one of the following values: z z

C = credit card

P = PayPal


(Required when Tender is P) The TOKEN returned in the Set Express

Checkout response when the Set Express Checkout request passes the billing type as RecurringPayments. To create a PayPal recurring payments profile, you must pass the following: z z

One L_BILLINGAGREEMENTDESCRIPTIONn string (see below) exactly as passed in the Set Express Checkout request

-- OR --

The BA_DESC string (see below) exactly as passed in the Set Express

Checkout request z z

TENDER=P

TOKEN returned in the Set Express Checkout response

(Required) A unique name for referencing the recurring payments profile.

Character length and limitations: 127 alphanumeric characters.

(Optional) See TOKEN.. Describes the recurring payment product or service the buyer is purchasing with a PayPal account. The string value is exactly as it was passed in the Set Express Checkout request.

Example: ‘One-year subscription to Time magazine’



40

8

Recurring Payments Reference

Creating Recurring Payments Profiles (ACTION=A)


Parameter

BA_DESC

ACCT

EXPDATE

AMT

START

TERM

Description

(Optional) See TOKEN. Describes the recurring payment product or service the buyer is purchasing with a PayPal account. The string value is exactly as it was passed in the Set Express Checkout request.

Example: ‘One-year subscription to Time magazine’


(Required for credit card recurring billing) Credit card number.


(Required for credit card recurring billing) Credit card expiration date.

Character length and limitations: Four numeric characters in the format

MMYY.

(Required) Amount to be billed per regular payment period, not including shipping and tax.

N

O TE

: All amounts in the profile creation request must be in the same currency.

Limitations: Nine numeric characers plus decimal (.) character. No currency symbol. 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.

(Required) Beginning date for the recurring payments cycle used to calculate when payments should be made. Use tomorrow’s date or a date in the future.

Character length and limitations: Eight numeric characters in the format

MMDDYYYY.

(Required) The total number of regular payment periods over the life of the agreement. If there are 36 monthly payments, for example, TERM is

36.

Character length and limitations: Numeric. A value of 0 means that payments should continue until the profile is deactivated (suspended).




8


Parameter

PAYPERIOD

CVV2

CURRENCY

MAXFAILEDPAYMENTS

Description

(Required) How often the regular payment occurs. On the PayPal website, PAYPERIOD is called payment cycle. Values are: z

DAY: Every Day.

z z

WEEK: Weekly - Every week on the same day of the week as the first payment.

BIWK: Every Two Weeks - Every other week on the same day of the week as the first payment.

z z

SMMO: Twice Every Month - The 1st and 15th of the month. Results in 24 payments per year. SMMO can start on 1st to 15th of the month, second payment 15 days later or on the last day of the month.

FRWK: Every Four Weeks - Every 28 days from the previous payment date beginning with the first payment date. Results in 13 payments per year.

z z z z

MONT: Monthly - Every month on the same date as the first payment.

Results in 12 payments per year.

QTER: Quarterly - Every three months on the same date as the first payment.

SMYR: Twice Every Year - Every six months on the same date as the first payment.

YEAR: Yearly - Every 12 months on the same date as the first payment.

(Optional) Card security code.

Character length and limitations: Three to four alphanumeric characters.

(Required) One of the following three-character currency codes: z z z z z z

USD

EUR

GBP

CAD

JPY

AUD

(Optional) The number of scheduled payments for which the transaction is allowed to fail before PayPal deactivates (suspends) a profile. The default is 0.

For example, if you specify 3, then PayPal allows a maximum of three failed payment periods (possibly with multiple retries during each payment period, and possibly nonconsecutive periods). If the transaction is not approved for any three periods (months in the example), then

PayPal deactivates the profile.

I

MP O R TAN T

: If you do not specify a value, the default value of 0

(zero) specifies no limit. Retry attempts occur until the

TERM is met.

Character length and limitations: Numeric characters.


42

8




Parameter

EMAIL

DESC

COMPANYNAME

OPTIONALTRXAMT

FIRSTNAME

MIDDLENAME

LASTNAME

NAME

STREET

ZIP

CITY

STATE

COUNTRY

Description

(Optional) Buyer’s email address. This value is used when sending email receipts to buyers.


(Optional) Description of the goods or services being purchased.


(Optional) Company name associated with this profile.


(Optional) Initial non-recurring payment amount due immediately upon profile creation. Use an initial amount for enrollment or setup fees.

N

O TE



1199.95 not 1,199.95.

(Optional) Bill-to first name. See NAME.


(Optional) Bill-to middle name.


(Optional) Bill-to last name.


(Optional) The subscriber’s name. When NAME is passed, do not pass

FIRSTNAME. If both NAME and FIRSTNAME are passed, either one of the values is considered as the subscriber’s name. If FIRSTNAME only is passed, it alone is considered the subscriber’s name.


(Optional) Bill-to street.

Character length and limitations: 150 characters.

(Optional) Bill-to postal code.


(Optional) Bill-to city.


(Optional) Bill-to state.


(Optional) Bill-to country.

Character length and limitations: Two characters.




8


Parameter

PHONENUM

SHIPTOFIRSTNAME

SHIPTOMIDDLENAME

SHIPTOLASTNAME

SHIPTOSTREET

SHIPTOCITY

SHIPTOSTATE

SHIPTOCOUNTRY

SHIPTOZIP

CARDSTART

CARDISSUE

FREIGHTAMT

Description

(Optional) Telephone number.


(Optional) Ship-to first name.


(Optional) Ship-to middle name.


(Optional) Ship-to last name.


(Optional) Ship-to street.


(Optional) Ship-to city.


(Optional) Ship-to state.


(Optional) Ship-to country.


(Optional) Ship-to postal code.


(Optional) Date that Switch or Solo card was issued.

N

O TE

: For a Switch or Solo transaction to be approved, either

CARDSTART or CARDISSUE must be present.

Character length and limitations: MMYY format. For example, 0308 represents March 2008.

(Optional) Issue number of Switch or Solo card.

N

O TE



Character length and limitations: Eight alphanumeric characters.

(Optional) Total shipping amount for this order.

N

O TE

: You must set CURRENCY to one of the supported three-character currency codes.


1199.95 not 1,199.95.


44

8




Parameter

TAXAMT

TRIALSTART

TRIALTERM

TRIALPAYPERIOD

Description

(Optional) Total tax amount for this order.

N

O TE



1199.95 not 1,199.95.

(Optional) The billing start date of the trial payment period.

N

O TE

: If you set any of the trial payment period parameters, you must set all of them in the request to create a recurring payments profile.

Character length and limitations: 8 numeric characters in the format

MMDDYYYY.

(Optional) The total number of trial payment periods over the life of the agreement. If there are 36 monthly trial payments, for example,

TRIALTERM is 36.


(Optional) How often the trial payment occurs. On the PayPal website,

TRIALPAYPERIOD is called payment cycle. Values are: z

DAY: Every day.

z z



z z



z z z z









8


Parameter

TRIALAMT

TRIALFREIGHTAMT

TRIALTAXAMT

Description

(Optional) Amount of the trial payment, not including shipping and tax.

N

O TE


If you create a trial payment period, TRIALAMT is required. Otherwise it is optional.


1199.95 not 1,199.95.

(Optional) Shipping amount for each trial payment.


1199.95 not 1,199.95.

(Optional) Tax amount for each trial payment.


1199.95 not 1,199.95.

FAILEDINITAMTACTION (Optional) By default, PayPal deactivates (suspends) the pending profile in the event that the initial payment amount fails. You can override this default behavior by setting this parameter to ContinueOnFailure, which indicates that if the initial payment amount fails, PayPal should add the failed payment amount to the outstanding balance for this recurring payment profile.

When this parameter is set to ContinueOnFailure, PayPal returns a successful recurring payments profile response and activates the recurring payments profile for scheduled billing immediately. You should check your PayPal account for updates to the profile’s payment status.

If this parameter is not set or is set to CancelOnFailure, PayPal creates the recurring payments profile but does not place it in pending status until the initial payment is completed. If the initial payment clears, PayPal deactivates the profile’s pending status. You should check your account in PayPal to verify the profile status.

One of the following values: z

ContinueOnFailure z

CancelOnFailure


46

8


Updating Recurring Payments Profiles (ACTION=M)


Parameter

AUTOBILLOUTSTANDING

AMT

Description

(Optional) This parameter indicates whether or not you would like

PayPal to automatically roll over the outstanding balance amount in the next payment.


NoAutoBill z

AddToNextBilling

T ABLE 8.2 Create Recurring Payments Profile Response

Parameter

PROFILEID

STATUS

Description

A unique identifier for future reference to the details of this recurring payment.


The status of the profile. Is one of the following values: z

ACTIVE z z z z

DEACTIVATED BY MERCHANT

EXPIRED

PENDING

PROFILE TERMINATED

Updating Recurring Payments Profiles (ACTION=M)

T ABLE 8.3 Update Recurring Payments Profile Request Parameters

Parameter

TRXTYPE

TENDER

ACTION

ORIGPROFILEID

Description



(Required) The tender type. Is one of the following values: z

C = credit card z

P = PayPal


(Required) The Action value M for modifying the recurring profile.


(Required) Profile ID of the profile to reactivate.





8


Parameter

NOTE

PROFILENAME

ACCT

EXPDATE

AMT

START

TERM

Description

(Optional) If not provided, the default string is “Modify Profile”


(Optional) A unique name for referencing the profile.


(Required for credit card recurring billing) Credit card number.


(Required for credit card recurring billing) Credit card expiration date.

Character length and limitations: Four numeric characters in the format

MMYY.

(Required) Amount to be billed per regular payment period, not including shipping and tax.

N

O TE



1199.95 not 1,199.95.

(Required) Beginning date for the recurring payments cycle used to calculate when payments should be made. Use tomorrow’s date or a date in the future.


MMDDYYYY.

(Required) The total number of regular payment periods over the life of the agreement. If there are 36 monthly payments, TERM is 36.



48

8




Parameter

PAYPERIOD

ADDITIONALBILLINGCY

CLES

CVV2

CURRENCY

Description

(Required) How often the regular payment occurs. Values are: z

DAY: Every day.

z z



z z



z z z z






(Optional) Additional billing cycles as defined by PAYPERIOD to add to this profile. If, for example, the number of billing cycles in the current

TERM is 36, setting ADDITIONALBILLINGCYCLES to 2 increases TERM to 38.

(Optional) Card security code.

Character length and limitations: Three to four numeric characters.

(Required) One of the following three-character currency codes: z z z z z z

USD

EUR

GBP

CAD

JPY

AUD




8


Parameter

MAXFAILPAYMENTS

EMAIL

DESC

COMPANYNAME

OPTIONALTRXAMT

FIRSTNAME

MIDDLENAME

LASTNAME

NAME

Description

(Optional) The number of scheduled payments for which the transaction is allowed to fail before PayPal deactivates (suspends) a profile. The default is 0.

For example, if you specify 3, then PayPal allows a maximum of three failed payment periods (possibly with multiple retries during each payment period, and possibly nonconsecutive periods). If the transaction is not approved for any three periods (months in the example), then

PayPal deactivates the profile.

I

MP O R TAN T



TERM is met.


(Optional) Buyer’s email address. This value is used when sending email receipts to buyers.


(Optional) Description of the goods or services being purchased.


(Optional) Company name associated with this profile.


(Optional) Amount to be billed per regular payment period, not including shipping and tax.

N

O TE



1199.95 not 1,199.95.

(Optional) Bill-to first name. See NAME.


(Optional) Bill-to middle name.


(Optional) Bill-to last name.


(Optional) The subscriber’s name. When NAME is passed, do not pass

FIRSTNAME. If both NAME and FIRSTNAME are passed, either one of the values is considered as the subscriber’s name. If FIRSTNAME only is passed, it alone is considered the subscriber’s name.



50

8




Parameter

STREET

ZIP

CITY

STATE

COUNTRY

PHONENUM

SHIPTOFIRSTNAME

SHIPTOMIDDLENAME

SHIPTOLASTNAME

SHIPTOSTREET

SHIPTOCITY

SHIPTOSTATE

SHIPTOCOUNTRY

SHIPTOZIP

CARDSTART

Description

(Optional) Bill-to street.


(Optional) Bill-to postal code.


(Optional) Bill-to city.


(Optional) Bill-to state.


(Optional) Bill-to country.


(Optional) Telephone number.


(Optional) Ship-to first name.


(Optional) Ship-to middle name.


(Optional) Ship-to last name.


(Optional) Ship-to street.


(Optional) Ship-to city.


(Optional) Ship-to state.


(Optional) Ship-to country.


(Optional) Ship-to postal code.


(Optional) Date that Switch or Solo card was issued.

N

O TE







8


Parameter

CARDISSUE

TAXAMT

Description

(Optional) Issue number of Switch or Solo card.

N

O TE



Character length and limitations: Two alphanumeric characters.

(Optional) Total tax amount for this order.

N

O TE



1199.95 not 1,199.95.

FAILEDINITAMTACTION (Optional) By default, PayPal deactivates (suspends) the pending profile in the event that the initial payment amount fails. You can override this default behavior by setting this parameter to ContinueOnFailure, which indicates that if the initial payment amount fails, PayPal should add the failed payment amount to the outstanding balance for this recurring payment profile.


If this parameter is not set or is set to CancelOnFailure, PayPal creates the recurring payments profile but does not place it in pending status until the initial payment is completed. If the initial payment clears,

PayPal deactivates the profile’s pending status. You should check your

PayPal account to verify the profile’s status.


ContinueOnFailure z

CancelOnFailure

OUTSTANDINGAMT (Optional) The current past due amount for this profile.


1199.95 not 1,199.95.

AUTOBILLOUTAMT (Optional) This parameter indicates whether or not you would like

PayPal to automatically bill the outstanding balance amount in the next payment.


NoAutoBill z

AddToNextBilling


52

8


Deactivating Recurring Payments Profiles (ACTION=C)

T ABLE 8.4 Update Recurring Payments Profile Response

Parameter

PROFILEID

Description



Deactivating Recurring Payments Profiles (ACTION=C)

T ABLE 8.5 Deactivate Recurring Payments Profile Request Parameters

Parameter

TRXTYPE

TENDER

ACTION

ORIGPROFILEID

NOTE

Description




C = credit card

P = PayPal


(Required) The Action value C for deactivating (suspending) the recurring profile.


(Required) Profile ID of the profile to deactivate (suspend).


(Optional) Notes about the action. If not provided, the default string is

“Cancel Profile”


T ABLE 8.6 Deactivate Recurring Payments Profile Response

Parameter

PROFILEID

Description





Reactivating Recurring Payments Profiles (ACTION=R)

8

Reactivating Recurring Payments Profiles (ACTION=R)

T ABLE 8.7 Reactivate Recurring Payments Profile Request Parameters

Parameter

TRXTYPE

TENDER

ACTION

ORIGPROFILEID

NOTE

Description




C = credit card

P = PayPal


(Required) The Action value R for reactivating the recurring profile.


(Required) Profile ID of the profile to reactivate.


(Optional) Notes about the action. If not provided in the request string, the default string is “Reactivate Profile”.


T ABLE 8.8 Reactivate Recurring Payments Profile Response

Parameter

PROFILEID

Description



Viewing Recurring Payments Profile Details (ACTION=I)

T ABLE 8.9 View Recurring Payments Profile Details Request Parameters

Parameter

TRXTYPE

Description




54

8


Viewing Recurring Payments Profile Details (ACTION=I)

T ABLE 8.9 View Recurring Payments Profile Details Request Parameters

Parameter

TENDER

ACTION

ORIGPROFILEID

Description

(Required) The tender type. Is one of the following values: z

C = credit card z

P = PayPal


(Required) The Action value I for viewing recurring payments profile.


(Required) The profile ID of the profile to cancel or reactivate.


T ABLE 8.10 View Recurring Payments Profile Details Response

Parameter

TRXTYPE

TENDER

PROFILEID

PROFILENAME

ACCT

EXPDATE

AMT

START

Description

The transaction type R for recurring payments profile request.


The tender type. Is one of the following values: z

C = credit card z

P = PayPal


A unique identifier for future reference to the details of this recurring payments profile.


A unique name for referencing the profile.


Credit card number for the credit card recurring payment.


Credit card expiration date for the credit card recurring payment.


Amount to be billed per regular payment period, not including shipping and tax.


1199.95 not 1,199.95.

Beginning date for the recurring payments cycle used to calculate when payments should be made. Use tomorrow’s date or a date in the future.

Character length and limitations: Eight numeric characters in the format

MMDDYYYY.




8


Parameter

TERM

PAYPERIOD

NUMCYCLESCOMPLETED

STATUS

PAYMENTSLEFT

NEXTPAYMENT

Description

The total number of regular payment periods over the life of the agreement. If there are 36 monthly payments, TERM is 36.


How often the payment occurs. On the PayPal website, PAYPERIOD is called payment cycle. Values are: z

DAY: Every day.

z z



z z



z z z z






The number of billing cycles, as defined by PAYPERIOD, completed in the current active TERM. A billing cycle is considered complete only after retry attempts to collect payment for the current billing cycle have failed.

Character length and limitations: Numeric.

One of the following values describing the current status of the profile: z

ACTIVE z

PROFILE TERMINATED z z z

DEACTIVATED BY MERCHANT

EXPIRED

PENDING

Number of payments left to be billed.


Date that the next payment is due.

Character length and limitations: MMDDYYYY format.


56

8




Parameter

CVV2MATCH

NUMFAILPAYMENTS

CURRENCY

MAXFAILPAYMENTS

EMAIL

DESC

COMPANYNAME

OPTIONALTRXAMT

FIRSTNAME

MIDDLENAME

Description

One of the following card security code match responses: z

Y = Match z z

N = No match

X = Unknown

Number of payments that failed.


One of the following three-character currency codes: z z z z z z

USD

EUR

GBP

CAD

JPY

AUD

The number of scheduled payments for which the transaction is allowed to fail before PayPal deactivates (suspends) a profile. The default is 0.

I

M P OR T A NT



TERM is met.


Buyer’s email address.


Description of the goods or services being purchased.


Company name associated with this profile.


Initial non-recurring payment amount due immediately upon profile creation. Use an initial amount for enrollment or setup fees.

N

O T E



1199.95 not 1,199.95.

Bill-to first name.


Bill-to middle name.





8


Parameter

LASTNAME

NAME

STREET

ZIP

CITY

STATE

COUNTRY

PHONENUM

SHIPTOFIRSTNAME

SHIPTOMIDDLENAME

SHIPTOLASTNAME

SHIPTOSTREET

SHIPTOZIP

SHIPTOCITY

SHIPTOSTATE

SHIPTOCOUNTRY

Description

Bill-to last name.


Subscriber’s name.


Bill-to street.


Bill-to postal code.


Bill-to city.


Bill-to state.


Bill-to country.


Telephone number.


Ship-to first name.


Ship-to middle name.


Ship-to last name.


Ship-to street.


Ship-to postal code.


Ship-to city.


Ship-to state.


Ship-to country.



58

8




Parameter

CARDSTART

CARDISSUE

FREIGHTAMT

TAXAMT

TRIALSTART

TRIALTERM

Description

Date that Switch or Solo card was issued.

N

O T E




Issue number of Switch or Solo card.

N

O T E



Character length and limitations: Eight alphanumeric characters.

Total shipping amount for this order.


1199.95 not 1,199.95.

Total tax amount for this order.


1199.95 not 1,199.95.

The billing start date of the trial payment period.

N

O T E

: If you set any of the trial payment period parameters, you must set all of them in the request to create a recurring payments profile.


MMDDYYYY.

The total number of trial payment periods over the life of the agreement. If there are 36 monthly trial payments, for example,

TRIALTERM is 36.





8


Parameter

TRIALPAYPERIOD

TRIALAMT

TRIALFREIGHTAMT

TRIALTAXAMT

Description

How often the trial payment occurs. On the PayPal website,

TRIALPAYPERIOD is called payment cycle. Values are: z

DAY: Every day.

z z



z z



z z z z






Amount of the trial payment, not including shipping and tax.

N

O T E


If you create a trial payment period, TRIALAMT is required. Otherwise it is optional.


1199.95 not 1,199.95.

Shipping amount for each trial payment.


1199.95 not 1,199.95.

Tax amount for each trial payment.


1199.95 not 1,199.95.


60

8




Parameter Description

FAILEDINITAMTACTION By default, PayPal deactivates (suspends) the pending profile in the event that the initial payment amount fails. You can override this default behavior by setting this parameter to ContinueOnFailure, which indicates that if the initial payment amount fails, PayPal should add the failed payment amount to the outstanding balance for this recurring payment profile.


If this parameter is not set or is set to CancelOnFailure, PayPal creates the recurring payments profile but does not place it in pending status until the initial payment is completed. If the initial payment clears, PayPal cancels the profile’s pending status. You should check your PayPal account to verify the profile’s status.


ContinueOnFailure z

CancelOnFailure

OUTSTANDINGAMT The current past due amount for this profile.


1199.95 not 1,199.95.

LASTPAYMENTAMT

AUTOBILLOUTAMT

Amount of the last successful payment received for this profile.


1199.95 not 1,199.95.

This parameter indicates whether or not you would like PayPal to automatically roll over the outstanding balance amount in the next payment.


NoAutoBill z

AddToNextBilling



Billing Outstanding Amount Request (ACTION=P)

8

Billing Outstanding Amount Request (ACTION=P)

T ABLE 8.11 Bill Outstanding Amount Request Parameters

Parameter

TRXTYPE

ACTION

ORIGPROFILEID

AMT

CURRENCY

NOTE

Description



(Required) The Action value P for billing outstanding amount.


(Required) Profile ID of the profile to bill outstanding amount.


(Optional) Amount to be billed per regular payment period, not including shipping and tax.

N

O TE



1199.95 not 1,199.95.

(Optional) One of the following three-character currency codes: z z z z z z

USD

EUR

GBP

CAD

JPY

AUD

(Optional) Notes about the action. If not provided, the following default string is sent:

“This is a recurring payment”


T ABLE 8.12 Bill Outstanding Amount Response

Parameter

PROFILEID

Description




8


Billing Outstanding Amount Request (ACTION=P)


Index

A

ACCT 14, 40, 47, 54

ACTION 39, 46, 52, 53, 54, 61

ACTION=A 14

ACTION=C 23, 31, 33, 37

ACTIVE 29

ADDITIONALBILLINGCYCLES 48

AMT 14, 15, 40, 47, 54, 61

AUTOBILLOUTAMT 51, 60

AUTOBILLOUTSTANDINGAMT 46

B

BA_DESC 14, 40

billilng credit cards 16 billing outstanding amount 16

required parameters 33 requirements 33

billing PayPal accounts 19

billing the outstanding amount 16

billing types

RecurringPayments 18

C

canceling recurring payments profiles 25

CancelOnFailure 16

card security code 41, 48

CARDISSUE 43, 51, 58

CARDSTART 43, 50, 58

CITY 42, 50, 57

COMPANYNAME 42, 49, 56

ContinueOnFailure 16

COUNTRY 42, 50, 57

creating recurring payments profiles 39

options for creating 14

required parameters 11

CURRENCY 41, 43, 48, 56, 61

CVV2 41, 48

CVV2MATCH 56

D

DEACTIVATED BY MERCHANT 29

deactivating profiles

parameters required 23

deactivating recurring payments profiles 21

DESC 42, 49, 56

E

EMAIL 42, 49, 56

EXPDATE 14, 40, 47, 54

EXPIRED 29

EXPIRED status 30

F

failed payment periods 41

FAILEDINITAMTACTION 16, 29, 45, 51, 60

FIRSTNAME 42, 49, 56

FREIGHTAMT 43, 58

G

getting recurring payments profile details 29


I

including a trial payment period 15 initial non-recurring payment parameters 15

L

L_BILLINGAGREEMENTDESCRIPTION 14

L_BILLINGAGREEMENTDESCRIPTIONn 39

LASTNAME 42, 49, 57

LASTPAYMENTAMT 60

limitations 9

M

MAXFAILEDPAYMENTS 16, 41

64

Index

MAXFAILPAYMENTS 49, 56

MIDDLENAME 42, 49, 56

N

NAME 42, 49, 57

NEXTPAYMENT 55

NOTE 47, 52, 53, 61

NUMCYCLESCOMPLETED 55

NUMFAILPAYMENTS 56

O

OPTIONALTRXAMT 15, 42, 49, 56

ORIGPROFILEID 46, 52, 53, 54, 61

outstanding balance 9

OUTSTANDINGAMT 51, 60

P

Payment 9 payment 9

payment cycle 41

PAYMENTSLEFT 55

PAYPERIOD 14, 15, 41, 48, 55

PENDING 29

PENDING status 29

pending status 45

PHONENUM 43, 50, 57 postal code 43, 57

profile creation date 9 profile ID 9 profile start date 9

PROFILE TERMINATED 29

PROFILEID 46, 52, 53, 54, 61

PROFILENAME 14, 39, 47, 54

R

reactivating profiles


reactivating recurring payments profiles 21, 53

recurring payments profile 9

recurring payments profiles 7

limitations 9

status values 29

RecurringPayments 18

regular payment period 9 defined 9

S

setting number of failed scheduled payments 16

SHIPTOCITY 43, 50, 57

SHIPTOCOUNTRY 43, 50, 57

SHIPTOFIRSTNAME 43, 50, 57

SHIPTOLASTNAME 43, 50, 57

SHIPTOMIDDLENAME 43, 50, 57

SHIPTOSTATE 43, 50, 57

SHIPTOSTREET 43, 50, 57

SHIPTOZIP 43, 50, 57

specifying a regular payment period 15 specifying an initial payment 15 specifying initial non-recurring payment 15 specifying regular pPayment period 15

START 14, 15, 40, 47, 54

STATE 42, 50, 57

STATUS 46, 55

STREET 42, 50, 57

suspending pending profiles 45, 51, 60

suspending profiles 41, 52

Switch or Solo cards 43, 50

Switch or Solo transactions 58

T

TAXAMT 44, 51, 58

telephone number 43

TENDER 39, 46, 52, 53, 54

TERM 14, 15, 40, 47, 55

Term 9

TOKEN 14, 39

trial payment period 9

parameters 15

trial period

defined 9

TRIALAMT 15, 45, 59

TRIALFREIGHTAMT 15, 45, 59

TRIALPAYPERIOD 15, 44, 59

TRIALSTART 15, 44, 58

TRIALTAXAMT 15, 45, 59

TRIALTERM 15, 44, 58

TRXTYPE 39, 46, 52, 53, 54, 61


U

updating recurring payments profiles 46

information that can be updated 35 required parameters 35 updating addresses 35

updating shipping address in profiles 37

V

viewing recurring payments profiles 53

Z

ZIP 42, 50, 57

Index


65

Index

66


No results