Versions Compared

Key

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

This API can be used to get status of an initiated refund.

...

Info
titleEndpoint
GET: https://sandbox.monnify.com/api/v1/refunds/{{refundReference}}

Please note that this endpoint is protected by OAuth 2.0 Bearer Token


Supported Path Variable

Request

FieldDescriptionCompulsory
refundReferenceUnique transaction reference generated by Monnify for each transactionYour unique refund reference supplied in the initiate refund requestYes


Response

Code Block
languagejs
themeRDark
titleGet Refund Status Response
{
   "requestSuccessful":true,
   "responseMessage":"success",
   "responseCode":"0",
   "responseBody":{
	  "refundReference": "refundReference",
      "transactionReference":"MNFY|0111231|123412342",
	  "refundReason": "Order was cancelled",
      "customerNote": "Refund-orderJ111",
      "refundAmount":1200,
      "refundStatus":"IN_PROGRESS",
      "refundType":"FULL_REFUND",
      "createdOn":"17/03/2021 3:32:09 AM",
      "completedOn":"17/03/2021 4:32:09 AM",
      "comment":"Refund processed successfully."
   }
}

...