GlobalPayments.Api Documentation

Global Payments .NET SDK

This SDK makes it easy to integrate your .NET application with our Card Not Present and Card Present APIs.


General / Omnichannel

Card Not Present (Ecommerce & MOTO) Specific

Card Present (Terminal & POS) Specific



Installing the SDK into your solution is usually be done by either using NuGet, or by adding the project to your solution and creating a project reference.

The project is compiled with environments compatible with dotnet tooling 2.0+ (e.g. Visual Studio 2017+) and requires .NET Standard version 1.3 or later.

To install via Nuget Manager Console:

PM> Install-Package GlobalPayments.Api -Version 1.0.20-BETA

To install via dotnet CLI:

dotnet add package GlobalPayments.Api --version 1.0.20-BETA

To install via a Project Reference:

Download and unzip or, using Git, clone the repository from GitHub. See more on how to clone repositories.

git clone

Documentation and Examples

You can find the latest SDK documentation along with code examples and test cards on the Global Payments and Heartland Developer Hubs.

In addition you can find working examples in the our example code repository.

Quick Tip: The included test suite can be a great source of code samples for using the SDK!

Process a Payment Example

var card = new CreditCardData
Number = "4263970000005262",
ExpMonth = 12,
ExpYear = 2025,
Cvn = "131",
CardHolderName = "James Mason"
var response = card.Charge(129.99m)
var result = response.ResponseCode; // 00 == Success
var message = response.ResponseMessage; // [ test system ] AUTHORISED
catch (ApiException e)
// handle errors

Test Card Data

Name Number Exp Month Exp Year CVN
Visa 4263970000005262 12 2025 123
MasterCard 2223000010005780 12 2019 900
MasterCard 5425230000004415 12 2025 123
Discover 6011000000000087 12 2025 123
Amex 374101000000608 12 2025 1234
JCB 3566000000000000 12 2025 123
Diners Club 36256000000725 12 2025 123

Testing Exceptions

During your integration you will want to test for specific issuer responses such as 'Card Declined'. Because our sandbox environments do not actually reach out to issuing banks for authorizations, there are specific transaction amounts and/or card numbers that will trigger gateway and issuing bank responses. Please contact your support representative for a complete listing of values used to simulate transaction AVS/CVV results, declines, errors, and other responses that can be caught in your code. Example error handling code:

var response = card.Charge(5.00m)
catch (BuilderException e)
// handle builder errors
catch (ConfigurationException e)
// handle errors related to your services configuration
catch (GatewayException e)
// handle gateway errors/exceptions
catch (UnsupportedTransactionException e)
// handle errors when the configured gateway doesn't support
// desired transaction
catch (ApiException e)
// handle all other errors


All our code is open sourced and we encourage fellow developers to contribute and help improve it!

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Ensure SDK tests are passing
  4. Commit your changes (‘git commit -am 'Add some feature’)
  5. Push to the branch (git push origin my-new-feature`)
  6. Create new Pull Request


This project is licensed under the GNU General Public License v2.0. Please see located at the project's root for more details.