Getting Started with PayPal Server SDK

Introduction

$3

- Available Features: This SDK currently contains only 5 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.

$3

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 from your project directory to install the package from npm:

``bash
npm install @paypal/paypal-server-sdk@2.2.0
`

For additional package details, see the Npm page for the @paypal/paypal-server-sdk@2.2.0 npm.

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 | number | Timeout for API calls.
Default: 0 |
| httpClientOptions | Partial | Stable configurable http client options. |
| unstableHttpClientOptions | any | Unstable configurable http client options. |
| logging | PartialLoggingOptions | Logging Configuration to enable logging |
| clientCredentialsAuthCredentials | ClientCredentialsAuthCredentials | The credential object for clientCredentialsAuth |

The API client can be initialized as follows:

$3

`ts
import { Client, Environment, LogLevel } from '@paypal/paypal-server-sdk';

const client = new Client({
clientCredentialsAuthCredentials: {
oAuthClientId: 'OAuthClientId',
oAuthClientSecret: 'OAuthClientSecret'
},
timeout: 0,
environment: Environment.Sandbox,
logging: {
logLevel: LogLevel.Info,
logRequest: {
logBody: true
},
logResponse: {
logHeaders: true
}
},
});
`

$3

`ts
import * as path from 'path';
import * as fs from 'fs';
import { Client } from '@paypal/paypal-server-sdk';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);
`

See the Configuration-Based Client Initialization section for details.

$3

`ts
import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from '@paypal/paypal-server-sdk';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
// Load environment variables from .env file
dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);
`

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

$3

| Name | Description |
| --- | --- |
| Production | PayPal Live Environment |
| Sandbox | Default PayPal Sandbox Environment |

Authorization

This API uses the following authentication schemes.

* Oauth2 (OAuth 2 Client Credentials Grant)`

List of APIs

* Orders
* Payments
* Vault
* Transaction Search
* Subscriptions

SDK Infrastructure

$3

* HttpClientOptions
* RetryConfiguration
* ProxySettings
* Configuration-Based Client Initialization
* Environment-Based Client Initialization
* PartialLoggingOptions
* PartialRequestLoggingOptions
* PartialResponseLoggingOptions
* LoggerInterface

$3

* HttpRequest

$3

* ApiResponse
* ApiError