Initiate Refund

Initiate Refund

This API enables you process refund to a customer for a transaction.

Endpoint

GET: https://sandbox.monnify.com/api/v1/transactions/initiate-refund

_{Please note that this endpoint is protected using OAuth2 Token. Visit Authentication section of this document for details on OAuth2 Token.}

Request

Initiate Refund Request

{
    "transactionReference": "tranRef",
	"refundAmount": 1000.56,
	"refundReason": "Order cancelled!"
	"customerNote": "An optional note to be sent to customer",
}

Response

Initiate Refund Response

{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
		"transactionReference": "MNFY|0111231|123412342",
		"transactionAmount": 5000,
		"refundAmount": 1200,
		"refundStatus": "IN_PROGRESS",
		"refundReason": "Order was cancelled",
		"customerNote": "Refund for order J1110",
		"refundType": "FULL_REFUND",
		"createdOn": "15/12/2020 09:38:13 AM",
		"completedOn": "15/12/2020 12:20:23 PM",
		"comment": "Refund processed successfully."
    }
}

Field Reference

Field	Description
transactionReference	Unique identifier for the transaction generated by Monnify.	Yes
refundAmount	Amount to refund. Minimum value is N10, and maximum is total transaction amount. If not specified, total transaction amount will be refunded.	No. Defaults to transactionAmount.
refundReason	A note describing reason why this transaction is being refunded.	Yes
customerNote	An optional note which will be serve as narration in credit to customer's bank account.	No
refundStatus	Status of the refund. Possible values are IN_PROGRESS, FAILED, COMPLETED.
createdOn	The data/time refund was initiated.
completedOn	Date and time refund was completed to customer.
comment	Comment describing status of the refund. If FAILED, comment will contain the reason for the failure.

Response Codes

When refund is initiated, the following response codes may be returned.

Response Code	Response Message
0	Request is received successfully and will be processed.
R1	Transaction with specified reference does not exist.
R2	Refund not permitted for specified transaction.
R3	Specified refund amount is above transaction amount.
R4	Specified refund amount is below minimum refund amount.
R5	Merchant does not have sufficient funds to process refund.