This package is abandoned and no longer maintained. No replacement package was suggested.

PayPal's PHP SDK for Payouts REST APIs

1.0.1 2021-09-28 16:40 UTC

This package is not auto-updated.

Last update: 2024-01-19 16:37:55 UTC


Home Image

Welcome to PayPal Payouts. This repository contains PayPal's PHP SDK for Payouts and samples for v1/payments/payouts APIs.

This is a part of the next major PayPal SDK. It includes a simplified interface to only provide simple model objects and blueprints for HTTP calls. This repo currently contains functionality for PayPal Payouts APIs which includes Payouts.

Please refer to the PayPal Payouts Integration Guide for more information. Also refer to Setup your SDK for additional information about setting up the SDK's.


PHP 5.6 and above

An environment which supports TLS 1.2 (see the TLS-update site for more information)



It is not necessary to fork this repository for using the PayPal SDK. Please take a look at PayPal Payouts Server SDK for configuring and working with SDK without forking this code.

For contributing to this repository or using the samples you can fork this repository.

Setting up credentials

Get client ID and client secret by going to and generating a REST API app. Get Client ID and Secret from there.

require __DIR__ . '/vendor/autoload.php';
use PaypalPayoutsSDK\Core\PayPalHttpClient;
use PaypalPayoutsSDK\Core\SandboxEnvironment;
// Creating an environment
$clientId = "<<PAYPAL-CLIENT-ID>>";
$clientSecret = "<<PAYPAL-CLIENT-SECRET>>";

$environment = new SandboxEnvironment($clientId, $clientSecret);
$client = new PayPalHttpClient($environment);


Creating a Payout

This will create a Payout and print batch id for the created Payouts

use PaypalPayoutsSDK\Payouts\PayoutsPostRequest;
$request = new PayoutsPostRequest();
$body= json_decode(
                  "email_subject": "SDK payouts test txn"
                "items": [
                  "recipient_type": "EMAIL",
                  "receiver": "",
                  "note": "Your 1$ payout",
                  "sender_item_id": "Test_txn_12",
                    "currency": "USD",
                    "value": "1.00"
$request->body = $body;
$client = PayPalClient::client();
$response = $client->execute($request);
print "Status Code: {$response->statusCode}\n";
print "Status: {$response->result->batch_header->batch_status}\n";
print "Batch ID: {$response->result->batch_header->payout_batch_id}\n";
print "Links:\n";
foreach($response->result->links as $link)
   print "\t{$link->rel}: {$link->href}\tCall Type: {$link->method}\n";
echo json_encode($response->result, JSON_PRETTY_PRINT), "\n";

Retrieve a Payouts Batch

This will retrieve a payouts batch

 $request = new PayoutsGetRequest($batchId);
 $response = $client->execute($request);
 echo json_encode($response->result, JSON_PRETTY_PRINT), "\n";

Parsing Failure Response

This will execute a Get request to simulate a failure

    $request = new PayoutsGetRequest(null);
    $response = $client->execute($request);
    echo json_encode($response->result, JSON_PRETTY_PRINT), "\n";
  } catch(HttpException $e){
    echo $e->getMessage()


Running tests

To run integration tests using your client id and secret, clone this repository and run the following command:

$ composer install

You may use the client id and secret above for demonstration purposes.


You can start off by trying out Samples.

Note: Update the PayPalClient.php with your sandbox client credentials or pass your client credentials as environment variable while executing the samples.


Code released under SDK LICENSE