Refund Endpoint API Reference

This page provides detailed information about the Refund Endpoint API, which allows you to process refunds for transactions on our platform.

Overview

The Refund Endpoint is designed to facilitate the process of issuing refunds to customers for transactions that were processed through our payment gateway. This API endpoint provides a secure and efficient way to handle refund requests, ensuring that your customers receive timely and accurate refunds.

Endpoint URL

https://yourdomain.com/RefundEndpoint

Request Parameters

transaction_id: The unique identifier for the transaction that needs to be refunded.
amount: The amount to be refunded, in the same currency as the original transaction.
currency: The currency of the refund, which must match the currency of the original transaction.
reason: Optional. The reason for the refund, which can be used for internal tracking and reporting.

Response

The API will return a JSON response with the following fields:

status: The status of the refund request. Possible values are success, failed, or pending.
message: A brief message describing the result of the refund request.
transaction_id: The unique identifier for the transaction that was refunded.

Example Request

GET https://yourdomain.com/RefundEndpoint?transaction_id=123456789&amount=100&currency=USD&reason=customer_request

Example Response

{
  "status": "success",
  "message": "Refund processed successfully.",
  "transaction_id": "123456789"
}

Usage Guidelines

Ensure that the transaction_id and amount are correctly specified to avoid processing errors.
Use the reason parameter to provide additional context for the refund, if necessary.
Always check the status and message in the response to verify that the refund request was processed successfully.

For more information on API usage and best practices, please visit our API Documentation.