2012
Table Of Contents
- SOAP API Developer Reference
- Contents
- What’s New
- Preface
- PayPal SOAP API Basics
- PayPal WSDL/XSD Schema Definitions
- PayPal SOAP API Definitions
- Security
- SOAP RequesterCredentials: Username, Password, Signature, and Subject
- SOAP Service Endpoints
- SOAP Request Envelope
- Request Structure
- SOAP Message Style: doc-literal
- Response Structure
- Error Responses
- CorrelationID for Reporting Problems to PayPal
- UTF-8 Character Encoding
- Date/Time Formats
- Core Currency Amount Data Type
- AddressVerify API Operation
- Authorization and Capture API Operation Reference
- DoDirectPayment API Operation
- DoNonReferencedCredit API Operation
- ExpressCheckout API Operations
- GetBalance API Operation
- GetPalDetails API Operation
- GetTransactionDetails API Operation
- ManagePendingTransactionStatus API Operation
- MassPay API Operation
- Recurring Payments and Reference Transactions API Operations
- CreateRecurringPaymentsProfile API Operation
- GetRecurringPaymentsProfileDetails API Operation
- ManageRecurringPaymentsProfileStatus API Operation
- BillOutstandingAmount API Operation
- UpdateRecurringPaymentsProfile API Operation
- SetCustomerBillingAgreement API Operation
- CreateBillingAgreement API Operation
- GetBillingAgreementCustomerDetails API Operation
- BAUpdate API Operation
- DoReferenceTransaction API Operation
- RefundTransaction API Operation
- TransactionSearch API Operation
- API Error Codes
- General API Errors
- Validation Errors
- DirectPayment 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
- MassPay API Errors
- Recurring Payments Errors
- SetCustomerBillingAgreement Errors
- GetBillingAgreementCustomerDetails Errors
- CreateBillingAgreement Errors
- UpdateBillingAgreement Errors
- DoReferenceTransaction Errors
- AddressVerify API Errors
- ManagePendingTransactionStatus API Errors
- Countries and Regions Supported by PayPal
- State and Province Codes
- Currency Codes
- AVS and CVV2 Response Codes
- About Previous Versions of the API
- Revision History
- Index
SOAP API Developer Reference August 2012 227
Recurring Payments and Reference Transactions API Operations
UpdateRecurringPaymentsProfile API Operation
12
AddressType (Shipping) Fields
MaxFailedPayments xs:int
(Optional) The number of failed payments allowed before the profile is automatically
suspended. The specified value cannot be less than the current number of failed
payments for this profile.
Character length and limitations: Number string representing an integer
BillingStartdate xs:dateTime
(Optional) The date when billing for this profile begins.
NOTE: The profile may take up to 24 hours for activation.
Character length and limitations: Must be a valid date, in UTC/GMT format
TrialPeriod ns:BillingPeriodDetailsType
(Optional) The trial period for this schedule.
PaymentPeriod ns:BillingPeriodDetailsType
(Optional) The regular payment period for this schedule.
CreditCard ns:CreditCardDetailsType
(Optional) Credit card information for this profile, if applicable. Credit card billing
address is optional, but if you update any of the address fields, you must enter all of
them. For example, if you want to update the street address, you must specify all of
the address fields listed in CreditCardDetailsType, not just the field for the
street address.
NOTE: Only enter credit card details for recurring payments with direct payments.
Field Description
Name xs:string
Person’s name associated with this shipping address. It is required if using a
shipping address.
Character length and limitations: 32 single-byte characters
Street1 xs:string
First street address. It is required if using a shipping address.
Character length and limitations: 100 single-byte characters
Street2 xs:string
(Optional) Second street address.
Character length and limitations: 100 single-byte characters
CityName xs:string
Name of city. It is required if using a shipping address.
Character length and limitations: 40 single-byte characters
Field Description