Table of Contents Previous Next Index

Table of Contents

Name-Value Pair API Developer Guide and Reference
Overview
Introducing the PayPal NVP API
Integrating with the PayPal API
Basic Steps
Create a Web Application
Get API Credentials
Create and Post the Request
Interpret the Response
Taking Your Application Live
Set Up a PayPal Business Account
Set Up API Credentials
Modify Your Code
Technical Details
Request-Response Model
Request Format
Response Format
Posting Using HTTPS
Charging a Credit Card Using DoDirectPayment
Final Sale
Authorizing a Payment
Recording the Final Shipping Address
Including Subtotals of Item Cost, Shipping, Handling, and Tax
Adding Line Item Details
Accepting PayPal in Express Checkout
Basic Checkout with PayPal
1. Starting the Checkout Using SetExpressCheckout
2. Redirecting the Customer’s Browser to PayPal Login Page
3. Getting Payer Details Using GetExpressCheckoutDetails
4. Making a Sale Using DoExpressCheckoutPayment
Controlling the Shipping Address Using SetExpressCheckout
Requiring a Confirmed Address
Suppressing Display of Shipping Address on PayPal
Overriding the Shipping Address Stored on PayPal
Changing the Language on the PayPal Login Page
Changing the Logo on the PayPal Pages
Specifying a Custom Payment Page Style
Specifying Logo and Color Settings Individually
Form-Filling Your Payment Review Page
Making a Sale Using DoExpressCheckoutPayment
Authorizing for Single Capture
Authorizing for Multiple Captures
Changing the URL for IPN
Including Line Item Details Using DoExpressCheckoutPayment
Including Subtotals Using DoExpressCheckoutPayment
Updating Transaction Details With DoExpressCheckoutPayment
Updating Shipping Address With DoExpressCheckoutPayment
Express Checkout for eBay Auctions
Recurring Payments API
Fraud Management Filters API
Fraud Management Filters API Prerequisites
ManagePendingTransactionStatus
ManagePendingTransactionStatus Request
ManagePendingTransactionStatus Response
Back-Office Administration
Capturing, Authorizing, Voiding, and Reauthorizing
Making a Single Capture Using DoCapture
Making Multiple Partial Captures Using DoCapture
Including an Invoice Number and Note on the Capture Using DoCapture
Refunding Using RefundTransaction
Full Refund
Partial Refunds
Including a Note with the Refund
Searching for Transactions Using TransactionSearch
Viewing Details of a Single Transaction Using GetTransactionDetails
NVP API Method and Field Reference
General Characteristics of Requests and Parameters
Parameters
Multi-Value Fields
PayPal-Supported Transactional Currencies
DoDirectPayment
DoDirectPayment Request
DoDirectPayment Response
Express Checkout
SetExpressCheckout Request
SetExpressCheckout Response
GetExpressCheckoutDetails Request
GetExpressCheckoutDetails Response
DoExpressCheckoutPayment Request
DoExpressCheckoutPayment Response
Authorization & Capture
DoAuthorization
DoCapture
DoReauthorization
DoVoid
RefundTransaction
TransactionSearch
GetTransactionDetails
Mass Payment
MassPay Request
MassPay Response
Recurring Payments and Reference Transactions
CreateRecurringPaymentsProfile
GetRecurringPaymentsProfileDetails
ManageRecurringPaymentsProfileStatus
BillOutstandingAmount
UpdateRecurringPaymentsProfile
SetCustomerBillingAgreement
GetBillingAgreementCustomerDetails
DoReferenceTransaction
Non-Referenced Credits
DoNonReferencedCredit
GetBalance
AddressVerify
Error Message Reference
Error Response Format
Validation Errors
General API Errors
Direct Payment API Errors
Express Checkout API Errors
Authorization and Capture API Errors
RefundTransaction API Errors
TransactionSearch API Errors
GetTransactionDetails API Errors
MassPay API Errors
Recurring Payments and Reference Transactions API Errors
Recurring Payments Errors
SetCustomerBillingAgreement Errors
GetBillingAgreementCustomerDetails Errors
DoReferenceTransaction Errors
DoNonReferencedCredit API Errors
Fraud Management Filters API Errors
NVP API Web Samples
Descriptions of the Samples
Charging a Credit Card Using Direct Payment
Accepting PayPal in Express Checkout
Getting Transaction Details
Common Files
Sample API User with API Signature
Samples Using Classic ASP
Required Software
Download and Unzip the Samples
Installing the Samples
Running the Samples
Samples Using PHP
Required Software
Download and Unzip the Samples
Installing the Samples
Running the Samples
Samples Using ColdFusion
Required Software
Download and Unzip the Samples
Installing the Samples
Running the Samples
The Java SDK
Installing the Java SDK
Supported Standards
Recommended Hardware Configuration
Download and Unzip the SDK
Post-installation Set-up
Complete SDK and API Class Documentation
SDK Logging
Profiles
Overview to Profile-related Classes
Sample Applications
Sample API User with API Signature
Sample API User with API Certificate
The ASP.NET SDK
Installing the ASP.NET SDK
Supported Standards
Downloading and Installing the SDK
Post-installation Set-up
Optional Custom Configurations in Web.config
SDK Logging
Enabling Proxy Support
Uninstalling the SDK
Complete SDK and API Class Documentation
Profiles
Overview to Profile-related Classes
Sample Applications
Sample API User with API Signature
Sample API User with API Certificate
Installing the Samples in IIS
Running the Samples
The Ruby on Rails SDK
Installing the Ruby on Rails SDK
Supported Standards
Recommended Hardware Configuration
Installing the SDK
Sample Applications
Proxy Support
Country Codes