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
Recurring Payments and Reference Transactions API Operations
BillOutstandingAmount API
114 08 April 2009 Name-Value Pair API Developer Guide
ManageRecurringPaymentsProfileStatus Request
ManageRecurringPaymentsProfileStatus Request Fields
ManageRecurringPaymentsProfileStatus Response
ManageRecurringPaymentsProfileStatus Response Fields
BillOutstandingAmount API
Bill the buyer for the outstanding balance associated with a recurring payments profile.
z “BillOutstandingAmount Request” on page 115
z “BillOutstandingAmount Response” on page 115
Field Description
METHOD (Required) Must be ManageRecurringPaymentsProfileStatus.
PROFILEID (Required) Recurring payments profile ID returned in the
CreateRecurringPaymentsProfile response.
Character length and limitations: 14 single-byte alphanumeric characters. 19
character profile IDs are supported for compatability with previous versions of the
PayPal API.
ACTION (Required) The action to be performed to the recurring payments profile. Must be one
of the following:
z Cancel - Only profiles in Active or Suspended state can be canceled.
z Suspend - Only profiles in Active state can be suspended.
z Reactivate - Only profiles in a suspended state can be reactivated.
NOTE (Optional) The reason for the change in status. For profiles created using Express
Checkout, this message will be included in the email notification to the buyer when
the status of the profile is successfully changed, and can also be seen by both you and
the buyer on the Status History page of the PayPal account.
Field Description
PROFILEID Recurring payments profile ID returned in the
CreateRecurringPaymentsProfile response.
For each action, an error is returned if the recurring payments profile has a status that
is not compatible with the action. Errors are returned in the following cases:
z Cancel - Profile status is not Active or Suspended.
z Suspend - Profile status is not Active.
z Reactivate - Profile status is not Suspended.