BasSdk 5.1.2

BasSdk - Payment Method Integration Guide

Overview

BasSdk is a .NET Standard library designed for merchants who want to use BAS as a payment method in their independent mobile applications (similar to integrating PayPal or Stripe).

This guide covers the usage of IBasPaymentMethodService, which provides optimized SDK endpoints for seamless payment integration.

Initialization

Before using the service, you must initialize it with your merchant credentials and environment settings. This ensures the service knows how to connect to the BAS platform.

using BasSdk.Constants;
using BasSdk.Services;

public class PaymentService
{
    private readonly IBasPaymentMethodService _paymentService;
    
    public PaymentService(IBasPaymentMethodService paymentService)
    {
        _paymentService = paymentService;
        
        // 1. Initialize credentials
        _paymentService.Initialize(
            environment: LibraryConstants.ENVIRONMENT.SANDBOX, // SANDBOX, STAGING, or PRODUCTION
            mid: "your_merchant_id", 
            appId: "your_app_id", 
            clientId: "your_client_id", 
            clientSecret: "your_client_secret", 
            website: "your_website_url", 
            callbackUrl: "your_callback_url", 
            defaultRequestTimeOut: 60
        );

        // 2. (Optional) Enable built-in logging
        _paymentService.EnableLoggingInformation();

        // 3. (Optional) Hook your own logger
        _paymentService.SetLogActions(
            logInformation: (message) => 
            {
                Console.WriteLine($"[BasSdk Info]: {message}");
                return true;
            },
            logError: (exception, message) => 
            {
                Console.WriteLine($"[BasSdk Error]: {message} - {exception.Message}");
                return true;
            }
        );
    }
}

Installation

To install the package, use the following command in the NuGet Package Manager Console or .NET CLI:

# NuGet Package Manager
Install-Package BasSdk

# .NET CLI
dotnet add package BasSdk

Dependency Injection Registration

Register the SDK service in your dependency injection container:

// In your Startup.cs or Program.cs
services.AddBasSdk(); 

// Or if you only want to register the specific service
// services.AddTransient<IBasPaymentMethodService, BasPaymentMethodService>();

Payment Flow

The payment flow consists of two main steps from your backend's perspective:

1. Initiate Payment
2. Check Transaction Status

1. Initiate Transaction

This is the first step to initiate a payment. It returns a transaction token that you must pass to your independent mobile application to launch the BAS SDK UI and complete the payment.

var response = await _paymentService.InitiateTransactionSdkAsync(
    orderId: "ORDER_12345", 
    amount: 2000, 
    currency: "YER", 
    customerId: "customer_open_id",
    customerPhone: "+967123456789", // Optional
    customerName: "John Doe",       // Optional
    requestTimeout: 60,
    orderDetails: new
    {
        products = new List<object>
        {
            new { name = "Product 1", quantity = 1, price = 2000 }
        }
    }
);

if (response.Status != 1)
{
    // Handle error
    throw new InvalidOperationException(response.Messages.FirstOrDefault());
}

// Extract the transaction token and send it to your mobile app
string transactionToken = response.Body.TrxToken;

2. Check Transaction Status

After your mobile application completes the payment flow (using the transactionToken), you should verify the exact final status of the transaction on your backend.

var statusResponse = await _paymentService.CheckTransactionStatusSdkAsync(
    orderId: "ORDER_12345", 
    requestTimeout: 60
);

if (statusResponse.Status != 1)
{
    throw new InvalidOperationException(statusResponse.Messages.FirstOrDefault());
}

// TrxStatusId == 1202 means the payment was processed successfully
if (statusResponse.Body.TrxStatusId == 1202) 
{
    Console.WriteLine("Payment was successful!");
}
else
{
    Console.WriteLine($"Payment status is: {statusResponse.Body.TrxStatus}");
}

Refund a Payment

You can refund a full payment amount by providing the original trxToken and a reason for the refund.

var refundResponse = await _paymentService.FullPaymentRefundAsync(
    trxToken: "TRX_TOKEN_FROM_INITIATE",
    reason: "Customer requested a refund"
);

if (refundResponse.Status != 1)
{
    throw new InvalidOperationException(refundResponse.Messages.FirstOrDefault());
}

Console.WriteLine("Refund processed successfully!");

Support

For issues specific to the payment method integration or SDK functions, please verify your initialization settings or contact the Bas Team for support.