This API can be used to get status of an initiated refund.
Endpoint
Endpoint
GET: https://sandbox.monnify.com/api/v1/refunds/{{transactionReference}}
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 | ||
---|---|---|
Field | Description | Compulsory |
transactionReference | Unique transaction reference generated by Monnify for each transaction | Yes |
Response
Get Refund Status Response
{ "requestSuccessful":true, "responseMessage":"success", "responseCode":"0", "responseBody":{ "transactionReference":"MNFY|0111231|123412342", "paymentReference":"J_12312_122", "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." } }
Response Codes
When refund is initiated, the following response codes may be returned.
Response Code | Response Description |
0 | Request received. Please check refundStatus to confirm completion. |
R7 | No refund has been initiated for supplied transaction reference. |