AsthaIT.SSLCommerz 1.0.0

AIT.Packages.PaymentGateway

A lightweight .NET library for integrating SSLCommerz payment gateway functionality into your applications. This package provides a simple and secure way to process payments, get transactions, and Validate transactions.

Installation

dotnet add package AsthaIT.SSLCommerz

Usage

AITSSLCommerzClient

The AITSSLCommerzClient class provides static methods to interact with the SSLCommerz payment gateway.

1. Create a Payment Request

Initiate a payment and get the payment URL to redirect your customer.

using AIT.Packages.SSLCommerz;
using AIT.Packages.SSLCommerz.Payload;

var payload = new SSLCommerzCreatePaymentPayload
{
    StoreId = "your-store-id", //Provided by SSLCommerz
    StorePassword = "your-store-password", 
    Amount = 1500.75,
    Currency = "BDT",
    TransactionId = Guid.NewGuid().ToString(),
    SuccessUrl = "https://example.com/success",
    FailedUrl = "https://example.com/fail",
    CancelUrl = "https://example.com/cancel",
    IpnCallbackUrl = "https://example.com/ipn",
    CustomerName = "John Doe",
    CustomerEmail = "john.doe@example.com",
    CustomerPhone = "01700000000",
    CustomerAddress = "123 Demo Street",
    //CustomerCity = "Dhaka",
    //CustomerPostCode = "1207",
    //CustomerCountry = "Bangladesh",
    //ProductName = "Demo Product",
    //ProductCategory = "general",
    MetaDataA = "custom_value_a"
};

var response = await AITSSLCommerzClient.CreatePaymentRequestAsync(
    payload,
    SSLCommerzPaymentEnvironment.Sandbox // or Live
);

if (response.IsSuccess)
{
    var paymentUrl = response.Data.PaymentUrl; // Redirect user to paymentUrl  
}

2. Get Payment Validation Status

Validate a payment using the validation ID received from SSLCommerz.

var validationResponse = await AITSSLCommerzClient.GetPaymentValidationStatusAsync(
    validationId: "your-validation-id",
    storeId: "your-store-id", //Provided by SSLCommerz
    storePassword: "your-store-password", //Provided by SSLCommerz
    environment: SSLCommerzPaymentEnvironment.Sandbox // or Live
);

if (validationResponse.IsSuccess)
{
    // Access transaction details from validationResponse.Data
}

3. Get Payment Transactions by Transaction ID

Retrieve a list of transactions for a specific transaction ID.

var transactionListResponse = await AITSSLCommerzClient.GetPaymentTransactionsByTransactionIdAsync(
    transactionId: "your-transaction-id", // This is the tran_id that you provide when creating the payment request.
    storeId: "your-store-id", // Provided by SSLCommerz
    storePassword: "your-store-password", // Provided by SSLCommerz
    environment: SSLCommerzPaymentEnvironment.Sandbox // or Live
);

if (transactionListResponse.IsSuccess)
{
    // Access transactions from transactionListResponse.Data
}

4. Get Payment Transaction by Session Key

Retrieve transaction details using a session key.

var transactionResponse = await AITSSLCommerzClient.GetPaymentTransactionBySessionKeyAsync(
    sessionKey: "your-session-key", //The sessionKey returned by the CreatePaymentRequestAsync response.
    storeId: "your-store-id", // Provided by SSLCommerz
    storePassword: "your-store-password", // Provided by SSLCommerz
    environment: SSLCommerzPaymentEnvironment.Sandbox // or Live
);

if (transactionResponse.IsSuccess)
{
    // Access transaction details from transactionResponse.Data
}

IPN Callback endpoint (Same for Success And Failed Callback)

   [HttpPost]
   [Route("sslcommerz/ipn/callback")] // Make sure same as create payment request IpnCallbackUrl
   [AllowAnonymous]
   public async Task<IActionResult> SSLCommerzIpnCallbackAsync([FromForm] SSLCommerzPaymentCallbackResponse response)
   {
      // Here validate payment transaction
       return Ok();
   }

   

SSLCommerz Official Documentation

• SSLCommerz Documentation

Dependencies

• AsthaIT.RestClient
• Microsoft.AspNetCore.Mvc.Core

License

MIT License

Author

Developed and maintained by AIT.