Refund Transaction API

This endpoint allows users to initiate a refund for a specific transaction using its unique reference. By sending a PUT request to the specified URL, you can process a refund based on the details provided in the request body.

Request

HTTP Method: PUT
Endpoint: https://api.akupay.africa/transaction/refund/{transactionReference}

Request Body

The request body must be in JSON format and should contain the following parameters:

• transactionReference (string): The unique identifier for the transaction that is being refunded.

• refundAmount (number): The amount to be refunded to the customer.

• refundReason (string): The reason for the refund request.

Example Request Body:

{
    "transactionReference": "tx_12345678",
    "refundAmount": 100.5,
    "refundReason": "Customer requested refund"
}

Response

Upon a successful request, the API will return a status code of 200, indicating that the refund has been processed successfully. The response will be in XML format, although the content may not contain additional details.

Response Example:

• Status: 200

• Content-Type: text/xml

Notes

• Ensure that the transactionReference corresponds to a valid transaction.

• The refundAmount should not exceed the original transaction amount.

• Provide a clear and concise refundReason to facilitate processing.

This API is essential for managing customer transactions and ensuring a smooth refund process.