NVP API Web Samples

This chapter describes the NVP API Web Samples which access the NVP API directly. This section includes the following topics:

l	“Descriptions of the Samples”

l	“Samples Using Classic ASP”

l	“Samples Using PHP”

l	“Samples Using ColdFusion”

Descriptions of the Samples

The web samples consist of the following:

l	“Charging a Credit Card Using Direct Payment”

l	“Accepting PayPal in Express Checkout”

l	“Getting Transaction Details”

l	“Common Files”

The main page of the samples, index.html or Default.htm, contains links to each sample.

Note:

We describe the code samples for all programming languages in this section. Language specific filenames are shown as filename.ext. For example, DoDirectPayment.ext stands for DoDirectPayment.java, DoDirectPayment.php, and so forth.

Charging a Credit Card Using Direct Payment

This sample shows how to use Direct Payment to charge a credit card. Access this sample from the following choices displayed on index.html or Default.htm:

DoDirectPayment - Sale	Charge a credit card. In the DoDirectPayment request, the PAYMENTACTION parameter is set to Sale.
DoDirectPayment - Authorization	Authorize a credit card for later sale. In the DoDirectPayment request, the PAYMENTACTION parameter is set to Authorization.

The primary files for this sample are:

Table C.1

Direct Payment Files

File	Description
DoDirectPayment.ext	This is the main web page for the DoDirectPayment sample. This page allows the user to enter name, address, amount, and credit card information. It also accept input variable paymentType which becomes the value of the PAYMENTACTION parameter. When the user clicks the Submit button, DoDirectPaymentReceipt.ext is called. Called by index.html or Default.htm. Calls DoDirectPaymentReceipt.ext.
DoDirectPaymentReceipt.ext	Submits a credit card transaction to PayPal using a DoDirectPayment request. The code collects transaction parameters from the form displayed by DoDirectPayment.ext then constructs and sends the DoDirectPayment request string to the PayPal server. The paymentType variable becomes the PAYMENTACTION parameter of the request string. After the PayPal server returns the response, the code displays the API request and response in the browser. If the response from PayPal was a success, it displays the response parameters. If the response was an error, it displays the errors. Called by DoDirectPayment.ext. Calls CallerService.ext.

Accepting PayPal in Express Checkout

This sample shows how to use Express Checkout to accept payments using PayPal. Access this sample from the following choices displayed on index.html or Default.htm:

ExpressCheckout - Sale	Do basic checkout with PayPal. In the SetExpressCheckout request, the PAYMENTACTION parameter is set to Sale.
ExpressCheckout - Authorization	Authorize for a single capture. In the SetExpressCheckout request, the PAYMENTACTION parameter is set to Authorization.
ExpressCheckout - Order	Authorize for multiple captures. In the SetExpressCheckout request, the PAYMENTACTION parameter is set to Order.

The primary files for this sample are:

Table C.2

Express Checkout Files

File	Description
SetExpressCheckout.ext	This is the main web page for the Express Checkout sample. The page allows the user to enter amount and currency type. It also accept input variable paymentType which becomes the value of the PAYMENTACTION parameter. When the user clicks the Submit button, ReviewOrder.ext is called. Called by index.html or Default.htm. Calls ReviewOrder.ext.
ReviewOrder.ext	This file is called after the user clicks on a button during the checkout process to use PayPal's Express Checkout. The user logs in to their PayPal account. This file is called twice. On the first pass, the code executes the if statement: if (! isset ($token)) The code collects transaction parameters from the form displayed by SetExpressCheckout.ext then constructs and sends a SetExpressCheckout request string to the PayPal server. The paymentType variable becomes the PAYMENTACTION parameter of the request string. The RETURNURL parameter is set to this file; this is how ReviewOrder.ext is called twice. On the second pass, the code executes the else statement. On the first pass, the buyer completed the authorization in their PayPal account; now the code gets the payer details by sending a GetExpressCheckoutDetails request to the PayPal server. Then the code calls GetExpressCheckoutDetails.ext. Note: Be sure to check the value of PAYPAL_URL. The buyer is sent to this URL to authorize payment with their PayPal account. For testing purposes, this should be set to the PayPal sandbox. Called by SetExpressCheckout.ext. Calls GetExpressCheckoutDetails.ext, CallerService.ext, and Display.ext.
GetExpressCheckoutDetails.ext	This functionality is called after the buyer returns from PayPal and has authorized the payment. Displays the payer details returned by the GetExpressCheckoutDetails response and calls DoExpressCheckoutPayment.ext to complete the payment authorization. Called by ReviewOrder.ext. Calls DoExpressCheckoutPayment.ext and CallerService.ext.
DoExpressCheckoutPayment.ext	This functionality is called to complete the payment with PayPal and display the result to the buyer. The code constructs and sends the DoExpressCheckoutPayment request string to the PayPal server. Called by GetExpressCheckoutDetails.ext and CallerService.ext.

Getting Transaction Details

This sample shows how to use the GetTransactionDetails request. Access this sample from the following choice displayed on index.html or Default.htm:

GetTransactionDetails

Gets transaction details for a specific transaction ID. The main page displays a text box where the user enters a transaction ID. When the user clicks the Submit button, the code constructs an NVP API request to GetTransactionDetails and sends it to the PayPal server.

The primary files for this sample are:

Table C.3

Get Transaction Details Files

File	Description
GetTransactionDetails.ext	This is the main page for GetTransactionDetails sample. This page displays a text box where the user enters a transaction ID and a Submit button that calls TransactionDetails.ext. Calls TransactionDetails.ext.
TransactionDetails.ext	Sends a GetTransactionDetails NVP API request to PayPal. The code retrieves the transaction ID and constructs the NVP API request string to send to the PayPal server. The request to PayPal uses an API signature. After receiving the response from the PayPal server, the code displays the request and response in the browser. If the response was a success, it displays the response parameters. If the response was an error, it displays the errors received. Called by GetTransactionDetails.html.

Common Files

The following files are common to the samples.

Table C.4

Common Files

File	Description
index.html Default.htm	The main web page with links to each sample. Calls DoDirectPayment.ext, SetExpressCheckout.ext, and GetTransactionDetails.html.
sdk.css	Cascading Style Sheet (CSS) used by index.html or Default.htm.
CallerService.ext	This is the configuration file for the samples.This file contains the parameters needed to make an API call. The samples come with an API signature for making API calls to the PayPal sandbox. The API signature is described in “Sample API User with API Signature”. Called by TransactionDetails.ext, ReviewOrder.ext, DoDirectPaymentReceipt.ext, and Display.ext.
Display.ext	Displays request and response parameters. If there is an error, displays request and error parameters. Called by DoDirectPaymentReceipt.ext, TransactionDetails.ext, and DoExpressCheckoutPayment.ext.

Sample API User with API Signature

The samples come with an API signature for use with the samples and the PayPal Sandbox. This API signature belongs to the following user:

 

Table C.5

Details of the Sample API Signature

API username	sdk-three_api1.sdk.com
API password	QFZCWN5HZM8VBG7Q
API signature	A‑IzJhZZjhg29XQ2qnhapuwxIDzyAZQ92FRP5dqBzVesOkzbdUONzmOU

IMPORTANT:

You must protect the API signature values in your implementation. Consider storing these values in a secure location other than your web server document root and setting the file permissions so that only the system user executing your ecommerce application can access it.

The sample code does not store these values securely. The sample code should never be used in production.

Samples Using Classic ASP

This section contains information for configuring and running the NVP API Web Samples Using Classic ASP.

Required Software

No additional software is required.

Download and Unzip the Samples

The latest version of the Web Samples are available at https://www.paypal.com/IntegrationCenter/ic_nvp.html.

1.	Download the zipfile distribution.

2.	Unzip the zipfile to any directory of you choose.

Installing the Samples

The samples must be installed in IIS. The samples require IIS version 5.1 or above.

Create a virtual directory named PayPalClassicAspNvpSamples in IIS that points to Samples_Root.

Running the Samples

First, make sure that you have installed the required software and the samples.

You can run the samples by entering the following address in a web browser:

http://name_of_Server:port/PayPalClassicAspNvpSamples/Default.htm

Samples Using PHP

This section contains information for configuring and running the NVP API Web Samples Using PHP.

Required Software

The following software is required:

Table C.6

Required Software

Software	Version	Download Location
PHP with CURL extension enabled	4.4.2 or greater
Apache HTTP Server	1.3.17 or greater	http://httpd.apache.org/

You must install and configure PHP with the Apache HTTP Server.

Download and Unzip the Samples

The latest version of the Web Samples are available at https://www.paypal.com/IntegrationCenter/ic_nvp.html.

1.	Download the zipfile distribution.

2.	Unzip the zipfile to any directory of you choose.

Installing the Samples

Copy the sample folder, php_nvp_samples, to the docroot of the Apache HTTP Server. By default docroot is in datadir/htdocs.

Running the Samples

First, make sure that you have installed the required software and the samples.

You can run the samples by entering the following address in a web browser:

http://name_of_Apache_HTTP_Server:port/php_nvp_samples/index.html

Samples Using ColdFusion

This section contains information for configuring and running the NVP API Web Samples Using ColdFusion.

Required Software

The following software is required:

Table C.7

Supported Standards

Standard	Version	Download Location
ColdFusion	7.x MX	http://www.adobe.com/products/coldfusion/

Download and Unzip the Samples

The latest version of the Web Samples are available at https://www.paypal.com/IntegrationCenter/ic_nvp.html.

1.	Download the zipfile distribution.

2.	Unzip the zipfile to any directory of you choose.

Installing the Samples

Note:

The samples assume that ColdFusion is running on Microsoft Windows.

Copy the sample folder to your ColdFusion application server web document root, ColdFusionMX7_root_directory\wwwroot.

Running the Samples

First, make sure that you have installed the required software and the samples.

You can run the samples by entering the following address in a web browser:

http://name_of_Server:port/cf_nvp_samples/index.html