Skip to main content
The Akatus .NET SDK is a library that enables integration with the Akatus payment API in .NET applications.

​
Requirements

The Akatus .NET SDK requires:
  • .NET Framework 3.5 or higher
  • System.Configuration - For reading configuration from Web.Config
  • System.Net - For HTTP requests
  • System.Web - For web application integration
  • System.Xml and System.Xml.Linq - For XML processing

​
Installation Methods

There are two ways to add the Akatus SDK to your .NET project:

​
Method 1: Add Project Reference

If you have access to the source code, you can add the Akatus project directly to your solution:
1

Add the project to your solution

In Visual Studio, right-click on your solution and select Add > Existing Project. Navigate to the Akatus.Src folder and select the Akatus.csproj file.
2

Add a reference to the Akatus project

Right-click on your application project and select Add Reference. In the Projects tab, check the Akatus project.
3

Import the namespace

Add the following using statements to your code files:
using Akatus;
using Akatus.Carrinho;
using Akatus.Enums;

​
Method 2: Add DLL Reference

If you have the compiled DLL file:
1

Build or obtain the Akatus.dll

If building from source, compile the Akatus.Src project. The DLL will be located in:
  • Debug build: Akatus.Src/bin/Debug/Akatus.dll
  • Release build: Akatus.Src/bin/Release/Akatus.dll
2

Add the DLL reference

Right-click on your project and select Add Reference. Click Browse and navigate to the Akatus.dll file.
3

Import the namespace

Add the following using statements to your code files:
using Akatus;
using Akatus.Carrinho;
using Akatus.Enums;

​
Configuration

After installing the SDK, you need to configure your Akatus API credentials in your Web.Config file. Add the following configuration keys in the <appSettings> section:
Web.Config
<configuration>
  <appSettings>
    <!-- Akatus - Environment ('producao' or 'testes') -->
    <add key="AkatusAmbiente" value="testes"/>
    
    <!-- Akatus - API Key -->
    <add key="AkatusApiKey" value="YOUR-API-KEY"/>
    
    <!-- Akatus - NIP Token -->
    <add key="AkatusTokenNIP" value="YOUR-NIP-TOKEN"/>
    
    <!-- Akatus - Account Email -->
    <add key="AkatusEmail" value="[email protected]"/>
  </appSettings>
</configuration>
The SDK reads configuration values from Web.Config using ConfigurationManager.AppSettings. Make sure your application has a reference to System.Configuration.

​
Configuration Parameters

ParameterDescriptionValues
AkatusAmbienteThe environment to usetestes for testing, producao for production
AkatusApiKeyYour Akatus API keyProvided by Akatus
AkatusTokenNIPToken for Instant Payment NotificationsProvided by Akatus
AkatusEmailEmail used for your Akatus accountYour account email
Always use the testes environment during development and testing. Only switch to producao when you’re ready to process real transactions.

​
Verify Installation

To verify that the SDK is properly installed and configured, try creating a simple instance: 
using Akatus;
using Akatus.Carrinho;

// Create a new cart instance
Carrinho carrinho = new Carrinho();

// If no errors occur, the SDK is installed correctly

​
Next Steps

Now that you have installed the Akatus SDK, you can:

Build docs developers (and LLMs) love

Get started for freeTalk to us