ladela/paypal-adaptivepayments-sdk-php

Paypal PHP Adaptive Payments SDK

PayPal PHP Adaptive Payments SDK

Prerequisites

PayPal's PHP Adaptive Payments SDK requires, _(*1)

• PHP 5.2 and above with curl/openssl extensions enabled

Using the SDK

To use the SDK,, _(*2)

• Copy the config and lib folders into your project. Modify the config file to suit your needs.
• Make sure that the lib folder in your project is available in PHP's include path
• Include the services\AdaptivePayments\AdaptivePaymentsService.php file in your code.
• 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,, _(*3)

``` php, <sub>(*4)</sub>

require_once('services/AdaptivePayments/AdaptivePaymentsService.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.

``` php
    $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, <sub>(*5)</sub>

• (Multiple) API account credentials.
• Service endpoint and other HTTP connection parameters
• Logging

Please refer to the sample config file provided with this bundle., <sub>(*6)</sub>

Using multiple SDKs together

*copy the contents in 'lib/service/' to one of the SDKs *add the service endpoint to 'config/sdk_config.ini', for the endpoints refer the list below, <sub>(*7)</sub>

Endpoint Configuration

*The list below specifies endpoints for different services, in SANDBOX and PRODUCTION, with their property keys and end-point as property values., <sub>(*8)</sub>

------------------------------SANDBOX------------------------------
* Merchant/Button Manager Service (3 Token)
service.EndPoint.PayPalAPI=https://api-3t.sandbox.paypal.com/2.0
service.EndPoint.PayPalAPIAA=https://api-3t.sandbox.paypal.com/2.0, <sub>(*9)</sub>

• Merchant/Button Manager Service (Certificate)
  service.EndPoint.PayPalAPI=https://api.sandbox.paypal.com/2.0
  service.EndPoint.PayPalAPIAA=https://api.sandbox.paypal.com/2.0, <sub>(*10)</sub>

• AdaptiveAccounts Platform Service
  service.EndPoint.AdaptiveAccounts=https://svcs.sandbox.paypal.com/, <sub>(*11)</sub>

• AdaptivePayments Platform Service
  service.EndPoint.AdaptivePayments=https://svcs.sandbox.paypal.com/, <sub>(*12)</sub>

• Invoice Platform Service
  service.EndPoint.Invoice=https://svcs.sandbox.paypal.com/, <sub>(*13)</sub>

• Permissions Platform Service
  service.EndPoint.Permissions=https://svcs.sandbox.paypal.com/, <sub>(*14)</sub>

------------------------------PRODUCTION------------------------------
* Merchant/Button Manager Service (3 Token)
service.EndPoint.PayPalAPI=https://api-3t.paypal.com/2.0
service.EndPoint.PayPalAPIAA=https://api-3t.paypal.com/2.0, <sub>(*15)</sub>

• Merchant/Button Manager Service (Certificate)
  service.EndPoint.PayPalAPI=https://api.paypal.com/2.0
  service.EndPoint.PayPalAPIAA=https://api.paypal.com/2.0, <sub>(*16)</sub>

• AdaptiveAccounts Platform Service
  service.EndPoint.AdaptiveAccounts=https://svcs.paypal.com/, <sub>(*17)</sub>

• AdaptivePayments Platform Service
  service.EndPoint.AdaptivePayments=https://svcs.paypal.com/, <sub>(*18)</sub>

• Invoice Platform Service
  service.EndPoint.Invoice=https://svcs.paypal.com/, <sub>(*19)</sub>

• Permissions Platform Service
  service.EndPoint.Permissions=https://svcs.paypal.com/, <sub>(*20)</sub>

For additional information please refer to https://www.x.com/developers/paypal/documentation-tools/api, <sub>(*21)</sub>

Instant Payment Notification (IPN)

refer to the IPN-README in 'samples/IPN' directory, <sub>(*22)</sub>

Getting help

If you need help using the SDK, a new feature that you need or have a issue to report, please visit, <sub>(*23)</sub>

https://www.x.com/developers/paypal/forums/adaptive-payments-api, <sub>(*24)</sub>

 OR

https://github.com/paypal/adaptivepayments-sdk-php/issues, <sub>(*25)</sub>