Monnify.SDK 1.0.0

Monnify .NET SDK

A comprehensive .NET SDK for the Monnify payment gateway. Supports collections, disbursements, reserved accounts, webhooks, and more.

Installation

dotnet add package Monnify.SDK

Quick Start

1. Register services

// From appsettings.json
builder.Services.AddMonnify(builder.Configuration.GetSection("Monnify"));

// Or inline
builder.Services.AddMonnify(opts =>
{
    opts.ApiKey = "MK_TEST_...";
    opts.SecretKey = "...";
    opts.ContractCode = "...";
    opts.Environment = MonnifyEnvironment.Sandbox;
    opts.SourceAccountNumber = "..."; // For disbursements
});

// Add webhook validation (optional)
builder.Services.AddMonnifyWebhooks("your-secret-key");

2. appsettings.json

{
  "Monnify": {
    "ApiKey": "MK_TEST_...",
    "SecretKey": "...",
    "ContractCode": "...",
    "Environment": "Sandbox",
    "SourceAccountNumber": "..."
  }
}

3. Use the client

public class PaymentService
{
    private readonly IMonnifyClient _monnify;

    public PaymentService(IMonnifyClient monnify) => _monnify = monnify;

    // Create a virtual account for receiving payments
    public async Task CreateVirtualAccount()
    {
        var result = await _monnify.ReservedAccounts.CreateAsync(new CreateReservedAccountRequest
        {
            AccountReference = "student-001",
            AccountName = "John Doe School Fees",
            CustomerEmail = "john@example.com",
            CustomerName = "John Doe",
            Bvn = "12345678901",
            GetAllAvailableBanks = true
        });

        if (result.IsSuccess)
        {
            foreach (var account in result.ResponseBody!.Accounts!)
                Console.WriteLine($"{account.BankName}: {account.AccountNumber}");
        }
    }

    // Verify a bank account (name enquiry)
    public async Task<string?> VerifyAccount(string accountNumber, string bankCode)
    {
        var result = await _monnify.Verification.ValidateAccountAsync(accountNumber, bankCode);
        return result.ResponseBody?.AccountName;
    }

    // Send money to a bank account
    public async Task SendMoney()
    {
        var result = await _monnify.Disbursements.InitiateSingleTransferAsync(new SingleTransferRequest
        {
            Amount = 50000,
            Reference = $"TXN-{Guid.NewGuid():N}",
            Narration = "Salary payment",
            DestinationBankCode = "058",
            DestinationAccountNumber = "0123456789",
            DestinationAccountName = "John Doe"
        });

        Console.WriteLine($"Status: {result.ResponseBody?.Status}, Fee: {result.ResponseBody?.TotalFee}");
    }

    // Send money in bulk
    public async Task BulkTransfer()
    {
        var result = await _monnify.Disbursements.InitiateBulkTransferAsync(new BulkTransferRequest
        {
            Title = "October Payroll",
            BatchReference = $"BATCH-{DateTime.UtcNow:yyyyMMdd}",
            Narration = "Salary",
            OnValidationFailure = "CONTINUE",
            TransactionList = new List<BulkTransferItem>
            {
                new() { Amount = 50000, Reference = "ref-001", Narration = "Salary - John",
                         DestinationBankCode = "058", DestinationAccountNumber = "0123456789",
                         DestinationAccountName = "John Doe" },
                new() { Amount = 75000, Reference = "ref-002", Narration = "Salary - Jane",
                         DestinationBankCode = "044", DestinationAccountNumber = "9876543210",
                         DestinationAccountName = "Jane Smith" }
            }
        });
    }
}

Webhook Handling

app.MapPost("/webhooks/monnify", async (HttpContext ctx, IWebhookValidator validator) =>
{
    // Read raw body
    using var reader = new StreamReader(ctx.Request.Body);
    var body = await reader.ReadToEndAsync();
    var signature = ctx.Request.Headers["monnify-signature"].FirstOrDefault();

    // Validate and parse
    var webhookEvent = validator.ParseAndValidate(body, signature!);

    switch (webhookEvent.EventType)
    {
        case WebhookEventTypes.SuccessfulTransaction:
            var txn = webhookEvent.GetData<TransactionEventData>();
            // Handle inflow...
            break;

        case WebhookEventTypes.SuccessfulDisbursement:
            var disbursement = webhookEvent.GetData<DisbursementEventData>();
            // Handle successful payout...
            break;

        case WebhookEventTypes.FailedDisbursement:
            var failed = webhookEvent.GetData<DisbursementEventData>();
            // Handle failed payout...
            break;
    }

    return Results.Ok();
});

Features

Configuration

License

MIT