Integration Guide
Table Of Contents
- Express Checkout Integration Guide
- Contents
- Preface
- Introducing Express Checkout
- Express Checkout Button and Logo Image Integration
- PayPal Name-Value Pair API Basics
- Implementing the Simplest Express Checkout Integration
- Testing an Express Checkout Integration
- Customizing Express Checkout
- Implementing the Instant Update API
- Immediate Payment
- Handling Payment Settlements
- Handling Recurring Payments
- How Recurring Payments Work
- Recurring Payments Terms
- Recurring Payments With Express Checkout
- 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
- Using Other PayPal API Operations
- Integrating giropay with Express Checkout
Handling Recurring Payments
Recurring Payments Profile Status
10
98 October 2009 Express Checkout Integration Guide
Billing the Outstanding Amount
If a payment fails due to 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 AUTOBILLOUTAMT
field in the CreateRecurringPaymentsProfile request to specify whether or not the
outstanding amount should be added to the payment amount for the next billing cycle.
Whether or not you choose to include the outstanding amount with the payment for the next
billing cycle, you can also use the BillOutstandingAmount API to programmatically
collect that amount at any time.
Recurring Payments Profile Status
The recurring payments actions you may take, depend on the status of the profile.
A recurring payments profile can have one of the following status values:
z ActiveProfile
z PendingProfile
z ExpiredProfile
z SuspendedProfile
z CancelledProfile
If the profile is successfully created, it has an ActiveProfile status. However, if a non-
recurring initial payment fails and FAILEDINITAMTACTION is set to CancelOnFailure in
the CreateRecurringPaymentsProfile request, the profile is created with a status of
PendingProfile until the initial payment either completes successfully or fails.
A profile has a status of ExpiredProfile when both the total billing cycles for both the
optional trial period and the regular payment period have been completed.
You can suspend or cancel a profile by using the
ManageRecurringPaymentsProfileStatus API. You can also reactivate a suspended
profile. If the maximum number of failed payments has already been reached, however, you
will need to increase the number of failed payments before reactivating the profile.
NOTE: You can also suspend, cancel, or reactive a recurring payments profile through the
PayPal website.
For recurring payments profiles created with Express Checkout, the buyer receives an email
about the change in status of their recurring payment.
Getting Recurring Payments Profile Information
Use the GetRecurringPaymentsProfileDetails API to get information about a profile.