Vantiv.PayFacMpSdkForNet 13.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package Vantiv.PayFacMpSdkForNet --version 13.0.1
NuGet\Install-Package Vantiv.PayFacMpSdkForNet -Version 13.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Vantiv.PayFacMpSdkForNet" Version="13.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Vantiv.PayFacMpSdkForNet --version 13.0.1
#r "nuget: Vantiv.PayFacMpSdkForNet, 13.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Vantiv.PayFacMpSdkForNet as a Cake Addin
#addin nuget:?package=Vantiv.PayFacMpSdkForNet&version=13.0.1

// Install Vantiv.PayFacMpSdkForNet as a Cake Tool
#tool nuget:?package=Vantiv.PayFacMpSdkForNet&version=13.0.1

Build Status Github All Releases GitHub GitHub issues


The PayFac Merchant Provisioner SDK is a C# implementation of the Worldpay PayFac Merchant Provisioner API. This SDK was created to make it as easy as possible to perform operations that allows you to create and update Legal Entities and Sub-merchants, as well as retrieve information about existing Legal Entities and Sub-merchants in near real-time. This SDK utilizes the HTTPS protocol to securely connect to Worldpay. Using the SDK requires coordination with the Vantiv eCommerce team in order to be provided with credentials for accessing our systems.

Each .NET SDK release supports all of the functionality present in the associated PayFac Merchant Provisioner API version (e.g., SDK v13.0.0 supports API v13.0.0). Please see our documentation for PayFac Merchant Provisioner API to get more details on what operations are supported.

This SDK is implemented to support the .NET plaform, including C#, VB.NET and Managed C++ and is created by Worldpay. Its intended use is for PayFac API operations with Worldpay.

Getting Started

These instructions will help you get started with using the SDK.




1.) To install it, copy PayFacSdkForNet.dll into your Visual Studio references.

2.) You can configure it statically by adding the following section to your project's App.config

<?xml version="1.0" encoding="utf-8"?>
        <sectionGroup name="userSettings" type="System.Configuration.UserSettingsGroup, System, Version=, Culture=neutral, PublicKeyToken=b77a5c561934e089">
            <section name="PayFacMpSDK.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=, Culture=neutral, PublicKeyToken=b77a5c561934e089" allowExeDefinition="MachineToLocalUser" requirePermission="false"/>
            <setting name="url" serializeAs="String">
            <setting name="username" serializeAs="String">
            <setting name="password" serializeAs="String">
            <setting name="proxyHost" serializeAs="String">
                <value />
            <setting name="timeout" serializeAs="String">
            <setting name="printxml" serializeAs="String">
            <setting name="proxyPort" serializeAs="String">
                <value />
            <setting name="neuterXml" serializeAs="String">
<startup><supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5"/></startup>

Also, you can use a Configuration instance to set the values of the different keys by using Set method.


Configuration config = new Configuration();
config.Set(username, "myUsername");

The different Keys and values which chould be passed are:

    username = myUsername
    password = myPassword
    url =
    printxml = true
    neuterXml = false
    proxyHost = myProxyHost
    proxyPort = 7777


List of configuration parameters along with their values can be found here.

Usage example

Let's try our SDK with the Sandbox, which doesn't require a valid username and password:

using System;

namespace PayFacMpSDK
    internal class Program

        public static void Main(string[] args)
            string legalEntityId = "201015";
            var request = new AgreementRetrievalRequest();
            request.Configuration.Set("url", "");
            request.Configuration.Set("printxml", "true");

            var response = request.GetLegalEntityAgreementRequest(legalEntityId);

            var agreements = response.agreements;

            foreach(var agreement in agreements)
                Console.WriteLine("Aggrement Type :" + agreement.legalEntityAgreementType);
                Console.WriteLine("Aggrement Version :" + agreement.agreementVersion);


Compile and run this file. You should see the following result:

    Case Id:1288791001


For the versions available, see the tags on this repository.


For the list of changes, check out the changelog


See also the list of contributors who participated in this project.


This project is licensed under the MIT License - see the LICENSE file for details


More examples can be found in Functional and Unit Tests


Please contact Vantiv eCommerce to receive valid merchant credentials in order to run tests successfully or if you require assistance in any way. Support can also be reached at

Product Compatible and additional computed target framework versions.
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
13.1.0 23,714 8/3/2020
13.0.4 495 6/16/2020
13.0.3 6,691 12/10/2019
13.0.1 1,841 9/19/2018
13.0.0 750 9/11/2018

* Bug Fix Fixing loading of Configuration