AuroPayPayments 1.0.0

Auropay .NET SDK

The Auropay .NET SDK provides a streamlined integration for merchants to interact with Auropay's payment APIs. This SDK abstracts complex API interactions, allowing merchants to focus on delivering excellent user experiences. It includes support for creating payment links, refunds, querying payment status, and generating payment QR codes.

Features

• Create Payment Link: Simplify generating payment links with extensive customization options.
• Create Refund: Enable seamless refund processing for orders.
• Get Payment Status by Transaction ID or Reference ID: Retrieve transaction details easily.
• Generate Payment QR Code: Support for dynamic QR code generation for payments.
• Secure and User-friendly: Built with industry-standard encryption and ease of use in mind.
• Comprehensive Documentation: Includes detailed examples and configuration guides for easy onboarding.

Table of Contents

1. Requirements
2. Installation
3. Configuration
4. Usage Examples
   • Initialize the AuropayClient
   • Create Payment Link
   • Create Refund
   • Get Payment Status by Transaction ID
   • Generate Payment QR Code
   • Get Payment Status by Reference Number
5. License

Requirements

• Programming Language: Compatible with .NET 8.
• API Keys: Access your API key and secret from the Auropay merchant dashboard.

Installation

Install the Auropay .NET SDK via NuGet:

  dotnet add package AuroPayPayments -- version

NuGet\Install-Package AuroPayPayments -Version

<PackageReference Include="AuroPayPayments" Version="1.0.0" />

Prerequisites for Configuration

Store your API key and secret securely in environment variables or configuration files:

var clientConfig = new AuropayApiClientConfiguration
{
    Environment = "UAT",
    AccessKey = accessKey,
    SecretKey = secretKey,
    Version = "1.0"
};

Usage Examples

1. Initialize the AuropayClient

var apiClient = new AuropayApiClient(clientConfig);

2. Create Payment Link

Method: CreatePaymentLink

This method utilizes the settings provided in the PaymentLinkRequest to generate a payment link. The returned response contains details such as the payment link URL, expiration time, and other relevant metadata.

Code Snippet:

var createPaymentLinkRequest = new CreatePaymentLinkRequest
{
    Title = form["Title"],
    ExpireOn = form["ExpireOn"],
    ShortDescription = form["ShortDescription"],
    Amount = double.TryParse(form["Amount"], out var amount) ? amount : 0,
    Currency = form["Currency"],
    Customer = new PaymentCustomer
    {
        FirstName = form["Customer_FirstName"],
        LastName = form["Customer_LastName"],
        Email = form["Customer_Email"],
        Phone = form["Customer_Phone"]
    },
    CallbackParameters = new CallbackParameters
    {
        CallbackApiUrl = form["CallbackParameters_CallbackApiUrl"],
        ReferenceNo = form["CallbackParameters_ReferenceNo"]
    },
    ResponseType = RequestPayResponseType.CallBack
};

var response = await apiClient.CreatePaymentLink(createPaymentLinkRequest);

var jsonResponse = JsonSerializer.Serialize(response, new JsonSerializerOptions { WriteIndented = true });
Console.WriteLine($"API Response: {jsonResponse}");

3. Create Refund

Method: CreateRefund

Code Snippet:

var createRefundRequest = new CreateRefundRequest
{
    OrderId = form["OrderId"],
    Amount = double.TryParse(form["Amount"], out var amount) ? amount : 0,
    Remarks = form["Remarks"]
};

var response = await apiClient.CreateRefund(createRefundRequest);

var jsonResponse = JsonSerializer.Serialize(response, new JsonSerializerOptions { WriteIndented = true });
Console.WriteLine($"API Response: {jsonResponse}");

4. Get Payment Status by Transaction ID

Method: GetTransactionById

Code Snippet:

var paymentById = await apiClient.GetTransactionById(paymentId);
var jsonResponse = JsonSerializer.Serialize(paymentById, new JsonSerializerOptions { WriteIndented = true });

context.Response.ContentType = "application/json";
await context.Response.WriteAsync(jsonResponse);

5. Generate Payment QR Code

Method: CreatePaymentQRCode

This method generates a dynamic QR code for payments using the CreateQRCodeRequest object.

Code Snippet:

var createQRCodeRequest = new CreateQRCodeRequest
{
    Title = form["Title"],
    ExpireOn = form["ExpireOn"],
    ShortDescription = form["ShortDescription"],
    Amount = double.TryParse(form["Amount"], out var amount) ? amount : 0,
    Currency = form["Currency"],
    Customers = new List<PaymentLinkCustomerRequest>
    {
        new PaymentLinkCustomerRequest
        {
            FirstName = form["Customer_FirstName"],
            LastName = form["Customer_LastName"],
            Email = form["Customer_Email"],
            Phone = form["Customer_Phone"]
        }
    },
    CallbackParameters = new CallbackParameters
    {
        CallbackApiUrl = form["CallbackParameters_CallbackApiUrl"],
        ReferenceNo = form["CallbackParameters_ReferenceNo"]
    },
    ResponseType = RequestPayResponseType.CallBack
};

var response = await apiClient.CreateQRCode(createQRCodeRequest);

var jsonResponse = JsonSerializer.Serialize(response, new JsonSerializerOptions { WriteIndented = true });
Console.WriteLine($"API Response: {jsonResponse}");

6. Get Payment Status by Reference Number

Method: GetTransactionByRefNo

Code Snippet:

var paymentByRefNo = await apiClient.GetTransactionByRefNo(refNo);
var jsonResponse = JsonSerializer.Serialize(paymentByRefNo, new JsonSerializerOptions { WriteIndented = true });

context.Response.ContentType = "application/json";
await context.Response.WriteAsync(jsonResponse);

License

Distributed under the MIT License. See LICENSE for more information.

For more information, visit the Auropay Documentation.