Paystack.Client.Sdk 1.1.0

Paystack.Client.Sdk

A .NET 8 SDK for integrating with the Paystack payment gateway. Provides a clean, strongly-typed client for initializing transactions and verifying payment status.

Installation

Install via NuGet Package Manager Console:

Install-Package Paystack.Client.Sdk

Or via the .NET CLI:

dotnet add package Paystack.Client.Sdk

Requirements

• .NET 8.0 or later
• A Paystack account and secret key — get yours at paystack.com

Configuration

Add a PaystackConfig section to your appsettings.json:

{
  "PaystackConfig": {
    "BaseUrl": "https://api.paystack.co",
    "SecretKey": "sk_live_your_secret_key_here"
  }
}

Use sk_test_... keys during development and sk_live_... in production.

Setup

Register the SDK in your Program.cs or Startup.cs:

using Paystack.Client.Sdk.Extensions;

builder.Services.AddPaystackClient(builder.Configuration);

This registers IPaystackClient as a scoped dependency, ready for constructor injection.

Usage

Inject IPaystackClient wherever you need it:

public class PaymentService
{
    private readonly IPaystackClient _paystack;

    public PaymentService(IPaystackClient paystack)
    {
        _paystack = paystack;
    }
}

Initialize a Transaction

Start a payment by creating a transaction. Paystack returns an authorization URL to redirect the user to.

Important: Paystack expects amounts in the smallest currency unit (kobo for NGN). Multiply naira amounts by 100.

var request = new PaystackInitializeTransactionRequest
{
    Email       = "customer@example.com",
    Amount      = 5000 * 100,  // ₦5,000 in kobo
    Reference   = Guid.NewGuid().ToString("N"),
    CallbackUrl = "https://yourapp.com/payment/callback",
    MetaData    = new { orderId = "ORD-001" }
};

var result = await _paystack.InitializeTransaction(request);

if (result.Data?.Status == true)
{
    var authorizationUrl = result.Data.Data?.AuthorizationUrl;
    // redirect the user to authorizationUrl
}

PaystackInitializeTransactionRequest fields:

Verify a Transaction

After the user completes payment, verify the transaction using the reference:

var result = await _paystack.CheckTransactionStatus("your-transaction-reference");

if (result.Data?.Status == true)
{
    var transaction = result.Data.Data;

    Console.WriteLine($"Status:   {transaction?.Status}");
    Console.WriteLine($"Amount:   {transaction?.Amount}");
    Console.WriteLine($"Channel:  {transaction?.Channel}");
    Console.WriteLine($"Paid At:  {transaction?.PaidAt}");

    var customer = transaction?.Customer;
    Console.WriteLine($"Customer: {customer?.FirstName} {customer?.LastName} ({customer?.Email})");

    var auth = transaction?.Authorization;
    Console.WriteLine($"Card:     {auth?.CardType} ending {auth?.Last4}");
}

Using a Per-Request API Key

Both methods accept an optional apiKey parameter to override the configured secret key. Useful for multi-tenant scenarios:

var result = await _paystack.InitializeTransaction(request, apiKey: "sk_live_tenant_key");

var status = await _paystack.CheckTransactionStatus(reference, apiKey: "sk_live_tenant_key");

Response Models

ApiResults<T>

All methods return ApiResults<T>. Check Data for the typed payload.

PaystackResponseData (InitializeTransaction)

public class PaystackResponseData
{
    public bool    Status  { get; set; }
    public string? Message { get; set; }
    public PaystackAuthorizationData? Data { get; set; }
}

public class PaystackAuthorizationData
{
    public string? AuthorizationUrl { get; set; }  // redirect the user here
    public string? AccessCode       { get; set; }
    public string? Reference        { get; set; }
}

PaystackTransactionResponse (CheckTransactionStatus)

public class PaystackTransactionResponse
{
    public bool   Status  { get; set; }
    public string? Message { get; set; }
    public PaystackTransaction? Data { get; set; }
}

PaystackTransaction key fields:

License

MIT © Samuel Biliksuun