Cibpay .NET SDK Github readme banner

⚠️ PREVIEW VERSION

This SDK is currently in preview. Features and APIs may change in future releases. Use in production environments at your own discretion.

CibPay .NET SDK¶

A comprehensive .NET library for integrating with CibPay’s payment processing API. This official SDK provides a simple, secure, and efficient way to implement payment functionality in your .NET applications, specifically designed for the Azerbaijani local banking system.

⭐ We appreciate your star, it helps!

GitHub Repo stars

Key Features¶

🔒 Secure Authentication - Certificate-based authentication with basic auth support
💳 Order Management - Create and retrieve payment orders with comprehensive status tracking
🏗️ Easy Integration - Simple client setup with dependency injection support
⚡ Async/Await Support - Modern async programming patterns throughout
🛡️ Type Safety - Strongly-typed models and comprehensive error handling
📱 Multi-Platform - Compatible with console apps, ASP.NET Core, and other .NET platforms

Quick Installation¶

dotnet add package CibPay.Sdk

Quick Example¶

using CibPay.Http.Configuration;
using CibPay.Sdk;
using CibPaySdk.Core.Models;

// Configure the SDK
var options = new SdkOptions
{
    Username = "your-username",
    Password = "your-password", 
    BaseUrl = "https://api-preprod.cibpay.co",
    CertificatePath = "Certificate/api-cibpay.p12",
    CertificatePassword = "your-cert-password",
};

// Create client
var client = CibPayClientFactory.Create(options);

// Create an order
var order = await client.Orders.CreateAsync(new CreateOrderRequest 
{ 
    Amount = 100.50m 
});

Console.WriteLine($"Order created: {order.Data.Id}");

🚀 Getting Started¶

Installation - Package installation and prerequisites
Quick Start - Step-by-step tutorial for your first payment
Configuration - Complete configuration guide

📚 Core Concepts¶

Authentication & Security - Certificate setup and security best practices
Order Lifecycle - Understanding order statuses and transitions
Payment Flow - End-to-end payment process

📖 API Reference¶

Client Setup - Client initialization and dependency injection
Order Operations - Creating and retrieving orders
Models & Types - Request/response models and enums

Supported Operations¶

Operation	Status	Description
Create Order	✅ Available	Create new payment orders
Get Order	✅ Available	Retrieve order details with expansions
Refunds	🔄 Coming Soon	Process refunds and reversals
Webhooks	🔄 Coming Soon	Handle payment notifications

Links & Resources¶

Github Repository - Source code and issues
CibPay Website - Official CibPay information
.NET Documentation - Microsoft .NET docs

Support & Contributing¶

💖 Premium Sponsor and Support: @Cibpay

For issues, contributions, or feedback: - 🐛 Report Issues - 💡 Feature Requests - 📧 Contact Developer

Maintainer: Ali Aliyev - LinkedIn