tanatoss/merchant-sdk-php

PayPal Merchant SDK for PHP

PayPal PHP Merchant SDK

The merchant SDK can be used for integrating with the Express Checkout, Mass Pay, Web Payments Pro APIs., _(*1)

This SDK is deprecated. It is strongly recommended that new implementations use the PHP Rest SDK

Prerequisites

PayPal's PHP Merchant SDK requires, _(*2)

• 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., _(*3)

If using composer, run composer update from the samples folder. Otherwise, run install.php from merchant-sdk-php/samples directory, _(*4)

    cd samples 
    curl  https://raw.github.com/paypal/merchant-sdk-php/stable/samples/install.php | php
        OR       
    php install.php

Using the SDK

To use the SDK,, _(*5)

• Create a composer.json file with the following contents.

{
    "name": "me/shopping-cart-app",
    "require": {
        "paypal/merchant-sdk-php":"v2.*"
    }
}

• Install the SDK as a dependency using composer or the install.php script.
• 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,, _(*6)

    // Sets config file path(if config file is used) and registers the classloader
    require("PPBootStrap.php");

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

    // Create request details
    $itemAmount = new BasicAmountType($currencyId, $amount);
    $setECReqType = new SetExpressCheckoutRequestType();
    $setECReqType->SetExpressCheckoutRequestDetails = $setECReqDetails;

    // Create request
    $setECReq = new SetExpressCheckoutReq();
    $setECReq->SetExpressCheckoutRequest = $setECReqType;
    ......

    // Perform request
    $paypalService = new PayPalAPIInterfaceServiceService($config);
    $setECResponse = $paypalService->SetExpressCheckout($setECReq);

    // Check results
    if(strtoupper($setECResponse->Ack) == 'SUCCESS') {
        // Success
    }  

Authentication

The SDK provides multiple ways to authenticate your API call., _(*7)

    $paypalService = new PayPalAPIInterfaceServiceService($config);

    // Use the default account (the first account) configured in sdk_config.ini
    $response = $paypalService->SetExpressCheckout($setECReq);

    // Use a specific account configured in sdk_config.ini
    $response = $paypalService->SetExpressCheckout($setECReq, 'jb-us-seller_api1.paypal.com');

    // Pass in a dynamically created API credential object
    $cred = new PPCertificateCredential("username", "password", "path-to-pem-file");
    $cred->setThirdPartyAuthorization(new PPTokenAuthorization("accessToken", "tokenSecret"));
    $response = $paypalService->SetExpressCheckout($setECReq, $cred);

SDK Configuration

The SDK allows you to configure the following parameters-, _(*8)

• 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), _(*9)

    $config = array(
       'mode' => 'sandbox',
       'acct1.UserName' => 'jb-us-seller_api1.paypal.com',
       'acct1.Password' => 'WX4WTU3S8MY44S7F'
       .....
    );
    $service  = new PayPalAPIInterfaceServiceService($config);

Alternatively, credential and configuration can be loaded from a file., _(*10)

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

You can refer full list of configuration parameters in wiki page., _(*11)

Please refer to the sample config file provided with this bundle for more., _(*12)

Instant Payment Notification (IPN)

Please refer to the IPN-README in 'samples/IPN' directory., _(*13)

Troubleshooting

• Issue with running samples

Links

• API Reference - https://developer.paypal.com/webapps/developer/docs/classic/api/#merchant
• If you need help using the SDK, a new feature that you need or have a issue to report, please visit https://github.com/paypal/merchant-sdk-php/issues