Get Refund Status

This API retrieves the status of a refund based on the refundReference provided in the URL. The response indicates whether the request was successful and returns detailed information about the refund.

Path Parameters

Field Name	Type	Required	Description
refundReference	string	TRUE	The unique refund reference provided in the URL.

Response Body

Field Name	Type	Description
requestSuccessful	boolean	Indicates whether the refund status request was successful.
responseMessage	string	A message describing the outcome of the refund status request.
responseCode	string	A code representing the result of the refund status request.
responseBody	object	An object containing detailed refund information.

Refund Details (responseBody)

Field Name	Type	Description
transactionReference	string	The reference for the original transaction associated with the refund.
refundReference	string	The unique reference for the refund.
refundAmount	number	The amount refunded.
refundReason	string	The reason for the refund (e.g., "Order cancelled!").
customerNote	string	An optional note provided by 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

🟢200Get Refund Status

application/json

Body

Example

{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "transactionReference": "000012240124191535300537886000",
        "refundReference": "909090911",
        "refundAmount": 10,
        "refundReason": "Order cancelled!",
        "customerNote": "An optional note",
        "refundType": "PARTIAL_REFUND",
        "refundStatus": "COMPLETED",
        "refundStrategy": "MERCHANT_WALLET",
        "comment": "Transaction refund is in progress.",
        "completedOn": "25/01/2024 01:39:12 AM",
        "createdOn": "25/01/2024 01:35:27 AM"
    }
}

Path Parameters

Response Body

Refund Details (responseBody)

Request

Request samples

Responses

Get Refund Status

Path Parameters#

Response Body#

Refund Details (responseBody)#

Request

Request samples

Responses

Path Parameters

Response Body

Refund Details (responseBody)