Payflow Gateway SDKs

Open-source SDKs for the PayPal Payflow Gateway — available for .NET and Java. Both SDKs are currently at v5.0.4.

Important: v5 is not fully backwards-compatible with v4. Review the CHANGELOG in each SDK directory before upgrading an existing integration.

SDKs

SDK	Directory	Build Tool	Min Runtime
.NET	dotNET/	dotnet CLI / Visual Studio 2022+	.NET 8.0, .NET 10.0, or .NET Framework 4.8
Java	java/	Apache Maven 3.6+	Java 11

The .NET SDK is published on NuGet:

dotnet add package PayPal.Payflow

See each SDK's directory for full setup and usage details:

• dotNET/README.md — build, NuGet packaging, samples, SHFB docs
• java/README.md — Maven build, sample compilation, IDE setup

See the CHANGELOG in each directory for a detailed history of changes:

• dotNET/CHANGELOG.md
• java/CHANGELOG.md

Quick Start

Both SDKs ship with run-sample scripts that build and run the DOSaleComplete connectivity test in one step.

PowerShell (Windows):

# .NET
cd dotNET && .\run-sample.ps1

# Java
cd java && .\run-sample.ps1

Bash (Linux / macOS / Git Bash):

# .NET
cd dotNET && ./run-sample.sh

# Java
cd java && ./run-sample.sh

Command Prompt (Windows):

cd dotNET && run-sample.bat
cd java    && run-sample.bat

Fill in your Payflow credentials in the sample file before running. The credentials section is near the top of DOSaleComplete.cs / DOSaleComplete.java.

Build Systems

.NET

The .NET SDK uses the standard dotnet CLI (SDK-style project file). The package is published on NuGet.org as PayPal.Payflow and can be installed directly:

dotnet add package PayPal.Payflow

To build locally from source:

cd dotNET/PFProSDK
dotnet build            # build for net8.0, net10.0, and net48
dotnet pack -c Release  # produces PayPal.Payflow.5.0.4.nupkg

The resulting .nupkg is a multi-targeted NuGet package compatible with .NET 8.0, .NET 10.0, and .NET Framework 4.8.

Java

The Java SDK uses Apache Maven. The library has zero external runtime dependencies — XML parsing uses the JDK-bundled JAXP implementation.

cd java
mvn clean package   # produces target/payflow.jar

Documentation

• Payflow Gateway Developer's Guide: developer.paypal.com/docs/payflow/integration-guide/
• XMLPay schema and general info: Payflow Developer's Guide (NVP/SOAP)
• New Features & Revision History: developer.paypal.com/docs/payflow/integration-guide/new-features/
• .NET API Reference (generated): run build-docs.ps1 (or build-docs.bat) in dotNET/Payflow SDK Docs/ — requires SHFB v2026+; then open with view-docs.ps1
• Java API Reference (online): paypal.github.io/payflow-gateway/ — or generate locally with mvn javadoc:javadoc in java/ (or use generate-docs.bat/ps1/sh)

SDK Binaries (v4)

The last pre-open-source v4 SDK binaries are preserved in the SDK Binaries directory. They do not include the newest NVPs; all active development is on v5.

Contributing

See the CONTRIBUTING.md in the relevant SDK directory:

• dotNET/CONTRIBUTING.md
• java/CONTRIBUTING.md

Questions or bugs? Open an issue.

License

Code released under the SDK LICENSE.