PayPalServerSDK 2.3.0

Getting Started with PayPal Server SDK

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

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package PayPalServerSDK --version 2.3.0

You can also view the package at: https://www.nuget.org/packages/PayPalServerSDK/2.3.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Initialization

using Microsoft.Extensions.Logging;
using PaypalServerSdk.Standard;
using PaypalServerSdk.Standard.Authentication;

namespace ConsoleApp;

PaypalServerSdkClient client = new PaypalServerSdkClient.Builder()
 .ClientCredentialsAuth(
 new ClientCredentialsAuthModel.Builder(
 "OAuthClientId",
 "OAuthClientSecret"
 )
 .Build())
 .HttpClientConfig(httpClientConfig =>
 httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
 .Environment(PaypalServerSdk.Standard.Environment.Sandbox)
 .LoggingConfig(config => config
 .LogLevel(LogLevel.Information)
 .RequestConfig(reqConfig => reqConfig.Body(true))
 .ResponseConfig(respConfig => respConfig.Headers(true))
 )
 .Build();

Configuration-Based Initialization

using PaypalServerSdk.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
 .AddJsonFile("config.json")
 .AddEnvironmentVariables() // [optional] read environment variables
 .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = PaypalServerSdkClient
 .FromConfiguration(configuration.GetSection("PaypalServerSdk"));

See the Configuration-Based Initialization section for details.

Environments

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

Fields

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

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• JsonObject
• JsonValue