ALATPay.NET 1.0.1

ALATPay.NET

Simplifying Payments, Empowering Businesses.

ALATPay.NET is a .NET library that simplifies integrating payment functionalities into your application. Designed for merchants and developers, it wraps the powerful ALATPay APIs, enabling seamless interactions with payment services like merchant onboarding, business management, and more.

Table of Contents

• Features
• Installation
• Getting Started
• Usage Examples
  • Merchant Onboarding
  • Fetching Businesses
• Error Handling
• Support

Features

• Merchant Onboarding: Manage merchant profiles.
• Business Management: Fetch, and track business information.
• Secure Transactions: Built-in mechanisms for secure API calls using subscription keys and support for seamless integration via the following channels.
  • Pay via Bank Transfer
  • Pay with Card
• Scalable Design: Supports various .NET target frameworks (e.g., .NET, .NET5.0, .NET 6.0, .NET 7.0, and .NET 8.0).

Installation

Install the ALATPay.NET NuGet package using the Package Manager Console or .NET CLI.

Package Manager Console:

Install-Package ALATPay.NET

The most important type in this library is the ALATPayClient class. You can create an instance of this class as follows:

var subscriptionKey = ConfigurationManager.AppSettings["SubscriptionKey"];
var api = new ALATPayClient(subscriptionKey, EnvironmentEnum.DEV);

Environment Configuration

The ALATPayClient constructor requires an EnvironmentEnum, which defines the environment in which the API operates:

public enum EnvironmentEnum
{
    DEV,
    SANDBOX,
    PROD
}

Here are the test credentials for the dev environment:

• Business ID: 75a10b9d-5a94-43ef-71d7-08dcd7e2d6b4
• Transaction ID: 999cf73f-4b3c-4161-ae1c-4cf2f17da45e
• SubscriptionKey: a7589540b7374b7f8dee0e2ef7efdaad
• Merchant ID: 1ea91ec2-851e-47f1-ac6a-08dcd7e5dac5

Please see usage examples (and instructions) below:

Transactions API

To consume the Transactions API, use methods from the ITransactionsApi interface (available via the Transactions property of ALATPayClient, viz:

// Initializing a transaction
var response = api.Transactions.FetchTransaction(new Guid(999cf73f-4b3c-4161-ae1c-4cf2f17da45e));
if (response.Status)
  // use response.Data
else
  // show response.Message

The ITransactions is defined as follows:

public interface ITransactions
{
        Task<ApiResponse<TransactionModel>> FetchTransaction(Guid id, CancellationToken cancellationToken = default);

        Task<ApiResponse<CustomerListModel>> ListCustomers(Guid merchantId, Guid businessId, CancellationToken cancellationToken = default);

        Task<ApiResponse<TransactionListModel>> ListTransactions(Guid merchantId, Guid userId, Guid businessId, decimal amount, DateTime startAt, DateTime endAt, int paymentMethodId = 0, string status = "All", string currency = "NGN", int page = 1, int offset = 10, CancellationToken cancellationToken = default);
}

Error Handling

All responses in ALATPay.NET are wrapped in the ApiResponse<T> class. Instead of throwing exceptions, the library follows a functional approach where errors are returned as part of the response. Users should always check the Status property before accessing the Data.

ApiResponse Definition:

public class ApiResponse<T>
{
    [JsonProperty("data")]
    public T Data { get; set; }

    public bool Status { get; set; }

    public string? Message { get; set; }

    public int ErrorCode {get; set;}
}

Error Handling Example:

var response = api.Transactions.FetchTransaction(transactionId);
if (response.Status)
{
    var transaction = response.Data;
    // Process transaction
}
else
{
    //Handle error as deem fit
    Console.WriteLine($"Error: {response.Message}");
}

By following this approach, API consumers can handle errors gracefully without dealing with exceptions unless necessary.

Handling HTTP Errors

• 4xx Errors (Client Errors): These errors occur due to invalid requests, such as missing parameters or authentication failures.

• The Message property will contain a relevant error message.

• Status will be false, and Data will be null

• Example:

  var response = await api.SomeMethod();
  
  if (!response.Status)
  {
      Console.WriteLine($"Client Error: {response.Message}");
  }
  

• 5xx Errors (Server Errors): These errors indicate issues on the server side

• The Message property will contain a generic server error message.

• Status will be false, and Data will be null.

• Example:

  var response = await api.SomeMethod();
  
  if (!response.Status || response.ErrorCode == 500)
  {
      Console.WriteLine($"Server Error: {response.Message}");
  }
  

Other APIs

Other APIs are implemented in like manner and exposed via the ALATPayClient type as given below:

// Bank Transfer APIs
var request = new GenerateVirtualAccountModel { ... };
var response = api.BanKTransfers.GenerateVirtualAccount(request);
// etc

Support

For inquiries or support, please contact support@alatpay.com

• Email: ALATPaysupport@Wemabank.com
• Website: ALATPay
• GitHub Issues: Please create an issue in this repository if you encounter any bugs.