Integration Guide
Table Of Contents
- PayPal Payments Pro Integration Guide
- Contents
- Preface
- Introducing PayPal Payments Pro
- Introducing Direct Payment
- Introducing Express Checkout
- Getting Started With Direct Payment
- Getting Started With Express Checkout
- Integrating Recurring Payments
- How Recurring Payments Work
- Recurring Payments Terms
- Recurring Payments With Direct Payment
- Recurring Payments With the Express Checkout API
- Options for Creating a Recurring Payments Profile
- Recurring Payments Profile Status
- Getting Recurring Payments Profile Information
- Modifying a Recurring Payments Profile
- Billing the Outstanding Amount of a Profile
- Recurring Payments Notifications
- Getting Started With the PayPal Name-Value Pair API
- Implementing 3-D Secure Transactions (UK Only)
PayPal Payments Pro Integration Guide April 2012 61
Integrating Recurring Payments
Recurring Payments With Direct Payment
6
Recurring Payments With Direct Payment
Recurring payments with Direct Payment enables a recurring payment to be associated with a
debit or credit card. For these payments, you must collect on your website all necessary
information from your buyer, including billing amount and buyer’s credit card information.
After you have collected the information, call the CreateRecurringPaymentsProfile
API for each profile to be created. The CreateRecurringPaymentsProfile request must
contain all required credit card information and must not contain a value for the TOKEN field.
The following table lists the fields that are required in the
CreateRecurringPaymentsProfile request for recurring payments using direct
payments.
Required fields for CreateRecurringPaymentsProfile in Direct Payment
Trial period An optional subscription period before the regular payment period begins. A
trial period may not have the same billing cycles and payment amounts as
the regular payment period.
Payment amount The amount the buyer pays for each billing cycle.
Outstanding balance If a payment fails for any reason, PayPal adds that amount to the profile’s
outstanding balance.
Profile ID An alphanumeric string (generated by PayPal) that uniquely identifies a
recurring profile. You can specify the Profile ID in the
TransactionSearch API operation to obtain all payments associated
with the identified profile.
NVP SOAP
CREDITCARDTYPE CreditCardDetails.CreditCardType
ACCT CreditCardDetails.CreditCardNumber
EXPDATE CreditCardDetails.ExpMonth and
CreditCardDetails.ExpYear
FIRSTNAME CreditCardDetails.CardOwner.PayerName.FirstName
LASTNAME CreditCardDetails.CardOwner.PayerName.LastName
PROFILESTARTDATE RecurringPaymentProfileDetails.BillingStartDate
BILLINGPERIOD ScheduleDetails.PaymentPeriod.BillingPeriod
BILLINGFREQUENCY ScheduleDetails.PaymentPeriod.BillingFrequency
AMT ScheduleDetails.PaymentsPeriod.Amount
Term Definition