2012

Name-Value Pair API Developer Guide August 2012 137
12
Recurring Payments and
Reference Transactions API
Operations
The PayPal API includes the following API operations supporting recurring payments and
reference transactions:
CreateRecurringPaymentsProfile API Operation
The CreateRecurringPaymentsProfile API operation creates 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 recurring payments profile with its billing
agreement, you must ensure that the description in the recurring payments profile
matches the description of a billing agreement. For version 54.0 and later, use
SetExpressCheckout to initiate creation of a billing agreement.
CreateRecurringPaymentsProfile Request Message
CreateRecurringPaymentsProfile Request Fields
Field Description
METHOD (Required) Must be CreateRecurringPaymentsProfile.
TOKEN A timestamped token, the value of which was returned in the response to the first call
to SetExpressCheckout. You can also use the token returned in the
SetCustomerBillingAgreement response. Either this token or a credit card
number is required. If you include both token and credit card number, the token is
used and credit card number is ignored Call CreateRecurringPaymentsProfile
once for each billing agreement included in SetExpressCheckout request and use
the same token for each call. Each CreateRecurringPaymentsProfile request
creates a single recurring payments profile.
NOTE: Tokens expire after approximately 3 hours.