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 111
Recurring Payments and Reference Transactions API Operations
GetRecurringPaymentsProfileDetails API
Recurring Payments Summary Details Fields
Credit Card Details Fields
Field Description
NEXTBILLINGDATE The next scheduled billing date, in YYYY-MM-DD format.
NUMCYCYLESCOMPLETED The number of billing cycles completed in the current active subscription period. A
billing cycle is considered completed when payment is collected or after retry
attempts to collect payment for the current billing cycle have failed.
NUMCYCLESREMAINING The number of billing cycles remaining in the current active subscription period.
OUTSTANDINGBALANCE The current past due or outstanding balance for this profile.
Character length and limitations: Does not exceed $10,000 USD in any currency. No
currency symbol. Regardless of currency, decimal separator is a period (.), and the
optional thousands separator is a comma (,). Equivalent to nine characters maximum
for USD.
FAILEDPAYMENTCOUNT The total number of failed billing cycles for this profile.
LASTPAYMENTDATE The date of the last successful payment received for this profile, in YYYY-MM-DD
format.
LASTPAYMENTAMT The amount of the last successful payment received for this profile.
Character length and limitations: Does not exceed $10,000 USD in any currency. No
currency symbol. Regardless of currency, decimal separator is a period (.), and the
optional thousands separator is a comma (,). Equivalent to nine characters maximum
for USD.
Field Description
CREDITCARDTYPE Type of credit card.
Character length and limitations: Up to ten single-byte alphabetic characters.
Allowable values:
z Visa
z MasterCard
z Discover
z Amex
z Maestro: See important note.
z Solo: See important note.
NOTE: If the credit card type is Maestro or Solo, the currencyId must be GBP. In
addition, either StartMonth and StartYear or IssueNumber must be
specified.
ACCT Credit card number. Only the last 4 digits of the credit card number are returned.
Character length and limitations: numeric characters only. No spaces or punctutation.
Must conform with modulo and length required by each credit card type.