Skip to content

paypal/PayPal-TypeScript-Server-SDK

Repository files navigation

Getting Started with PayPal Server SDK

Introduction

⚠️ Beta Release Notice

This version is considered a beta release. While we have done our best to ensure stability and functionality, there may still be bugs, incomplete features, or breaking changes in future updates.

Important Notes

  • Available Features: This SDK currently contains only 3 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.
  • API Changes: Expect potential changes in APIs and features as we finalize the product.

Information

The PayPal Server SDK provides integration access to the PayPal REST APIs. The API endpoints are divided into distinct controllers:

Find out more here: https://developer.paypal.com/docs/api/orders/v2/

Install the Package

Run the following command from your project directory to install the package from npm:

npm install @paypal/paypal-server-sdk@0.6.1

For additional package details, see the Npm page for the @paypal/[email protected] 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<HttpClientOptions> 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

HttpClientOptions

Parameter Type Description
timeout number Timeout in milliseconds.
httpAgent any Custom http agent to be used when performing http requests.
httpsAgent any Custom https agent to be used when performing http requests.
retryConfig Partial<RetryConfiguration> Configurations to retry requests.

RetryConfiguration

Parameter Type Description
maxNumberOfRetries number Maximum number of retries.
Default: 0
retryOnTimeout boolean Whether to retry on request timeout.
Default: true
retryInterval number Interval before next retry. Used in calculation of wait time for next request in case of failure.
Default: 1
maximumRetryWaitTime number Overall wait time for the requests getting retried.
Default: 0
backoffFactor number Used in calculation of wait time for next request in case of failure.
Default: 2
httpStatusCodesToRetry number[] Http status codes to retry against.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
httpMethodsToRetry HttpMethod[] Http methods to retry against.
Default: ['GET', 'PUT']

The API client can be initialized as follows:

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

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

Classes Documentation