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 115
Recurring Payments and Reference Transactions API Operations
UpdateRecurringPaymentsProfile API
BillOutstandingAmount Request
BillOutstandingAmount Request Fields
BillOutstandingAmount Response
BillOutstandingAmount Response Fields
UpdateRecurringPaymentsProfile API
Update a recurring payments profile.
z “UpdateRecurringPaymentsProfile Request” on page 116
z “UpdateRecurringPaymentsProfile Response” on page 123
Field Description
METHOD (Required) Must be BillOutstandingAmount.
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.
NOTE: The profile must have a status of either Active or Suspended.
AMT (Optional) The amount to bill. The amount must be less than or equal to the current
outstanding balance of the profile. If no value is specified, PayPal will attempt to bill
the entire outstanding balance amount.
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.
NOTE (Optional) The reason for the non-scheduled payment. For profiles created using
Express Checkout, this message will be included in the email notification to the buyer
for the non-scheduled payment transaction, 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.
An error is returned if the profile specified in the BillOutstandingAmount
request has a status of canceled or expired.