Refund Details

This API retrieves refund details for a specific transaction using the transactionReference provided in the URL. The response includes the total refundable amount and a history of refunds associated with the transaction.

Path Parameters

Field Name	Type	Required	Description
transactionReference	string	TRUE	The unique reference for the original transaction, provided in the URL.

Response Body

Field Name	Type	Description
refundableAmount	number	The total amount refundable for the transaction.
refundsHistory	array	An array of refund history objects detailing each refund.

Refund History Object

Field Name	Type	Description
transactionReference	string	The transaction reference associated with the refund.
refundReference	string	The unique reference for the refund.
refundAmount	number	The amount refunded.
refundReason	string	The reason provided for the refund (e.g., "Order cancelled!").
customerNote	string	A note from the customer regarding the refund.
refundType	string	The type of refund (e.g., "PARTIAL_REFUND").
refundStatus	string	The current status of the refund (e.g., "COMPLETED").
refundStrategy	string	The strategy used for processing the refund (e.g., "MERCHANT_WALLET").
comment	string	Additional comments regarding the refund.
completedOn	string	The timestamp when the refund was completed.
createdOn	string	The timestamp when the refund record was created.

Responses

🟢200Refund Details

application/json

Body

Example

{
    "refundableAmount": 475,
    "refundsHistory": [
        {
            "transactionReference": "000004240320184906771219576423",
            "refundReference": "909090934",
            "refundAmount": 25,
            "refundReason": "Order cancelled!",
            "customerNote": "Invoice SubLedger Refund",
            "refundType": "PARTIAL_REFUND",
            "refundStatus": "COMPLETED",
            "refundStrategy": "MERCHANT_WALLET",
            "comment": "Transaction refund is complete.",
            "completedOn": "26/01/2024 11:18:30 AM",
            "createdOn": "26/01/2024 11:14:29 AM"
        }
    ]
}

Path Parameters

Response Body

Refund History Object

Request

Request Code Samples

Responses

Refund Details

Path Parameters#

Response Body#

Refund History Object#

Request

Request Code Samples

Responses

Path Parameters

Response Body

Refund History Object