PayPal invoice SDK for PHP

Installs: 1 901

Dependents: 0

Stars: 9

Watchers: 25

Forks: 5

Open Issues: 1

v3.9.0 2015-09-22 18:16 UTC



  • Because of the Poodle vulnerability, PayPal has disabled SSLv3.
  • To enable TLS encryption, the changes were made to PPHttpConfig.php in SDK Core to use a cipher list specific to TLS encryption.
     * Some default options for curl
     * These are typically overridden by PPConnectionManager
    public static $DEFAULT_CURL_OPTS = array(
        CURLOPT_TIMEOUT        => 60,   // maximum number of seconds to allow cURL functions to execute
        CURLOPT_USERAGENT      => 'PayPal-PHP-SDK',
        CURLOPT_HTTPHEADER     => array(),
  • There are two primary changes done to curl options:
    • CURLOPT_SSLVERSION is set to 1 . See here for more information
    • CURLOPT_SSL_CIPHER_LIST was set to TLSv1, See here for more information

All these changes are included in the recent release, along with many other bug fixes. We highly encourage you to update your versions, by either using composer or running this command shown below:

curl -k -L | php
php install.php


PayPal's PHP Invoicing SDK requires

  • PHP 5.2 and above
  • curl/openssl PHP extensions

Running the sample

To run the bundled sample, first copy the samples folder to your web server root. You will then need to install the SDK as a dependency using either composer (PHP V5.3+ only) or by running a custom installation script provided with the SDK.

If using composer, run composer update from the samples folder. Otherwise, run install.php from invoice-sdk-php/samples directory

    cd samples
    curl -k -L | php
    php samples/install.php

Using the SDK

To use the SDK,

  • Create a composer.json file with the following contents.
    "name": "me/shopping-cart-app",
    "require": {
  • Install the SDK as a dependency using composer or the install.php script from the samples directory.
  • Require vendor/autoload.php OR PPBootStrap.php in your application depending on whether you used composer or the custom installer.
  • Choose how you would like to configure the SDK - You can either
    • Create a hashmap containing configuration parameters and pass it to the service object OR
    • Create a sdk_config.ini file and set the PP_CONFIG_PATH constant to point to the directory where this file exists.
  • Instantiate a service wrapper object and a request object as per your project's needs.
  • Invoke the appropriate method on the service object.

For example,

    // Sets config file path(if config file is used) and registers the classloader

    // Array containing credentials and confiuration parameters. (not required if config file is used)
    $config = array(
       'mode' => 'sandbox',
       'acct1.UserName' => '',
       'acct1.Password' => 'WX4WTU3S8MY44S7F'

    $invoice = new InvoiceType($merchantEmail, $payerEmail, $itemList, $currencyCode, $paymentTerms);
    $requestEnvelope = new RequestEnvelope("en_US");
    $createInvoiceRequest = new CreateInvoiceRequest($requestEnvelope, $invoice);

    $invoiceService = new InvoiceService($config);
    $createInvoiceResponse = $invoiceService->CreateInvoice($createInvoiceRequest);

    if($strtoupper($createInvoiceResponse->responseEnvelope->ack == 'SUCCESS') {
        // Success


The SDK provides multiple ways to authenticate your API call.

    $invoiceService = new InvoiceService($config);

    // Use the default account (the first account) configured in sdk_config.ini
    $createInvoiceResponse = $invoiceService->CreateInvoice($createInvoiceRequest); 

    // Use a specific account configured in sdk_config.ini
    $createInvoiceResponse = $invoiceService->CreateInvoice($createInvoiceRequest, ''); 

    // Pass in a dynamically created API credential object
    $cred = new PPCertificateCredential("username", "password", "path-to-pem-file");
    $cred->setThirdPartyAuthorization(new PPTokenAuthorization("accessToken", "tokenSecret"));
    $createInvoiceResponse = $invoiceService->CreateInvoice($createInvoiceRequest, $cred);  

SDK Configuration

The SDK allows you to configure the following parameters

  • Integration mode (sandbox / live)
  • (Multiple) API account credentials.
  • HTTP connection parameters
  • Logging

Dynamic configuration values can be set by passing a map of credential and config values (if config map is passed the config file is ignored)

    $config = array(
       'mode' => 'sandbox',
       'acct1.UserName' => '',
       'acct1.Password' => 'WX4WTU3S8MY44S7F'
    $service  = new InvoiceService($config);

Alternatively, credential and configuration can be loaded from a file.

    define('PP_CONFIG_PATH', '/directory/that/contains/sdk_config.ini');
    $service  = new InvoiceService();

You can refer full list of configuration parameters in wiki page.