Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Initiate Refund

...

Info
titleEndpoint
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.

...

Code Block
languagejs
themeRDark
titleInitiate 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",
		"createdOn": "15/12/2020 09:38:13 AM",
		"completedOn": "15/12/2020 12:20:23 PM",
		"comment": "Refund processed successfully."
    }
}


Field Reference

FieldDescription

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.
refundReasonA note describing reason why this transaction is being refunded.Yes
customerNoteAn optional note which will be serve as narration in credit to customer's bank account.No
refundStatusStatus of the refund. Possible values are IN_PROGRESS, FAILED, COMPLETED.
createdOnThe data/time refund was initiated.
completedOnDate and time refund was completed to customer.


Response Codes

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

Response CodeResponse Message

0

Request is received successfully and will be processed.

R1

Transaction with specified reference does not exist.

R2Refund not permitted for specified transaction.
R3Specified refund amount is above transaction amount.
R4Specified refund amount is below minimum refund amount.
R5Merchant does not have sufficient funds to process refund.