Home

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

1. Updating Recurring Payments Profiles ACTION M TABLE 8 3 Update Recurring Payments Profile Request Parameters Parameter Description TRXTYPE Required The transaction type R for recurring payments profile request Character length and limitations One alpha character TENDER Required The tender type Is one of the following values e C credit card e P PayPal Character length and limitations One alpha character ACTION Required The Action value M for modifying the recurring profile Character length and limitations One alpha character ORIGPROFILEID Required Profile ID of the profile to reactivate Character length and limitations 19 alphanumeric characters 46 Payflow Recurring Payments Developer s Guide Recurring Payments Reference E Updating Recurring Payments Profiles ACTION M TABLE 8 3 Update Recurring Payments Profile Request Parameters Parameter Description NOTE Optional If not provided the default string is Modify Profile Character length and limitations 256 characters PROF ILENAME Optional A unique name for referencing the profile Character length and limitations 128 alphanumeric characters ACCT Required for credit card recurring billing Credit card number Character length and limitations 19 alphanumeric characters EXPDATE Required for credit card recurring billing Credit card expiration date Character length a
2. ACTION Required The Action value C for deactivating suspending the recurring profile Character length and limitations One alpha character ORIGPROFILEID Required Profile ID of the profile to deactivate suspend Character length and limitations 19 alphanumeric characters NOTE Optional Notes about the action If not provided the default string is Cancel Profile Character length and limitations 256 characters TABLE 8 6 Deactivate Recurring Payments Profile Response Parameter Description PROFILEID A unique identifier for future reference to the details of this recurring payment Character length and limitations 19 alphanumeric characters 52 Payflow Recurring Payments Developer s Guide Recurring Payments Reference E Reactivating Recurring Payments Profiles ACTION R Reactivating Recurring Payments Profiles ACTION R TABLE 8 7 Reactivate Recurring Payments Profile Request Parameters Parameter Description TRXTYPE Required The transaction type R for recurring payments profile request Character length and limitations One alpha character TENDER Required The tender type Is one of the following values e C credit card e P PayPal Character length and limitations One alpha character ACTION Required The Action value R for reactivating the recurring profile Character length and limitations One alpha character ORIGPROFILEID Required Profile
3. Payflow Recurring Payments Developer s Guide 27 EH Canceling Recurring Payments Profiles Canceling Recurring Payments Profiles Through Your PayPal Account 28 Payflow Recurring Payments Developer s Guide 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 e Subscriber s name e Profile status e Number of billing cycles as defined by PAYPERIOD completed during the current active billing period e Number of payments left to be billed e Current outstanding balance e Total number of failed payments e Amount of the last successful payment received e Last four digits of the buyer s credit card number for credit card recurring billing Note 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 e ACTIVE e PENDING e DEACTIVATED BY MERCHANT profile is suspended e PROFILE TERMINATED profile is canceled e 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 FATLEDINITAMTACTION parameter is set to Cancel OnFailure
4. Parameter Description PHONENUM Optional Telephone number Character length and limitations 20 alphanumeric characters SHIPTOFIRSTNAME Optional Ship to first name Character length and limitations 30 alphanumeric characters SHIPTOMIDDLENAI T Optional Ship to middle name Character length and limitations 30 alphanumeric characters SHIPTOLASTNAME Optional Ship to last name Character length and limitations 30 alphanumeric characters SHIPTOSTREET Optional Ship to street Character length and limitations 150 characters SHIPTOCITY Optional Ship to city Character length and limitations 45 characters SHIPTOSTATE Optional Ship to state Character length and limitations 45 characters SHIPTOCOUNTRY Optional Ship to country Character length and limitations Two characters SHIPTOZIP Optional Ship to postal code Character length and limitations 10 characters CARDSTART Optional Date that Switch or Solo card was issued NOTE 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 CARDISSUE Optional Issue number of Switch or Solo card NOTE For a Switch or Solo transaction to be approved either CARDSTART or CARDISSUE must be present Character length and limitations Eight alphanumeric characters FR
5. 2 a 16 Example Creating a Recurring Payments Profile For Billing a CreditCard 16 Example Creating a Recurring Payments Profile For Billing a PayPal Account 18 Chapter 3 Deactivating and Reactivating Recurring Payments Profiles Deactivating a Profile Through Your PayPal Account 21 Reactivating a Profile Through Your PayPal Account o 22 Deactivating a Profile Programmatically 0 o 23 Reactivating a Profile Programmatically 0 o 23 Example of Deactivating a Profile 0 o ee 23 Payflow Recurring Payments Developer s Guide Contents Example of Reactivating a Profile 0 0 o ee 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 Slats 42 uta a a a a A AI e a A 29 Obtaining Profile Details Through Your PayPal Account 30 Obtaining Profile Details Programmatically o o 31 Example of Getting Recurring Payments Profile Details 31 Chapter 6 Billing the Outstanding Amount 33 Billing the Outstanding Amount 2 aa a 33 Chapter 7 Updating Recurring Payments Profiles 35 Updating Addres
6. Parameter Notes TRXTYPE The value R for recurring payments TENDER The value C for credit card or P for PayPal ACTION The value R for reactivating a recurring payments profile ORIGPROFILEID Profile ID of the profile to reactivate Example of Deactivating a Profile The following example request deactivates suspends a profile Payflow Recurring Payments Developer s Guide 23 En Deactivating and Reactivating Recurring Payments Profiles Example of Reactivating a Profile USER SuperMerchant amp PWD SuperUserPassword amp PARTNER PayPal amp TRXTYPE R amp TENDER C amp ACTION C amp ORIGPROFILEID 1 26F60651P9935932P This is the example response RESULT 0 amp RESPMSG Approved amp RPREF RRRFOAO8BD4D amp PROFILEID 1 26F60651P9935932P amp CORRELATIONID 87c07be9f95 Example of Reactivating a Profile The following example request reactivates a profile USER SuperMerchant amp PWD SuperUserPassword amp PARTNER PayPal amp TRXTYPE R amp TENDER C amp ACTION R amp ORIGPROFILEID 1 26F60651P9935932P This is the example response RESULT 0 amp RESPMSG Approved amp RPREF RRRFOAO8BD4F PROFILEID 1 26F60651P9935932P amp CORRELATIONID c582c009acceb 24 Payflow Recurring Payments Developer s Guide Canceling Recurring Payments Profiles You cancel terminate a profile by browsin
7. Payflow Recurring Payments Developer s Guide 31 32 Getting Recurring Payments Profile Details Example of Getting Recurring Payments Profile Details US ER SuperMerchant amp PWD SuperUserPassword amp PARTNER PayPal amp TRXTYP E R E TENDE R C SACTION 1 amp ORIGPROFILEID 1 26F60651P9935932P This is the response to the request for profile details RESULT amp RESPMSG Approved PROFILEID 1 26F60651P9935932P CORRELATIONID d73839395ccee PROFILENAME JSmith amp ACCT 510510511105105100 amp START 10272008 amp TERM 2 amp PAY PERIOD DAY amp STATUS DEACTIVATED BY MERCHANT amp PAYME INTSLEFT 2 amp END NUMFAILPAYMENTS 0 CURRENCY USD MAXFATLPAYMENTS 4 3smith01ftexample com RSM MI SM SK Sn KL Lt H DESC TO SEE CRICKET MATCHES FIRSTNAME John LASTNAME Smith amp STREE T 1 Main St amp ZIP 95131 amp CITY San Jose amp STATE CA amp COUNTRY US amp FREIGHTAMT 56 00 amp TAXAMT 34 00 amp AUTOBILLOUTAMT NoAutoBill Payflow Recurring Payments Developer s Guide Billing the Outstanding Amount 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 e
8. 54 R reactivating profiles parameters required 23 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 Payflow Recurring Payments Developer s Guide 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 rec
9. 95 not 1 199 95 FIRSTNAME Optional Bill to first name See NAME Character length and limitations 30 alphanumeric characters MIDDLENAME Optional Bill to middle name Character length and limitations 30 alphanumeric characters LASTNAME Optional Bill to last name Character length and limitations 30 alphanumeric characters 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 Character length and limitations 30 alphanumeric characters Payflow Recurring Payments Developer s Guide 49 az Recurring Payments Reference Updating Recurring Payments Profiles ACTION M TABLE 8 3 Update Recurring Payments Profile Request Parameters Parameter Description STREET Optional Bill to street Character length and limitations 150 characters ZIP Optional Bill to postal code Character length and limitations 10 characters CITY Optional Bill to city Character length and limitations 45 characters STATE Optional Bill to state Character length and limitations 45 characters COUNTRY Optional Bill to country Character length and limitations Two characters PHONENUM Optional Telephone number Character length and limitations 20 alphanumeri
10. ID Profile reports gt Payments profiles 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 ofthe 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 12 Payflow Recurring Payments Developer s Guide Creating Recurring Payments Profiles Creating Recurring Payments Profiles Programmatically FIGURE 2 2 Profile created PayPal u My Account Send Money Request Money Merchant Services Auction Tools Products and Services Overview AddFunds Withdraw History Resolution Center Reports Profile Profile created Help with this page You successfully created this profile S Payments will start on 05 02 2008 A Where do you want t
11. ID of the profile to reactivate Character length and limitations 19 alphanumeric characters NOTE Optional Notes about the action If not provided in the request string the default string is Reactivate Profile Character length and limitations 256 characters TABLE 8 8 Reactivate Recurring Payments Profile Response Parameter Description PROFILEID A unique identifier for future reference to the details of this recurring payment Character length and limitations 19 alphanumeric characters Viewing Recurring Payments Profile Details ACTION TABLE 8 9 View Recurring Payments Profile Details Request Parameters Parameter Description TRXTYPE Required The transaction type R for recurring payments profile request Character length and limitations One alpha character Payflow Recurring Payments Developer s Guide 53 az Recurring Payments Reference Viewing Recurring Payments Profile Details ACTION I TABLE 8 9 View Recurring Payments Profile Details Request Parameters Parameter Description TENDER Required The tender type Is one of the following values e C credit card e P PayPal Character length and limitations One alpha character ACTION Required The Action value I for viewing recurring payments profile Character length and limitations One alpha character ORIGPROFILEID Required The profile ID of the profile to cancel or reactivate Character length an
12. 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 IMPORTANT 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 Payflow Recurring Payments Developer s Guide 41 az Recurring Payments Reference Creating Recurring Payments Profiles ACTION A TABLE 8 1 Create Recurring Payments Profile Request Parameters Parameter Description EMAIL Optional Buyer s email address This value is used when sending email receipts to buyers Character length and limitations 127 alphanumeric characters DESC Optional Description of the goods or services being purchased Character length and limitations 80 alphanumeric characters COMPANYNAME Optional Company name associated with this profile Character length and limitations 64 alphanumeric characters OPTIONALTRXAMT Optional Initial non recurring payment amount due immediately upon profile creation Use an initial amount for enrollment or setup fees NOTE All amounts in the profile creation request must be in the same currency Limitations Nine numeric characers plus decimal character No currency symbol Specify t
13. Payments 14 Payflow Recurring Payments Developer s Guide Creating Recurring Payments Profiles ina 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 TABLE 2 2 Regular Payment Period Parameters PAY PERIOD 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 Norte If you include any of the trial payment period parameters you must include all them in the request to create a recurring payments profile TABLE 2 3 Trial Payment Period Parameters TRIALSTART TRIALTERM TRIALPAY PERIOD 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 TABLE 2 4 Optional Initial Payment Parameters OPTIONALTRXAMT FAILEDINITAMTACTION When you specify an amount for OPTIONALTRXAMT the profile is billed for tha
14. 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 e The billing type value RecurringPayment s required e A description of the goods or services associated with the agreement required 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 ER User ENDER P RTNER PayPal ENDOR Vendor PWD Pwd ACTION S AMT 10 00 RETURNURL http amp CANCELURL http amp CURRENCY USD amp L_BILLINGTYPEO RecurringPayments amp L_BILLINGAGREEMENTDESCRIPTIONO Time magazine amp L_BILLINGTYPE1 RecurringPayments amp L_BILLINGAGREEMENTDESCRIPTION1 Newsweek magazine amp SHIPTOCITY San Jose amp SHIPTOCOUNTRY USA US amp SHIPTOSTATE CA amp SHIPTOSTREET 1 Main St amp SHIPTOZIP 95131 SPAYMENTTYPE any en un H SES RRR HI HI HI LK Set Express Checkout Response RESULT 0 amp RESPMSG Approved amp TOKEN EC 5FA74536B1724550T amp CORRELATIONID e8 1 97944872 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 e The L_ BILLINGAGREEMENTDESCR
15. The profile status must be active or deactivated suspended NoTE 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 e The profile must have a non zero outstanding balance e The amount of the payment cannot exceed the outstanding amount for the profile e 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 Billing the Outstanding Amount 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 TABLE 6 1 Parameters Required to Retry a Transaction Parameter TRXTYPE ACTION ORIGPROFILEID Notes The value R for recurring payments The value P for billing the outstanding amount Profile ID of the profile for which the outstanding amount will be billed Payflow Recurring Payments Developer s Guide 33 Ea Billing the Outstanding Amount Billing the Outstanding Amount 34 Payflow Recurring Payments Developer s Guide Upd
16. 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 a a ae dr do ee a a o ee a oe ee D Audiences o aos ao a os a as o o do ee nn e 5 Where To Go For More Information 5 Revision History e sa ha cua si a ea D a a e Da h a a D a e 5 Chapter 1 Recurring Payments Overview 7 About the Payflow Recurring Payment Services 0 0 2 2 7 Managing Recurring Payments Profiles Through PayPal 8 LIMItatIONS 00 200 9 topos Gab we tee eh od Ae ae AA a a Am A ee d a 9 Recurring Payments Terms 2 2 ee 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 222004 15 Including an Optional Trial Payment Period 4 15 Specifying an Initial Payment 2 2 0 02 0 2 ee 15 Setting the Number of Failed Payments 0020000 16 Billing the Outstanding Amount 2 2
17. credit card billing only AMT The amount to bill START Start date for the recurring payment The date is tomorrow or a date in the future TERM Life of the payment PAYPERTOD How often the payment occurs such as weekly or twice a month TOKEN A TOKEN returned in the Set Express Checkout response Required for PayPal account billing only L BILLINGAGREEMENTDESCR One or more billing agreement descriptions up to a maximum of IPTIONn 10 Required for PayPal account billing only BA DESC A single billing agreement description only if BILLINGAGREEMENTDESCRIPTIONn is specified it overrides this value Required for PayPal account billing if 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 e Specifying the Regular Payment Period e Including an Optional Trial Payment Period e Specifying an Initial Payment e Setting the Number of Failed
18. 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 IMPORTANT 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 EMAIL Optional Buyer s email address This value is used when sending email receipts to buyers Character length and limitations 127 characters DESC Optional Description of the goods or services being purchased Character length and limitations 80 alphanumeric characters COMPANYNAME Optional Company name associated with this profile Character length and limitations 64 alphanumeric characters OPTIONALTRXAMT Optional Amount to be billed per regular payment period not including shipping and tax NOTE 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
19. period NOTE 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 TRIALTERM 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 Character length and limitations Numeric A value of 0 means that payments should continue until the profile is deactivated suspended 58 Payflow Recurring Payments Developer s Guide Recurring Payments Reference Viewing Recurring Payments Profile Details ACTION I TABLE 8 10 View Recurring Payments Profile Details Response Parameter TRIALPAYPERIOD TRIALAMT TRIALFREIGHTAMT TRIALTAXAMT Description How often the trial payment occurs On the PayPal website TRIALPAYPERIOD is called payment cycle Values are e DAY Every day e WEEK Weekly Every week on the same day of the week as the first payment e BIWK Every Two Weeks Every other week on the same day of the week as the first payment e 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 e FRWK Every Four Weeks Every 28 days from the previous payment date beginning with the first payment date Results in 13 paymen
20. the same date as the first payment e SMYR Twice Every Year Every six months on the same date as the first payment NUMCYCLESCOMPLETED 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 STATUS One of the following values describing the current status of the profile ACTIVE PROFILE TERMINATED DEACTIVATED BY MERCHANT EXPIRED PENDING PAYMENTSLEFT Number of payments left to be billed Character length and limitations Numeric characters NEXTPAYMENT Date that the next payment is due Character length and limitations MMDDYYYY format Payflow Recurring Payments Developer s Guide 55 az Recurring Payments Reference Viewing Recurring Payments Profile Details ACTION I TABLE 8 10 View Recurring Payments Profile Details Response Parameter Description CVV2MATCH One of the following card security code match responses e Y Match e N No match e X Unknown NUMFAILPAYMENTS Number of payments that failed Character length and limitations Numeric characters CURRENCY One of the following three character currency codes USD EUR GBP CAD JPY AUD MAXFAILPAYMENTS The number of scheduled payments for whi
21. 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 e An initial non recurring payment of 10 00 e Profile activation even if the initial payment amount fails e 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 e A regular payment starting October 27 2009 for 10 months at a rate of 60 00 per month excluding shipping and tax e The outstanding amount is added to the payment amount for the next billing cycle PAYPERIOD Payflow Recurring Payments Developer s Guide Example Creating a Recurring Payments Profile For Billing a Credit Card Creating Recurring Payments Profiles Create Credit Card Recurring Payments Profile Request USER SuperMerchant amp P
22. verify the profile s status One of the following values e ContinueOnFailure e CancelOnFailure OUTSTANDINGAMT Optional The current past due amount for this profile 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 AUTOBILLOUTAMT Optional This parameter indicates whether or not you would like PayPal to automatically bill the outstanding balance amount in the next payment One of the following values e NoAutoBill e AddToNextBilling Payflow Recurring Payments Developer s Guide 51 az Recurring Payments Reference Deactivating Recurring Payments Profiles ACTION C TABLE 8 4 Update Recurring Payments Profile Response Parameter Description PROFILEID A unique identifier for future reference to the details of this recurring payment Character length and limitations 19 alphanumeric characters Deactivating Recurring Payments Profiles ACTION C TABLE 8 5 Deactivate Recurring Payments Profile Request Parameters Parameter Description TRXTYPE Required The transaction type R for recurring payments profile request Character length and limitations One alpha character TENDER Required The tender type Is one of the following values e C credit card e P PayPal Character length and limitations One alpha character
23. 0651P9935932P PROFTILENAME JSmith SEMATL 3smith01ftexample com COMPANYNAME PayPal The following is an example response to the request to update the profile RESULT 0 amp RESPMSG Approved amp RPREF RRRFOAO8BD4B SPROFILEID I 26F60651P9935932P CORRELATIONID 95d7b814512bb Payflow Recurring Payments Developer s Guide 37 a Updating Recurring Payments Profiles Example of Updating Profiles 38 Payflow Recurring Payments Developer s Guide Recurring Payments Reference Creating Recurring Payments Profiles ACTION A TABLE 8 1 Create Recurring Payments Profile Request Parameters Parameter Description TRXTYPE Required The transaction type R for recurring payments profile request Character length and limitations One alpha character ACTION Required The value A for creating a new recurring payments profile Character length and limitations One alpha character TENDER Required The tender type Is one of the following values e C credit card e P PayPal Character length and limitations One alpha character TOKEN 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 m
24. 5 In the Profile Status section click Reactivate to reactivate the recurring payments profile The Review a recurring payment profile page appears 22 Payflow Recurring Payments Developer s Guide Deactivating and Reactivating Recurring Payments Profiles EN 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 TABLE 3 1 Parameters Required to Deactivate a Profile Parameter Notes TRXTYPE The value R for recurring payments TENDER The value C for credit card or P for PayPal ACTION C The value C for deactivating a recurring payments profile ORIGPROFILEID 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 TABLE 3 2 Parameters Required to Reactivate a Profile
25. 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 parameters required 31 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
26. ARTNER PayPal amp TRXTYPE R amp TENDER C amp ACTION A amp PROFILENAME J Smith amp ACCT 510510511105105100 SEXPDATE 1209 amp CVV2 657 amp AMT 60 00 amp START 10272009 amp TERM 10 PAY PERIOD MONT ENCY USD MAXFATLPAYMENTS 4 J E PayPal IA FIRSTNAME John E J LASTNAME Smi th amp STREET 1 Main St oe OOo me aS W OOR U gt 5 S te Ss E J is 2 E Z1P 951318 CITY San Jose amp STATE CA amp COUNTRY US amp PHONENUM 2 94 9555 amp CARDSTART 1008 amp CARDISSUE Solo amp FREIGHTAMT 20 00 amp TAXAMT 2 50 amp TRIALSTART 0 8022009 amp TRIALTERM 2 amp TRIALPAYPERIOD MONT amp TRIALAMT 56 00 amp TRIALFREIGHTAMT 20 00 amp TRIALTAXAMT 2 50 amp PWD SuperUserPassword j smithOl example com DESC To S Cricket Matches P LTRXAMT 10 00 amp FAILEDOPTIONALTRXACTION ContinueOnFailure amp AUTOBILLOUTSTANDINGAMT AddToNextBilling Create Credit Card Recurring Payments Profile Response RESULT 0 ESPMSG Approved EF RRRFOAO8BD40 Rh U N yy FU T E amp CORRE Payflow Recurring Payments Developer s Guide ROFILEID 1 98E07417J1765691F ELATIONID 63ba4aflde909 17 18 Creating Recurring Payments Profiles Example Creating a Recurring Payments Profile For Billing a PayPal Account Example Creating a
27. EIGHTAMT Optional Total shipping amount for this order NOTE You must set CURRENCY to one of the supported three character currency codes 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 Payflow Recurring Payments Developer s Guide 43 az Recurring Payments Reference Creating Recurring Payments Profiles ACTION A TABLE 8 1 Create Recurring Payments Profile Request Parameters Parameter Description TAXAMT Optional Total tax amount for this order NOTE You must set CURRENCY to one of the supported three character currency codes 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 TRIALSTART Optional The billing start date of the trial payment period NOTE 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 TRIALTERM 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 Character length and limitation
28. IPTIONn string exactly as it was passed in the call to Set Express Checkout for the profile you want to create e TENDER type P to identify the recurring payments as billing a PayPal account e The TOKEN returned in the Set Express Checkout response Payflow Recurring Payments Developer s Guide Creating Recurring Payments Profiles Example Creating a Recurring Payments Profile For Billing a PayPal Account 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 amp TENDER P amp ACTION A amp USER ser amp VENDOR Vendor amp PWD Pwd amp PARTNER PayPal amp TOKEN EC 5FA74536B1724550T PROFILENAME J Smith Profile El amp AMT 30 00 amp START 10272010 amp TERM 5 amp PAY PERIOD WEEK amp CURRENCY USD amp MAXFAILPAYMENTS 4 COMPANYNAME PayPal SFTIRSTNAME J amp LASTNAME Smith amp STREET 1 Main St amp ZIP 95131 amp CITY San Jose amp STATE CA amp COUNTRY USA amp EMAIL jsmith01 example com amp PHONENUM 4 082354545 amp FREIGHTAMT 30 00 amp TAXAMT 34 00 amp AUTOBILLOUTSTANDINGAMT NoAutoBill amp L_BI
29. LLINGAGREEMENTDESCRIPTION1 Newsweek magazine Create Express Checkout Recurring Payments Profile Response RESULT 0 RES PMSG Approved amp RPREF RTTFOD917B7D PROF ILETD I EANRHMUGWESK ELATIONID 350f1e135ab53 Payflow Recurring Payments Developer s Guide 19 ie Creating Recurring Payments Profiles Example Creating a Recurring Payments Profile For Billing a PayPal Account 20 Payflow Recurring Payments Developer s Guide 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 Note 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 2 Log in to your PayPal account Click the Recurring Payments link either in the Tools section in the Account Overview page or on the Profile page On the Recurring payments overview page that appears browse for the profile In the search results click the profile Details The Recurring Payments Profile Details page appears In the Profile Status section shown in Figu
30. PERIOD Required How often the regular payment occurs On the PayPal website PAYPERIOD is called payment cycle Values are e DAY Every Day e WEEK Weekly Every week on the same day of the week as the first payment e BIWK Every Two Weeks Every other week on the same day of the week as the first payment e SMMO Twice Every Month The Ist 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 e MONT Monthly Every month on the same date as the first payment Results in 12 payments per year e OTER Quarterly Every three months on the same date as the first payment e SMYR Twice Every Year Every six months on the same date as the first payment e YEAR Yearly Every 12 months on the same date as the first payment CVV2 Optional Card security code Character length and limitations Three to four alphanumeric characters CURRENCY Required One of the following three character currency codes e USD EUR GBP CAD JPY AUD MAXFAILEDPAYMENTS 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
31. PayPal 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 O 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
32. Payments Profile Details ACTION I TABLE 8 10 View Recurring Payments Profile Details Response 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 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 cancels the profile s pending status You should check your PayPal account to verify the profile s status One of the following values e ContinueOnFailure e CancelOnFailure OUTSTANDINGAMT The current past due amount for this profile 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 no
33. acters 30 alphanumeric characters 30 alphanumeric characters 150 characters 10 characters 45 characters 45 characters Two characters Payflow Recurring Payments Developer s Guide 57 az Recurring Payments Reference Viewing Recurring Payments Profile Details ACTION I TABLE 8 10 View Recurring Payments Profile Details Response Parameter Description CARDSTART Date that Switch or Solo card was issued NoTE 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 CARDISSUE Issue number of Switch or Solo card NoTE For a Switch or Solo transaction to be approved either CARDSTART or CARDISSUE must be present Character length and limitations Eight alphanumeric characters FREIGHTAMT Total shipping amount for this order 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 TAXAMT Total tax amount for this order 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 TRIALSTART The billing start date of the trial payment
34. ating 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 Norte You can only update active or deactivated suspended profiles You can only update specific information about the profile including the following e Subscriber name or address see Updating Addresses e Additional billing cycles e Billing amount tax amount or shipping amount see Updating Addresses e Past due or outstanding amount e Whether to bill the outstanding amount with the next billing cycle e Maximum number of failed payments allowed e Buyer s credit card information see Updating Addresses for a restriction e Profile description and reference Note You cannot modify the payment period PAYPERIOD of a profile Nore 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 e Subscriber shipping address e Credit card billing address 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 Pa
35. buyers on their websites e Have a background in payments services e 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 e Website Payments Pro Payflow Edition Developer 5 Guide e Express Checkout for Payflow Pro Revision History TABLE 1 1 Revision history Date Changes January 2010 Updated Preface description of Recurring Payments users Payflow Recurring Payments Developer s Guide Na Revision History TABLE 1 1 Revision history Date Changes August 2009 Added an example of obtaining a TOKEN from the Set Express Checkout response to create a Recurring Payments profile for billing a PayPal account March 2009 First publication of Payflow Recurring Payments for credit cards and PayPal accounts on a recurring basis 6 Payflow Recurring Payments Developer s Guide 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 e A buyer purchases a subscription to a magazine or newsletter from your site and agrees to pay a monthly fee e 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
36. c characters SHIPTOFIRSTNAME Optional Ship to first name Character length and limitations 30 alphanumeric characters SHIPTOMIDDLENAI T Optional Ship to middle name Character length and limitations 30 alphanumeric characters SHIPTOLASTNAME Optional Ship to last name Character length and limitations 30 alphanumeric characters SHIPTOSTREET Optional Ship to street Character length and limitations 150 characters SHIPTOCITY Optional Ship to city Character length and limitations 45 characters SHIPTOSTATE Optional Ship to state Character length and limitations 45 alphanumeric characters SHIPTOCOUNTRY Optional Ship to country Character length and limitations Two characters SHIPTOZIP Optional Ship to postal code Character length and limitations 10 characters CARDSTART Optional Date that Switch or Solo card was issued NoTE 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 50 Payflow Recurring Payments Developer s Guide Recurring Payments Reference E Updating Recurring Payments Profiles ACTION M TABLE 8 3 Update Recurring Payments Profile Request Parameters Parameter Description CARDISSUE Optional Issue number of Switch or Solo card NOTE For a Switch or Solo transaction to be appro
37. ch the transaction is allowed to fail before PayPal deactivates suspends a profile The default is 0 IMPORTANT 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 EMAIL Buyer s email address Character length and limitations 127 characters DESC Description of the goods or services being purchased Character length and limitations 80 alphanumeric characters COMPANYNAMI Company name associated with this profile GI Character length and limitations 64 alphanumeric characters OPTIONALTRXAMT Initial non recurring payment amount due immediately upon profile creation Use an initial amount for enrollment or setup fees NoTE 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 FIRSTNAME Bill to first name Character length and limitations 30 alphanumeric characters MIDDLENAME Bill to middle name Character length and limitations 30 alphanumeric characters 56 Payflow Recurring Payments Developer s Guide Recurring Payments Reference Viewing Recurring Payments Profile Details ACTION I TABLE 8 10 View Recurrin
38. d limitations 19 alphanumeric characters TABLE 8 10 View Recurring Payments Profile Details Response Parameter Description TRXTYPE The transaction type R for recurring payments profile request Character length and limitations One alpha character TENDER The tender type Is one of the following values e C credit card e P PayPal Character length and limitations One alpha character PROFILEID A unique identifier for future reference to the details of this recurring payments profile Character length and limitations 19 alphanumeric characters PROF ILENAME A unique name for referencing the profile Character length and limitations 127 alphanumeric characters ACCT Credit card number for the credit card recurring payment Character length and limitations 19 alphanumeric characters EXPDATE Credit card expiration date for the credit card recurring payment Character length and limitations 30 alphanumeric characters AMT Amount to be billed per regular payment period not including shipping and tax 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 START 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 Charact
39. e merchant After the recurring payments profile is created you can view recurring payments details and perform other recurring payments profile management tasks e Manually by accessing your PayPal Business account e Programmatically by making calls to Payflow recurring payments requests The following sections describe how to perform recurring payments profile tasks e Creating Recurring Payments Profiles on page 11 e Deactivating and Reactivating Recurring Payments Profiles on page 21 Payflow Recurring Payments Developer s Guide fa Recurring Payments Overview Managing Recurring Payments Profiles Through PayPal e Canceling Recurring Payments Profiles on page 25 e Getting Recurring Payments Profile Details on page 29 e Billing the Outstanding Amount on page 33 e 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 FIGURE 1 1 Recurring payments overview page PayPal My Account Send Money Request Money Merchant Tools Auction Tools Products and Services io Overview AddFunds Withdraw History Resolution Centre Rep
40. e 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 Payflow Recurring Payments Developer s Guide a Recurring Payments Overview Recurring Payments Terms 10 Payflow Recurring Payments Developer s Guide Creating Recurring Payments Profiles NoTE 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 th
41. edit card recurring billing Credit card number Character length and limitations 19 alphanumeric characters EXPDATE Required for credit card recurring billing Credit card expiration date Character length and limitations Four numeric characters in the format MMYY AMT Required Amount to be billed per regular payment period not including shipping and tax NOTE 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 START 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 TERM 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 40 Payflow Recurring Payments Developer s Guide Recurring Payments Reference E Creating Recurring Payments Profiles ACTION A TABLE 8 1 Create Recurring Payments Profile Request Parameters Parameter Description PAY
42. er length and limitations Eight numeric characters in the format MMDDYYYY 54 Payflow Recurring Payments Developer s Guide Recurring Payments Reference A Viewing Recurring Payments Profile Details ACTION I TABLE 8 10 View Recurring Payments Profile Details Response Parameter Description TERM The total number of regular payment periods over the life of the agreement If there are 36 monthly payments TERM is 36 Character length and limitations Numeric A value of O means that payments should continue until the profile is deactivated suspended PAYPERIOD How often the payment occurs On the PayPal website PAYPERTOD is called payment cycle Values are e DAY Every day e WEEK Weekly Every week on the same day of the week as the first payment e BIWK Every Two Weeks Every other week on the same day of the week as the first payment e 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 e FRWK Every Four Weeks Every 28 days from the previous payment date beginning with the first payment date Results in 13 payments per year e MONT Monthly Every month on the same date as the first payment Results in 12 payments per year e OTER Quarterly Every three months on the same date as the first payment e YEAR Yearly Every 12 months on
43. g Payments Profile Details Response Parameter LASTNAME NAME EE STREET ZIP CITY STAT Gl COUNTRY PHONENUM n I H PTOFIRSTNAME SHIPTOMIDDLENAME SHIPTOLASTNAM Gl SHIPTOSTREET SHIPTOZIP SHIPTOCITY SHIPTOSTATE SHIPTOCOUNTRY Description Bill to last name Character length and limitations Subscriber s name Character length and limitations Bill to street Character length and limitations Bill to postal code Character length and limitations Bill to city Character length and limitations Bill to state Character length and limitations Bill to country Character length and limitations Telephone number Character length and limitations Ship to first name Character length and limitations Ship to middle name Character length and limitations Ship to last name Character length and limitations Ship to street Character length and limitations Ship to postal code Character length and limitations Ship to city Character length and limitations Ship to state Character length and limitations Ship to country Character length and limitations 30 alphanumeric characters 30 alphanumeric characters 150 characters 10 characters 45 characters 45 characters Two characters 20 alphanumeric characters 30 alphanumeric char
44. g for it from the Recurring Payments Overview page on the PayPal website and manually canceling it as described below Nore 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 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 in Figure 4 1 FIGURE 4 1 Recurring payments overview page PayPal My Account Send Money Request Money Merchant Tools Auction Tools Products and Services Overview AddFunds Withdraw History Resolution Centre Reports Profile Manage profiles Recurring payments overview Help with this pace gt Create a new profile Find profiles gt Browse for profiles gt Search for profiles by ID Profile reports gt Payments profiles 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 Payflow Recurring Payments Developer s Guide 25 Canceling Recurring Payments Profiles Canceling Recurring Payments Profiles Through Your PayPal Account 4 In the search results click the profile Details The Recurring Payments Profile Details page appears 5 In the Profile Status section of the page shown in Figure 4 2 click Cancel t
45. he 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 FIRSTNAME Optional Bill to first name See NAME Character length and limitations 30 alphanumeric characters MIDDLENAME Optional Bill to middle name Character length and limitations 30 alphanumeric characters LASTNAME Optional Bill to last name Character length and limitations 30 alphanumeric characters 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 Character length and limitations 30 alphanumeric characters STREET Optional Bill to street Character length and limitations 150 characters ZIP Optional Bill to postal code Character length and limitations 10 characters CITY Optional Bill to city Character length and limitations 45 characters STATE Optional Bill to state Character length and limitations 45 characters COUNTRY Optional Bill to country Character length and limitations Two characters 42 Payflow Recurring Payments Developer s Guide Recurring Payments Reference E Creating Recurring Payments Profiles ACTION A TABLE 8 1 Create Recurring Payments Profile Request Parameters
46. 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 Payflow Recurring Payments Developer s Guide 29 ua 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 2 Click the Recurring Payments link either in the Tools section of the Account Overview page or on your Profile page 3 On the Recurring payments overview page 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 5 1 click the View Status History link to view the status history of a profile 30 Payflow Recurring Payments Developer s Guide Getting Recurring Payments Profile Details Obtain
47. ing Profile Details Programmatically FIGURE 5 1 Profile Status section of Recurring Payments Profile Details page PayPal My Account Recurring Payments Profile Details via Website Payments Pro Profile ID Product service Start date End date Profile Status Send Money Request Money Merchant Services Auction Tools Products and Services Return to History Profile information LKYKA4205KN1D3 Monthly Dues May 20 2008 Aug 15 2008 Active Cancel view Status History Modify Suspend Buyer information Name Email Billing terms Next payment date Jun 15 2008 Failed payments maximum What s this 0 Add missed payments to next biling Yes 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 TABLE 5 1 Required Parameters in a Profile Status Inquiry Request Parameter Notes TRXTYPE The value R for recurring payments TENDER The value C for credit card or P for PayPal ACTION The value I for inquiring about recurring payments profile details ORIGPROFILEID 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
48. l amounts in the profile creation request must be in the same currency If you create a trial payment period TRIALAMT is required Otherwise it is optional 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 TRIALFREIGHTAMT Optional Shipping amount for each trial payment 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 TRIALTAXAMT Optional Tax amount for each trial payment 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 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 re
49. nd limitations Four numeric characters in the format MMYY AMT Required Amount to be billed per regular payment period not including shipping and tax NOTE 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 START 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 8 numeric characters in the format MMDDYYYY TERM Required The total number of regular payment periods over the life of the agreement If there are 36 monthly payments TERM is 36 Character length and limitations Numeric A value of 0 means that payments should continue until the profile is deactivated suspended Payflow Recurring Payments Developer s Guide 47 az Recurring Payments Reference Updating Recurring Payments Profiles ACTION M TABLE 8 3 Update Recurring Payments Profile Request Parameters Parameter Description PAY PERIOD Required How often the regular payment occurs Values are e DAY Every day e 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 a
50. o cancel the profile FIGURE 4 2 Profile Status section of Recurring Payments Pofile Details page PayPal My Account Recurring Payments Profile Details via Website Payments Pro Profile ID Productiservice Start date End date Profile Status Name Email Next payment date Failed payments maximum What s this Add missed payments to next billing Send Money Request Money Merchant Services Auction Tools Products and Services Return to History Profile information LKYKAA05KN1D3 Monthly Dues May 20 2008 Aug 15 2008 Active Cancel View Status History Modify Suspend Buyer information Billing terms dun 15 2008 0 Yes 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 26 Payflow Recurring Payments Developer s Guide Canceling Recurring Payments Profiles NE Canceling Recurring Payments Profiles Through Your PayPal Account FIGURE 4 3 Profile Status History page LogOut Help Security Center PayPal My Account Send Money Request Money Merchant Services Auction Tools Products and Services Profile Status History Return to Recurring Payment Details The following list includes profile status changes for recurring payments from Date Status Notes Jun 2 2008 Canceled May 13 2008 Created About Us ContactUs Fees Legal Agreements Privacy Site Feedback H
51. o go next Profile ID I CHDABSNOWEFRO gt View transactions Billing address Jane Smith gt ow rooting namane i gt a pay 1 Main St San Jose CA 95131 overview 408 967 4444 gt View account overview jsmith res com Shipping address Shipping address is same as billing address Regular recurring payments Total 120 00 USD Including shipping Start payments Collect payment Number of recurring payments 05 02 2008 Every 1 months 4 View profile report 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 TABLE 2 1 Required Parameters to Create a New Profile Parameter Notes TRXTYPE The value R for recurring payments TENDER The value C for credit card or P for PayPal Payflow Recurring Payments Developer s Guide 13 ua Creating Recurring Payments Profiles Options for Creating a Recurring Payments Profile Programmatically TABLE 2 1 Required Parameters to Create a New Profile Parameter Notes ACTION The value A for creating a new recurring payments profile PROFILENAME Unique profile name ACCT Credit card account number Required for credit card billing only EXPDATE Credit card expiration date Required for
52. orts Profile Manage profiles Recurring payments overview Help with this page gt Create a new profile Find profiles gt Browse for profiles gt Search for profiles by ID Profile reports gt Payments profiles 8 Payflow Recurring Payments Developer s Guide Recurring Payments Overview Limitations Limitations The current release of Payflow recurring payments has the following limitations e A recurring payments profile can have at most one optional trial payment period and a single regular payment period e 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 TABLE 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 th
53. re 3 1 click Suspend to deactivate the recurring payments profile Payflow Recurring Payments Developer s Guide 21 pm Deactivating and Reactivating Recurring Payments Profiles Reactivating a Profile Through Your PayPal Account FIGURE 3 1 Profile Status section of Recurring Payments Profile Details page PayPal My Account Send Money Request Money Merchant Services Auction Tools Products and Services Recurring Payments Profile Details via Website Payments Pro Return to History Profile information Profile ID 1 KYK4405KN1D3 Product service Monthly Dues Start date May 20 2008 End date Aug 15 2008 Profile Status Active Cancel View Status History Modify Suspend Buyer information Name Email Billing terms Next payment date Jun 15 2008 Failed payments maximum What s this 0 Add missed payments to next biling Yes 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 1 Log in to your PayPal account 2 Click the Recurring Payments link either in the Tools section of 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
54. rough 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 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 in Figure 2 1 Payflow Recurring Payments Developer s Guide 11 aa Creating Recurring Payments Profiles Creating Profiles Through Your PayPal Account FIGURE 2 1 Recurring payments overview page PayPal My Account Send Money Request Money Merchant Tools Auction Tools Products and Services a Overview Add Funds Withdraw History Resolution Centre Reports Profile Manage profiles Recurring payments overview Help with this page gt Create a new profile Find profiles gt Browse for profiles gt Search for profiles by
55. s Numeric A value of 0 means that payments should continue until the profile is deactivated suspended TRIALPAY PERIOD Optional How often the trial payment occurs On the PayPal website TRIALPAYPERIOD is called payment cycle Values are e DAY Every day e WEEK Weekly Every week on the same day of the week as the first payment e BIWK Every Two Weeks Every other week on the same day of the week as the first payment e 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 e MONT Monthly Every month on the same date as the first payment Results in 12 payments per year e OTER Quarterly Every three months on the same date as the first payment e SMYR Twice Every Year Every six months on the same date as the first payment e YEAR Yearly Every 12 months on the same date as the first payment 44 Payflow Recurring Payments Developer s Guide Recurring Payments Reference E Creating Recurring Payments Profiles ACTION A TABLE 8 1 Create Recurring Payments Profile Request Parameters Parameter Description TRIALAMT Optional Amount of the trial payment not including shipping and tax NOTE Al
56. s the first payment e 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 e FRWK Every Four Weeks Every 28 days from the previous payment date beginning with the first payment date Results in 13 payments per year e MONT Monthly Every month on the same date as the first payment Results in 12 payments per year e OTER Quarterly Every three months on the same date as the first payment e SMYR Twice Every Year Every six months on the same date as the first payment e YEAR Yearly Every 12 months on the same date as the first payment ADDITIONALBILLINGCY Optional Additional billing cycles as defined by PAYPERIOD to add to CLES this profile If for example the number of billing cycles in the current TERM is 36 setting ADDITIONALBILLINGCYCLES to 2 increases TERM to 38 CVV2 Optional Card security code Character length and limitations Three to four numeric characters CURRENCY Required One of the following three character currency codes e USD EUR GBP CAD JPY AUD 48 Payflow Recurring Payments Developer s Guide Recurring Payments Reference ca Updating Recurring Payments Profiles ACTION M TABLE 8 3 Update Recurring Payments Profile Request Parameters Parameter Description MAXFAILPAYMENTS Optional The
57. ses 2 2 2 35 Updating a Profile Through Your PayPal Account 2 35 Updating Profiles Programmatically 2 a a e 37 Example of Updating Profiles 2 000002 eee eee 37 Chapter 8 Recurring Payments Reference 4 499 Creating Recurring Payments Profiles ACTION A 2 39 Updating Recurring Payments Profiles ACTION M 46 Deactivating Recurring Payments Profiles ACTION C 00 52 Reactivating Recurring Payments Profiles ACTION R 022 53 Viewing Recurring Payments Profile Details ACTION I 53 Billing Outstanding Amount Request ACTION P 2 61 MNAE 200 us SO eee OS ee ee AAA Bi ee ss 0 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 e Have PayPal accounts that have the ability to use Payflow credentials e Are experienced web or application developers or merchants offering recurring payment solutions to their
58. sponse 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 e ContinueOnFailure e CancelOnFailure Payflow Recurring Payments Developer s Guide 45 az Recurring Payments Reference Updating Recurring Payments Profiles ACTION M TABLE 8 1 Create Recurring Payments Profile Request Parameters Parameter Description AUTOBILLOUTSTANDING Optional This parameter indicates whether or not you would like AMT PayPal to automatically roll over the outstanding balance amount in the next payment One of the following values e NoAutoBill e AddToNextBilling TABLE 8 2 Create Recurring Payments Profile Response Parameter Description PROFILEID A unique identifier for future reference to the details of this recurring payment Character length and limitations 19 alphanumeric characters STATUS The status of the profile Is one of the following values ACTIVE DEACTIVATED BY MERCHANT EXPIRED PENDING PROFILE TERMINATED
59. t 1 199 95 LASTPAYMENTAMT Amount of the last successful payment received for this profile 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 AUTOBILLOUTAMT This parameter indicates whether or not you would like PayPal to automatically roll over the outstanding balance amount in the next payment One of the following values e NoAutoBill e AddToNextBilling 60 Payflow Recurring Payments Developer s Guide Recurring Payments Reference E Billing Outstanding Amount Request ACTION P Billing Outstanding Amount Request ACTION P TABLE 8 11 Bill Outstanding Amount Request Parameters Parameter Description TRXTYPE Required The transaction type R for recurring payments profile request Character length and limitations One alpha character ACTION Required The Action value P for billing outstanding amount Character length and limitations One alpha character ORIGPROFILEID Required Profile ID of the profile to bill outstanding amount Character length and limitations 19 alphanumeric characters AMT Optional Amount to be billed per regular payment period not including shipping and tax NOTE All amounts in the profile creation request must be in the same currency Limitations Nine numeric characers plus decimal character No c
60. t amount initially upon recurring payments profile creation If you don t supply a value for this Payflow Recurring Payments Developer s Guide 15 16 Creating Recurring Payments Profiles 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 FATLEDINITAMTACTION 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 FATLEDINITAMTACTION 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
61. ts per year e MONT Monthly Every month on the same date as the first payment Results in 12 payments per year e OTER Quarterly Every three months on the same date as the first payment e YEAR Yearly Every 12 months on the same date as the first payment e SMYR Twice Every Year Every six months on the same date as the first payment Amount of the trial payment not including shipping and tax NoTE All amounts in the profile creation request must be in the same currency If you create a trial payment period TRIALAMT is required Otherwise it is optional 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 Shipping amount for each trial payment 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 Tax amount for each trial payment 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 Payflow Recurring Payments Developer s Guide 59 az Recurring Payments Reference Viewing Recurring
62. urrency 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 CURRENCY Optional One of the following three character currency codes e USD EUR GBP CAD JPY AUD NOTE Optional Notes about the action If not provided the following default string 1s sent This is a recurring payment Character length and limitations 256 characters TABLE 8 12 Bill Outstanding Amount Response Parameter Description PROFILEID A unique identifier for future reference to the details of this recurring payment Character length and limitations 19 alphanumeric characters Payflow Recurring Payments Developer s Guide 61 o Recurring Payments Reference Billing Outstanding Amount Request ACTION P 62 Payflow Recurring Payments Developer s Guide 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
63. urring payments profiles 53 Z ZIP 42 50 57 Payflow Recurring Payments Developer s Guide 65 66 Payflow Recurring Payments Developer s Guide
64. ust pass the following e One L_BILLINGAGREEMENTDESCRIPTIONn string see below exactly as passed in the Set Express Checkout request OR e The BA DESC string see below exactly as passed in the Set Express Checkout request e TENDER P e TOKEN returned in the Set Express Checkout response PROFILENAME Required A unique name for referencing the recurring payments profile Character length and limitations 127 alphanumeric characters BILLINGAGREEMENTD Optional See TOKEN Describes the recurring payment product or ESCRIPTIONn 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 Character length and limitations 127 alphanumeric characters Payflow Recurring Payments Developer s Guide 39 az Recurring Payments Reference Creating Recurring Payments Profiles ACTION A TABLE 8 1 Create Recurring Payments Profile Request Parameters Parameter Description BA DESC 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 Character length and limitations 127 alphanumeric characters ACCT Required for cr
65. ved either CARDSTART or CARDISSUE must be present Character length and limitations Two alphanumeric characters TAXAMT Optional Total tax amount for this order NOTE You must set CURRENCY to one of the supported three character currency codes 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 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 PayPal account to
66. view a Recurring Payment profile page Then click Submit to update the profile or Cancel to cancel the profile changes Follow the links on the Recurring payments profile updated page to review the profile details or to perform other profile tasks listed Payflow Recurring Payments Developer s Guide Updating Recurring Payments Profiles ina 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 TABLE 7 1 Parameters Required to Update Profiles TRXTYPE The value R for recurring payments TENDER The value C for credit card or P for PayPal ACTION The value M for updating the profile ORIGPROFILEID 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 1 26F60651P9935932P Updating the shipping address requires providing values for each of the SHIPTO parameters USER SuperMerchant amp PWD SuperUserPassword amp PARTNER PayPal amp TRXTYPE R amp TENDER C amp ACTION M amp SHIPTOFIRSTNAME John SHIPTOMIDDLENAME J amp SHIPTOLASTNAME 5MTTH amp SHIPTOSTREET 1 Main St amp SHIPTOCITY San Jose SHIPTOSTATE CA amp SHIPTOCOUNTRY US amp SHIPTOZIP 95155 SORIGPROFILEID I 26F6
67. website e A buyer agrees to an installment plan to purchase a high ticket item 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 Note 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 th
68. yPal Account To update a profile through your PayPal account 1 Log in to your PayPal account Payflow Recurring Payments Developer s Guide 35 Updating Recurring Payments Profiles Updating a Profile Through Your PayPal Account 2 Click the Recurring Payments link either in the Tools section of the Account Overview page or on your Profile page On the Recurring payments overview page that appears browse for the profile In the search results click the profile Details The Recurring Payments Profile Details page appears In the Profile Status section shown in Figure 7 1 click Modify to update the recurring payments profile The Update a recurring payments profile page appears FIGURE 7 1 Profile Status section of Recurring Payments Profile Details page PayPal My Account Send Money Request Money Merchant Services Auction Tools Recurring Payments Profile Details via Website Payments Pro Products and Services Return to History 36 Profile information Profile ID 1 KYK4405KN1D3 Productiservice Monthly Dues Start date May 20 2008 End date Aug 15 2008 Profile Status Active Cancel View Status History Modify Suspend Buyer information Name Email Billing terms Next payment date Jun 15 2008 Failed payments maximum Wvhat s this 0 Add missed payments to next biling Yes Edit the page as necessary and click Continue or Cancel to cancel the action Review your changes on the Re

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

Contents

Download Pdf Manuals

Related Search

Related Contents