This API can be used to get the status of an initiated refund.
Endpoint
| Info | ||
|---|---|---|
| ||
| Info | ||
This endpoint is protected with OAuth 2.0 Bearer token. To find out more about authorization for Monnify endpoints, check Here |
Endpoint URL: {{base_url}}/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.HTTP Method: GET
| Info |
|---|
The {{base_url}} for test is |
Supported Path Variable
Request | ||
|---|---|---|
Field | Description | Compulsory |
refundReference |
Your unique refund reference supplied in the initiate refund request | Yes |
Get Refund Status Response
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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 Code | Response Description |
0 | Request received. Please check refundStatus to confirm completion. |
R7 | No refund has been initiated for supplied refund reference. |