PayPal PHP Adaptive Payments SDK

Prerequisites

PayPal's PHP Adaptive Payments SDK requires

• PHP 5.2 and above with curl/openssl extensions enabled

Installing the SDK

if not using composer

run installation script from adaptivepayments-sdk-php/samples directory

curl  https://raw.github.com/paypal/adaptivepayments-sdk-php/composer/samples/install.php | php

    or 
    
php install.php

if using composer

Run from adaptivepayments-sdk-php/samples directory and after the installation set the path to config file in PPBootStrap.php, config file is in vendor/paypal/adaptivepayments-sdk-php/config/

composer update 

Using the SDK

To use the SDK,

• Update the sdk_config.ini with your API credentials.
• Require "PPBootStrap.php" in your application. [copy it from vendor/paypal/adaptivepayments-sdk-php/sample/ if using composer]
• To run samples : copy samples in [vendor/paypal/adaptivepayments-sdk-php/] to root directory and run in browser
• To build your own application:
• Instantiate a service wrapper object
• Instantiate a request object as per your project's needs. All the API request and response classes are available in services\AdaptivePayments\AdaptivePaymentsService.php
• Invoke the appropriate method on the service object passing in the request object.

For example,

//sets config file path and loads all the classes
require("PPBootStrap.php");

$payRequest = new PayRequest($requestEnvelope, $actionType, $cancelUrl, 
                              $currencyCode, $receiverList, $returnUrl);
// Add optional params
if($_POST["feesPayer"] != "") {
   $payRequest->feesPayer = $_POST["feesPayer"];
}
......

$service = new AdaptivePaymentsService();

$response = $service->Pay($payRequest);	
$ack = strtoupper($response->responseEnvelope->ack); 
if($ack == 'SUCCESS') {
	// Success
}

The SDK provides multiple ways to authenticate your API call.

$service = new AdaptivePaymentsService();

// Use the default account (the first account) configured in sdk_config.ini
$response = $service->Pay($payRequest);	

// Use a specific account configured in sdk_config.inig
$response = $service->Pay($payRequest, '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 = $service->Pay($payRequest, $cred);	

SDK Configuration

Replace the API credential in config/sdk_config.ini . You can use the configuration file to configure

• (Multiple) API account credentials.
• Service endpoint and other 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) ex : $service = new AdaptivePaymentsService($configMap); // where $configMap is a config array

Please refer to the sample config file provided with this bundle.

Using multiple SDKs together

*add the required sdk names to 'required' section of composer.json *add the service endpoint to 'config/sdk_config.ini', for the endpoints refer the list below

Endpoint Configuration

*set 'mode' to 'SANDBOX' for testing and 'LIVE' for production

Instant Payment Notification (IPN)

refer to the IPN-README in 'samples/IPN' directory

Getting help

If you need help using the SDK, a new feature that you need or have a issue to report, please visit

https://www.x.com/developers/paypal/forums/adaptive-payments-api

 OR

https://github.com/paypal/adaptivepayments-sdk-php/issues