Initiate and Verify Refunds with .NET SDK

This section explains how to initiate a refund for a successful transaction using the Initiate Refund. You need to provide details like the original transaction ID, refund amount, and refund ID. After initiating the refund, you can use Refund Status to check whether the refund was successful, pending, or failed. These APIs help you manage the full refund lifecycle efficiently. Use them to ensure timely and transparent customer experiences.

Initiate Refund

Use the refund() function to initiate a refund. This ensures the amount is returned to the customer’s original payment method.

Initiating Refund Request

You can use the RefundRequest Builder to create the refund request and the following are the attributes that merchant can pass.

    public async Task<IActionResult> CustomRefund()
    {
        var merchantRefundId = Guid.NewGuid().ToString();

        var refundRequest = RefundRequest.Builder()
            .SetMerchantRefundId(merchantRefundId)
            .SetAmount(100)
            .SetMerchantOrderId("ORDER9999") // merchantOrderID whose refund is to be intitiated
            .Build();

        try
        {
            var response = await _customCheckoutClient.Refund(refundRequest);
            return Ok(response);
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "Custom Refund API Failed");
            return StatusCode(500, new { message = ex.Message });
        }
    }

Refund Initiation Response

The function returns a RefundResponse Object:

Check Refund Status

Refund Status is used to retrieve the current status and details of a refund request made against a payment. By calling the getRefundStatus() function with the refund ID, you can track whether the refund is pending, successful, or failed, enabling you to manage and update refund workflows accordingly.

Refund Status Request

Pass the below parameter to get the refund status in getRefundStatus() :

    public async Task<IActionResult> CustomRefundStatus(string refundId)
    {
        _logger.LogInformation($"Testing Custom GetRefundStatus API for Refund ID: {refundId}...");
        try
        {
            var response = await _customCheckoutClient.GetRefundStatus(refundId);
            _logger.LogInformation("Refund Status Response:\n{Response}", JsonSerializer.Serialize(response, new JsonSerializerOptions { WriteIndented = true }));
            return Ok(response);
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "Custom RefundStatus API Failed");
            return StatusCode(500, new { message = ex.Message });
        }
    }

Refund Status Response

It returns a RefundStatusResponse Object:

The PaymentRefundDetail property contains a list of payment details for each payment attempt made against an order. The details of each payment are explained in the table below:

What’s Next?

In this section, you’ve learned how to initiate a refund and check its status. In the next section, you’ll understand how payment verification is handled using Webhooks, and how to manually verify the payment in case the webhook callback fails.