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 97
Recurring Payments and Reference Transactions API Operations
CreateRecurringPaymentsProfile API
CreateRecurringPaymentsProfile Request Fields
Recurring Payments Profile Details Fields
ScheduleDetails 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.
Field Description
SUBSCRIBERNAME (Optional) Full name of the person receiving the product or service paid for by the
recurring payment.
If not present, the name in the buyer’s PayPal account is used.
Character length and limitations: 32 single-byte characters.
PROFILESTARTDATE (Required) The date when billing for this profile begins.
Must be a valid date, in UTC/GMT format.
NOTE: The profile may take up to 24 hours for activation.
PROFILEREFERENCE (Optional) The merchant’s own unique reference or invoice number.
Character length and limitations: 127 single-byte alphanumeric characters.
Field Description
DESC (Required) Description of the recurring payment.
NOTE: This field must match the corresponding billing agreement description
included in the SetExpressCheckout request.
Character length and limitations: 127 single-byte alphanumeric characters
MAXFAILEDPAYMENTS (Optional) The number of scheduled payments that can fail before the profile is
automatically suspended. An IPN message is sent to the merchant when the specified
number of failed payments is reached.
Character length and limitations: Number string representing an integer.