paypal / paypal-server-sdk
PayPal's SDK for interacting with the REST APIs
Requires
- php: ^7.2 || ^8.0
- ext-curl: *
- ext-json: *
- apimatic/core: ~0.3.17
- apimatic/core-interfaces: ~0.1.5
- apimatic/unirest-php: ^4.0.6
Requires (Dev)
- phan/phan: 5.4.5
- squizlabs/php_codesniffer: ^3.5
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
🚨 Security Advisory: PHP2Shell (CVE-2026-109618 & CVE-2026-109619)
Two critical remote code execution (RCE) vulnerabilities in PHP, CVE-2026-109618 and CVE-2026-109619 (collectively "PHP2Shell", CVSS 9.2), allow an attacker to execute arbitrary code on a server running a vulnerable PHP version.
Action required
- Check your version:
php -v - Upgrade to the patched PHP release for your branch as soon as it is available. See the official PHP advisory for fixed versions.
- Update base images,
composer.json("require": {"php": ">=X.Y.Z"}), and CI matrices to the patched version. Recommended versions are (8.2.35+, 8.3.36+, 8.4.27+, 8.5.12+). The PayPal Server SDK has been confirmed to be compatible with all of them. - If you use managed hosting, confirm with your provider that the patch has been applied.
- Until patched, treat internet-facing PHP apps as exposed and apply compensating controls (restrict access, WAF rules).
Please note: this is a vulnerability with PHP itself and not the PayPal Server SDK. Future releases of the PayPal Server SDK will formally drop support for unpatched versions of PHP.
Introduction
Important Notes
- Available Features: This SDK currently contains only 5 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.
Information
The PayPal Server SDK provides integration access to the PayPal REST APIs. The API endpoints are divided into distinct controllers:
- Orders Controller: Orders API v2
- Payments Controller: Payments API v2
- Vault Controller: Payment Method Tokens API v3 Available in the US only.
- Transaction Search Controller: Transaction Search API v1
- Subscriptions Controller: Subscriptions API v1
Install the Package
Run the following command to install the package and automatically add the dependency to your composer.json file:
composer require "paypal/paypal-server-sdk:2.4.0"
Or add it to the composer.json file manually as given below:
"require": { "paypal/paypal-server-sdk": "2.4.0" }
You can also view the package at: https://packagist.org/packages/paypal/paypal-server-sdk#2.4.0
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| environment | Environment |
The API environment. Default: Environment.SANDBOX |
| timeout | int |
Timeout for API calls in seconds. Default: 0 |
| enableRetries | bool |
Whether to enable retries and backoff feature. Default: false |
| numberOfRetries | int |
The number of retries to make. Default: 0 |
| retryInterval | float |
The retry time interval between the endpoint calls. Default: 1 |
| backOffFactor | float |
Exponential backoff factor to increase interval between retries. Default: 2 |
| maximumRetryWaitTime | int |
The maximum wait time in seconds for overall retrying requests. Default: 0 |
| retryOnTimeout | bool |
Whether to retry on request timeout. Default: true |
| httpStatusCodesToRetry | array |
Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524 |
| httpMethodsToRetry | array |
Http methods to retry against. Default: 'GET', 'PUT' |
| loggingConfiguration | LoggingConfigurationBuilder |
Represents the logging configurations for API calls |
| proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
| clientCredentialsAuth | ClientCredentialsAuth |
The Credentials Setter for OAuth 2 Client Credentials Grant |
The API client can be initialized as follows:
use PaypalServerSdkLib\Logging\LoggingConfigurationBuilder; use PaypalServerSdkLib\Logging\RequestLoggingConfigurationBuilder; use PaypalServerSdkLib\Logging\ResponseLoggingConfigurationBuilder; use Psr\Log\LogLevel; use PaypalServerSdkLib\Environment; use PaypalServerSdkLib\Authentication\ClientCredentialsAuthCredentialsBuilder; use PaypalServerSdkLib\PaypalServerSdkClientBuilder; $client = PaypalServerSdkClientBuilder::init() ->clientCredentialsAuthCredentials( ClientCredentialsAuthCredentialsBuilder::init( 'OAuthClientId', 'OAuthClientSecret' ) ) ->environment(Environment::SANDBOX) ->loggingConfiguration( LoggingConfigurationBuilder::init() ->level(LogLevel::INFO) ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) ) ->build();
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | PayPal Live Environment |
| SANDBOX | Default PayPal Sandbox Environment |
Authorization
This API uses the following authentication schemes.
List of APIs
SDK Infrastructure
Configuration
- ProxyConfigurationBuilder
- LoggingConfigurationBuilder
- RequestLoggingConfigurationBuilder
- ResponseLoggingConfigurationBuilder