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/{{transactionReferencerefundReference}}

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

...

Request

FieldDescriptionCompulsory
transactionReferencerefundReferenceUnique transaction reference generated by Monnify for each transactionYes

...

Code Block
languagejs
themeRDark
titleGet Refund Status Response
{
   "requestSuccessful":true,
   "responseMessage":"success",
   "responseCode":"0",
   "responseBody":{
    	  "transactionReferencerefundReference": "MNFY|0111231|123412342refundReference",
      "paymentReferencetransactionReference":"J_12312_122MNFY|0111231|123412342",
    	  "transactionAmountrefundReason":5000, "Order      "refundAmount":1200was cancelled",
      "refundStatuscustomerNote":"IN_PROGRESS "Refund-orderJ111",
      "refundReasonrefundAmount":"Order was cancelled"1200,
      "customerNoterefundStatus":"Refund for order J1110IN_PROGRESS",
      "refundType":"FULL_REFUND",
      "createdOn":"15/12/2020 09:38:13 AM2021-04-20 16:21:37.179",
      "completedOn":"15/12/2020 12:20:23 PM2021-04-20 17:21:37.179",
      "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 transaction refund reference.