Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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


Endpoint

Endpoint

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

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


Supported Path Variable

Request

FieldDescriptionCompulsory
refundReferenceUnique transaction reference generated by Monnify for each transactionYes

Response

Get 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."
   }
}

Response Codes

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

Response CodeResponse Description

0

Request received. Please check refundStatus to confirm completion. 

R7

No refund has been initiated for supplied refund reference.

  • No labels