MonnifyDotnetSDK 1.0.0
dotnet add package MonnifyDotnetSDK --version 1.0.0
NuGet\Install-Package MonnifyDotnetSDK -Version 1.0.0
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="MonnifyDotnetSDK" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MonnifyDotnetSDK" Version="1.0.0" />
<PackageReference Include="MonnifyDotnetSDK" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MonnifyDotnetSDK --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MonnifyDotnetSDK, 1.0.0"
#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.
#:package MonnifyDotnetSDK@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MonnifyDotnetSDK&version=1.0.0
#tool nuget:?package=MonnifyDotnetSDK&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Monnify .NET SDK
Monnify .NET SDK simplifies integration with the Monnify API for developers using .NET.
Features
- Easy-to-use SDK for Monnify payments.
- Supports:
- CustomerReservedAccount
- DirectDebit
- Invoice
- LimitProfile
- Paycode
- RecurringPayment
- Refund
- Settlement
- SubAccount
- Transaction
- Transfer
- Verification
- Wallet
- Other
Installation
Install the package via NuGet:
dotnet add package MonnifyDotnetSDK
Configuration
Add your Monnify credentials in appsettings.json:
{
"MonnifyOptions": {
"ApiKey": "YOUR_API_KEY",
"ApiSecret": "YOUR_SECRET_KEY",
"BaseUrl": "https://sandbox.monnify.com/api/v1",
"ContractCode": "YOUR__CONTRACT_CODE"
}
}
Usage
You can use in two ways, either register the SDK in your application:
1. Via Dependency Injection
builder.Services.AddMonnify(options =>
{
options.ApiKey = builder.Configuration["MonnifyOptions:ApiKey"];
options.ApiSecret = builder.Configuration["MonnifyOptions:ApiKey"];
options.BaseUrl = builder.Configuration["MonnifyOptions:BaseUrl"];
});
public class PaymentService {
private readonly IMonnifyClient _monnifyClient;
PaymentService(IMonnifyClient monnifyClient) {
_monnifyClient = monnifyClient;
}
public YourResponse InitiatePayment(Request request) {
var response = _monnifyClient.Transaction.InitiateTransaction(request);
...
}
}
2. or simply create a new instance of MonnifyClient
var monnifyClient = new MonnifyClient(new MonnifyOptions
{
ApiKey = "{{API_KEY}}",
ApiSecret = "{{API_SECRET}}",
BaseUrl = "{{BASE_URL}}"
})
var paymentRequest = new InitiatizeTransaction
{
Amount = 5000.00m,
CurrencyCode = "NGN",
CustomerEmail = "customer@example.com",
CustomerName = "John Doe",
PaymentReference = "unique-payment-ref",
PaymentDescription = "Test Payment",
ContractCode = "1438045810",
RedirectUrl = "https://your-site.com/payment-callback"
};
var response = await monnifyClient.Transaction.InitiateTransaction(paymentRequest);
...
API Documentation
For detailed information about the Monnify API, refer to the official documentation.
License
This SDK is licensed under the MIT License. See the LICENSE file for details.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net6.0
- Microsoft.Extensions.Http (>= 8.0.1)
- Newtonsoft.Json (>= 13.0.1)
-
net7.0
- Microsoft.Extensions.Http (>= 8.0.1)
- Newtonsoft.Json (>= 13.0.1)
-
net8.0
- Microsoft.Extensions.Http (>= 8.0.1)
- Newtonsoft.Json (>= 13.0.1)
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 |
|---|---|---|
| 1.0.0 | 223 | 2/13/2025 |