2009
Table Of Contents
- Name-Value Pair API Developer Guide
- Preface
- This Document
- Intended Audience
- Revision History
- PayPal NVP API Overview
- Authorization and Capture API Operation Reference
- DoDirectPayment API
- Express Checkout API Operations
- GetTransactionDetails API
- MassPay API
- RefundTransaction API
- TransactionSearch API
- Recurring Payments and Reference Transactions API Operations
- DoNonReferencedCredit API
- ManagePendingTransactionStatu s API
- GetBalance API
- AddressVerify API
- API Error Codes
- General API Errors
- Validation Errors
- Direct Payment API Errors
- SetExpressCheckout API Errors
- GetExpressCheckoutDetails API Errors
- DoExpressCheckoutPayment API Errors
- Authorization and Capture API Errors
- GetTransactionDetails API Errors
- TransactionSearch API Errors
- RefundTransaction API Errors
- Mass Pay API Errors
- Recurring Payments Errors
- SetCustomerBillingAgreement Errors
- GetBillingAgreementCustomerDetails Errors
- CreateBillingAgreement Errors
- UpdateBillingAgreement Errors
- DoReferenceTransaction Errors
- AddressVerify API Errors
- ManagePendingTransactionStatus API Errors
- Country Codes
- State and Province Codes
- Currency Codes
- AVS and CVV2 Response Codes
Name-Value Pair API Developer Guide 08 April 2009 95
9
Recurring Payments and
Reference Transactions API
Operations
This chapter describes the PayPal API operations related to recurring payments and reference
transactions:
z “CreateRecurringPaymentsProfile API” on page 95
z “GetRecurringPaymentsProfileDetails API” on page 106
z “ManageRecurringPaymentsProfileStatus API” on page 113
z “BillOutstandingAmount API” on page 114
z “UpdateRecurringPaymentsProfile API” on page 115
z “SetCustomerBillingAgreement API” on page 123
z “GetBillingAgreementCustomerDetails API” on page 127
z “DoReferenceTransaction API” on page 133
CreateRecurringPaymentsProfile API
Create a recurring payments profile.
You must invoke the CreateRecurringPaymentsProfile API operation for each profile
you want to create. The API operation creates a profile and an associated billing agreement.
NOTE: There is a one-to-one correspondence between billing agreements and recurring
payments profiles. To associate a a recurring payments profile with its billing
agreement, the description in the recurring payments profile must match the
description of a billing agreement. For version 54.0 and later, use
SetExpressCheckout to initiate creation of a billing agreement.
z “CreateRecurringPaymentsProfile Request” on page 95
z “CreateRecurringPaymentsProfile Response” on page 105
CreateRecurringPaymentsProfile Request
z CreateRecurringPaymentsProfile Request
z Recurring Payments Profile Details
z Schedule Details